1083 lines
62 KiB
Ruby
1083 lines
62 KiB
Ruby
|
# Copyright 2015 Google Inc.
|
||
|
|
#
|
||
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
# you may not use this file except in compliance with the License.
|
||
|
|
# You may obtain a copy of the License at
|
||
|
|
#
|
||
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
#
|
||
|
|
# Unless required by applicable law or agreed to in writing, software
|
||
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
# See the License for the specific language governing permissions and
|
||
|
|
# limitations under the License.
|
||
|
|
|
||
|
|
require 'google/apis/core/base_service'
|
||
|
|
require 'google/apis/core/json_representation'
|
||
|
|
require 'google/apis/core/hashable'
|
||
|
|
require 'google/apis/errors'
|
||
|
|
|
||
|
|
module Google
|
||
|
|
module Apis
|
||
|
|
module StorageV1beta1
|
||
|
|
# Cloud Storage JSON API
|
||
|
|
#
|
||
|
|
# Lets you store and retrieve potentially-large, immutable data objects.
|
||
|
|
#
|
||
|
|
# @example
|
||
|
|
# require 'google/apis/storage_v1beta1'
|
||
|
|
#
|
||
|
|
# Storage = Google::Apis::StorageV1beta1 # Alias the module
|
||
|
|
# service = Storage::StorageService.new
|
||
|
|
#
|
||
|
|
# @see https://developers.google.com/storage/docs/json_api/
|
||
|
|
class StorageService < Google::Apis::Core::BaseService
|
||
|
|
# @return [String]
|
||
|
|
# API key. Your API key identifies your project and provides you with API access,
|
||
|
|
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
||
|
|
attr_accessor :key
|
||
|
|
|
||
|
|
# @return [String]
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
attr_accessor :quota_user
|
||
|
|
|
||
|
|
# @return [String]
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
attr_accessor :user_ip
|
||
|
|
|
||
|
|
def initialize
|
||
|
|
super('https://www.googleapis.com/', 'storage/v1beta1/')
|
||
|
|
@batch_path = 'batch'
|
||
|
|
end
|
||
|
|
|
||
|
|
# Deletes the ACL entry for the specified entity on the specified bucket.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] entity
|
||
|
|
# The entity holding the permission. Can be user-userId, user-emailAddress,
|
||
|
|
# group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [NilClass] No result returned for this method
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [void]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def delete_bucket_access_control(bucket, entity, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:delete, 'b/{bucket}/acl/{entity}', options)
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['entity'] = entity unless entity.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Returns the ACL entry for the specified entity on the specified bucket.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] entity
|
||
|
|
# The entity holding the permission. Can be user-userId, user-emailAddress,
|
||
|
|
# group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::BucketAccessControl] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::BucketAccessControl]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def get_bucket_access_control(bucket, entity, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:get, 'b/{bucket}/acl/{entity}', options)
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::BucketAccessControl::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::BucketAccessControl
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['entity'] = entity unless entity.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Creates a new ACL entry on the specified bucket.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [Google::Apis::StorageV1beta1::BucketAccessControl] bucket_access_control_object
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::BucketAccessControl] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::BucketAccessControl]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def insert_bucket_access_control(bucket, bucket_access_control_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:post, 'b/{bucket}/acl', options)
|
||
|
|
command.request_representation = Google::Apis::StorageV1beta1::BucketAccessControl::Representation
|
||
|
|
command.request_object = bucket_access_control_object
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::BucketAccessControl::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::BucketAccessControl
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Retrieves ACL entries on the specified bucket.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::BucketAccessControls] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::BucketAccessControls]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def list_bucket_access_controls(bucket, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:get, 'b/{bucket}/acl', options)
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::BucketAccessControls::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::BucketAccessControls
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Updates an ACL entry on the specified bucket. This method supports patch
|
||
|
|
# semantics.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] entity
|
||
|
|
# The entity holding the permission. Can be user-userId, user-emailAddress,
|
||
|
|
# group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
||
|
|
# @param [Google::Apis::StorageV1beta1::BucketAccessControl] bucket_access_control_object
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::BucketAccessControl] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::BucketAccessControl]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def patch_bucket_access_control(bucket, entity, bucket_access_control_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:patch, 'b/{bucket}/acl/{entity}', options)
|
||
|
|
command.request_representation = Google::Apis::StorageV1beta1::BucketAccessControl::Representation
|
||
|
|
command.request_object = bucket_access_control_object
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::BucketAccessControl::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::BucketAccessControl
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['entity'] = entity unless entity.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Updates an ACL entry on the specified bucket.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] entity
|
||
|
|
# The entity holding the permission. Can be user-userId, user-emailAddress,
|
||
|
|
# group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
||
|
|
# @param [Google::Apis::StorageV1beta1::BucketAccessControl] bucket_access_control_object
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::BucketAccessControl] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::BucketAccessControl]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def update_bucket_access_control(bucket, entity, bucket_access_control_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:put, 'b/{bucket}/acl/{entity}', options)
|
||
|
|
command.request_representation = Google::Apis::StorageV1beta1::BucketAccessControl::Representation
|
||
|
|
command.request_object = bucket_access_control_object
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::BucketAccessControl::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::BucketAccessControl
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['entity'] = entity unless entity.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Deletes an empty bucket.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [NilClass] No result returned for this method
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [void]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def delete_bucket(bucket, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:delete, 'b/{bucket}', options)
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Returns metadata for the specified bucket.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] projection
|
||
|
|
# Set of properties to return. Defaults to no_acl.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::Bucket] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::Bucket]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def get_bucket(bucket, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:get, 'b/{bucket}', options)
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::Bucket::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::Bucket
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.query['projection'] = projection unless projection.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Creates a new bucket.
|
||
|
|
# @param [Google::Apis::StorageV1beta1::Bucket] bucket_object
|
||
|
|
# @param [String] projection
|
||
|
|
# Set of properties to return. Defaults to no_acl, unless the bucket resource
|
||
|
|
# specifies acl or defaultObjectAcl properties, when it defaults to full.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::Bucket] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::Bucket]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def insert_bucket(bucket_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:post, 'b', options)
|
||
|
|
command.request_representation = Google::Apis::StorageV1beta1::Bucket::Representation
|
||
|
|
command.request_object = bucket_object
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::Bucket::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::Bucket
|
||
|
|
command.query['projection'] = projection unless projection.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Retrieves a list of buckets for a given project.
|
||
|
|
# @param [Fixnum] project_id
|
||
|
|
# A valid API project identifier.
|
||
|
|
# @param [Fixnum] max_results
|
||
|
|
# Maximum number of buckets to return.
|
||
|
|
# @param [String] page_token
|
||
|
|
# A previously-returned page token representing part of the larger set of
|
||
|
|
# results to view.
|
||
|
|
# @param [String] projection
|
||
|
|
# Set of properties to return. Defaults to no_acl.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::Buckets] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::Buckets]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def list_buckets(project_id, max_results: nil, page_token: nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:get, 'b', options)
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::Buckets::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::Buckets
|
||
|
|
command.query['max-results'] = max_results unless max_results.nil?
|
||
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
||
|
|
command.query['projectId'] = project_id unless project_id.nil?
|
||
|
|
command.query['projection'] = projection unless projection.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Updates a bucket. This method supports patch semantics.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [Google::Apis::StorageV1beta1::Bucket] bucket_object
|
||
|
|
# @param [String] projection
|
||
|
|
# Set of properties to return. Defaults to full.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::Bucket] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::Bucket]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def patch_bucket(bucket, bucket_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:patch, 'b/{bucket}', options)
|
||
|
|
command.request_representation = Google::Apis::StorageV1beta1::Bucket::Representation
|
||
|
|
command.request_object = bucket_object
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::Bucket::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::Bucket
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.query['projection'] = projection unless projection.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Updates a bucket.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [Google::Apis::StorageV1beta1::Bucket] bucket_object
|
||
|
|
# @param [String] projection
|
||
|
|
# Set of properties to return. Defaults to full.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::Bucket] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::Bucket]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def update_bucket(bucket, bucket_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:put, 'b/{bucket}', options)
|
||
|
|
command.request_representation = Google::Apis::StorageV1beta1::Bucket::Representation
|
||
|
|
command.request_object = bucket_object
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::Bucket::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::Bucket
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.query['projection'] = projection unless projection.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Deletes the ACL entry for the specified entity on the specified object.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] object
|
||
|
|
# Name of the object.
|
||
|
|
# @param [String] entity
|
||
|
|
# The entity holding the permission. Can be user-userId, user-emailAddress,
|
||
|
|
# group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [NilClass] No result returned for this method
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [void]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def delete_object_access_control(bucket, object, entity, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:delete, 'b/{bucket}/o/{object}/acl/{entity}', options)
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['object'] = object unless object.nil?
|
||
|
|
command.params['entity'] = entity unless entity.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Returns the ACL entry for the specified entity on the specified object.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] object
|
||
|
|
# Name of the object.
|
||
|
|
# @param [String] entity
|
||
|
|
# The entity holding the permission. Can be user-userId, user-emailAddress,
|
||
|
|
# group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::ObjectAccessControl] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::ObjectAccessControl]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def get_object_access_control(bucket, object, entity, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:get, 'b/{bucket}/o/{object}/acl/{entity}', options)
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::ObjectAccessControl::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::ObjectAccessControl
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['object'] = object unless object.nil?
|
||
|
|
command.params['entity'] = entity unless entity.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Creates a new ACL entry on the specified object.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] object
|
||
|
|
# Name of the object.
|
||
|
|
# @param [Google::Apis::StorageV1beta1::ObjectAccessControl] object_access_control_object
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::ObjectAccessControl] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::ObjectAccessControl]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def insert_object_access_control(bucket, object, object_access_control_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:post, 'b/{bucket}/o/{object}/acl', options)
|
||
|
|
command.request_representation = Google::Apis::StorageV1beta1::ObjectAccessControl::Representation
|
||
|
|
command.request_object = object_access_control_object
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::ObjectAccessControl::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::ObjectAccessControl
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['object'] = object unless object.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Retrieves ACL entries on the specified object.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] object
|
||
|
|
# Name of the object.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::ObjectAccessControls] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::ObjectAccessControls]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def list_object_access_controls(bucket, object, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:get, 'b/{bucket}/o/{object}/acl', options)
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::ObjectAccessControls::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::ObjectAccessControls
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['object'] = object unless object.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Updates an ACL entry on the specified object. This method supports patch
|
||
|
|
# semantics.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] object
|
||
|
|
# Name of the object.
|
||
|
|
# @param [String] entity
|
||
|
|
# The entity holding the permission. Can be user-userId, user-emailAddress,
|
||
|
|
# group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
||
|
|
# @param [Google::Apis::StorageV1beta1::ObjectAccessControl] object_access_control_object
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::ObjectAccessControl] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::ObjectAccessControl]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def patch_object_access_control(bucket, object, entity, object_access_control_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:patch, 'b/{bucket}/o/{object}/acl/{entity}', options)
|
||
|
|
command.request_representation = Google::Apis::StorageV1beta1::ObjectAccessControl::Representation
|
||
|
|
command.request_object = object_access_control_object
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::ObjectAccessControl::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::ObjectAccessControl
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['object'] = object unless object.nil?
|
||
|
|
command.params['entity'] = entity unless entity.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Updates an ACL entry on the specified object.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of a bucket.
|
||
|
|
# @param [String] object
|
||
|
|
# Name of the object.
|
||
|
|
# @param [String] entity
|
||
|
|
# The entity holding the permission. Can be user-userId, user-emailAddress,
|
||
|
|
# group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
||
|
|
# @param [Google::Apis::StorageV1beta1::ObjectAccessControl] object_access_control_object
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::ObjectAccessControl] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::ObjectAccessControl]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def update_object_access_control(bucket, object, entity, object_access_control_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:put, 'b/{bucket}/o/{object}/acl/{entity}', options)
|
||
|
|
command.request_representation = Google::Apis::StorageV1beta1::ObjectAccessControl::Representation
|
||
|
|
command.request_object = object_access_control_object
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::ObjectAccessControl::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::ObjectAccessControl
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['object'] = object unless object.nil?
|
||
|
|
command.params['entity'] = entity unless entity.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Deletes data blobs and associated metadata.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of the bucket in which the object resides.
|
||
|
|
# @param [String] object
|
||
|
|
# Name of the object.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [NilClass] No result returned for this method
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [void]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def delete_object(bucket, object, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:delete, 'b/{bucket}/o/{object}', options)
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['object'] = object unless object.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Retrieves objects or their associated metadata.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of the bucket in which the object resides.
|
||
|
|
# @param [String] object
|
||
|
|
# Name of the object.
|
||
|
|
# @param [String] projection
|
||
|
|
# Set of properties to return. Defaults to no_acl.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [IO, String] download_dest
|
||
|
|
# IO stream or filename to receive content download
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::Object] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::Object]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def get_object(bucket, object, projection: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
|
||
|
|
if download_dest.nil?
|
||
|
|
command = make_simple_command(:get, 'b/{bucket}/o/{object}', options)
|
||
|
|
else
|
||
|
|
command = make_download_command(:get, 'b/{bucket}/o/{object}', options)
|
||
|
|
command.download_dest = download_dest
|
||
|
|
end
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::Object::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::Object
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['object'] = object unless object.nil?
|
||
|
|
command.query['projection'] = projection unless projection.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Stores new data blobs and associated metadata.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of the bucket in which to store the new object. Overrides the provided
|
||
|
|
# object metadata's bucket value, if any.
|
||
|
|
# @param [Google::Apis::StorageV1beta1::Object] object_object
|
||
|
|
# @param [String] name
|
||
|
|
# Name of the object. Required when the object metadata is not otherwise
|
||
|
|
# provided. Overrides the object metadata's name value, if any.
|
||
|
|
# @param [String] projection
|
||
|
|
# Set of properties to return. Defaults to no_acl, unless the object resource
|
||
|
|
# specifies the acl property, when it defaults to full.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [IO, String] upload_source
|
||
|
|
# IO stream or filename containing content to upload
|
||
|
|
# @param [String] content_type
|
||
|
|
# Content type of the uploaded content.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::Object] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::Object]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def insert_object(bucket, object_object = nil, name: nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
||
|
|
if upload_source.nil?
|
||
|
|
command = make_simple_command(:post, 'b/{bucket}/o', options)
|
||
|
|
else
|
||
|
|
command = make_upload_command(:post, 'b/{bucket}/o', options)
|
||
|
|
command.upload_source = upload_source
|
||
|
|
command.upload_content_type = content_type
|
||
|
|
end
|
||
|
|
command.request_representation = Google::Apis::StorageV1beta1::Object::Representation
|
||
|
|
command.request_object = object_object
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::Object::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::Object
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.query['name'] = name unless name.nil?
|
||
|
|
command.query['projection'] = projection unless projection.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Retrieves a list of objects matching the criteria.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of the bucket in which to look for objects.
|
||
|
|
# @param [String] delimiter
|
||
|
|
# Returns results in a directory-like mode. items will contain only objects
|
||
|
|
# whose names, aside from the prefix, do not contain delimiter. Objects whose
|
||
|
|
# names, aside from the prefix, contain delimiter will have their name,
|
||
|
|
# truncated after the delimiter, returned in prefixes. Duplicate prefixes are
|
||
|
|
# omitted.
|
||
|
|
# @param [Fixnum] max_results
|
||
|
|
# Maximum number of items plus prefixes to return. As duplicate prefixes are
|
||
|
|
# omitted, fewer total results may be returned than requested.
|
||
|
|
# @param [String] page_token
|
||
|
|
# A previously-returned page token representing part of the larger set of
|
||
|
|
# results to view.
|
||
|
|
# @param [String] prefix
|
||
|
|
# Filter results to objects whose names begin with this prefix.
|
||
|
|
# @param [String] projection
|
||
|
|
# Set of properties to return. Defaults to no_acl.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::Objects] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::Objects]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def list_objects(bucket, delimiter: nil, max_results: nil, page_token: nil, prefix: nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:get, 'b/{bucket}/o', options)
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::Objects::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::Objects
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.query['delimiter'] = delimiter unless delimiter.nil?
|
||
|
|
command.query['max-results'] = max_results unless max_results.nil?
|
||
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
||
|
|
command.query['prefix'] = prefix unless prefix.nil?
|
||
|
|
command.query['projection'] = projection unless projection.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Updates a data blob's associated metadata. This method supports patch
|
||
|
|
# semantics.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of the bucket in which the object resides.
|
||
|
|
# @param [String] object
|
||
|
|
# Name of the object.
|
||
|
|
# @param [Google::Apis::StorageV1beta1::Object] object_object
|
||
|
|
# @param [String] projection
|
||
|
|
# Set of properties to return. Defaults to full.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::Object] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::Object]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def patch_object(bucket, object, object_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||
|
|
command = make_simple_command(:patch, 'b/{bucket}/o/{object}', options)
|
||
|
|
command.request_representation = Google::Apis::StorageV1beta1::Object::Representation
|
||
|
|
command.request_object = object_object
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::Object::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::Object
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['object'] = object unless object.nil?
|
||
|
|
command.query['projection'] = projection unless projection.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
# Updates a data blob's associated metadata.
|
||
|
|
# @param [String] bucket
|
||
|
|
# Name of the bucket in which the object resides.
|
||
|
|
# @param [String] object
|
||
|
|
# Name of the object.
|
||
|
|
# @param [Google::Apis::StorageV1beta1::Object] object_object
|
||
|
|
# @param [String] projection
|
||
|
|
# Set of properties to return. Defaults to full.
|
||
|
|
# @param [String] fields
|
||
|
|
# Selector specifying which fields to include in a partial response.
|
||
|
|
# @param [String] quota_user
|
||
|
|
# Available to use for quota purposes for server-side applications. Can be any
|
||
|
|
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||
|
|
# Overrides userIp if both are provided.
|
||
|
|
# @param [String] user_ip
|
||
|
|
# IP address of the site where the request originates. Use this if you want to
|
||
|
|
# enforce per-user limits.
|
||
|
|
# @param [IO, String] download_dest
|
||
|
|
# IO stream or filename to receive content download
|
||
|
|
# @param [Google::Apis::RequestOptions] options
|
||
|
|
# Request-specific options
|
||
|
|
#
|
||
|
|
# @yield [result, err] Result & error if block supplied
|
||
|
|
# @yieldparam result [Google::Apis::StorageV1beta1::Object] parsed result object
|
||
|
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
|
#
|
||
|
|
# @return [Google::Apis::StorageV1beta1::Object]
|
||
|
|
#
|
||
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||
|
|
def update_object(bucket, object, object_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
|
||
|
|
if download_dest.nil?
|
||
|
|
command = make_simple_command(:put, 'b/{bucket}/o/{object}', options)
|
||
|
|
else
|
||
|
|
command = make_download_command(:put, 'b/{bucket}/o/{object}', options)
|
||
|
|
command.download_dest = download_dest
|
||
|
|
end
|
||
|
|
command.request_representation = Google::Apis::StorageV1beta1::Object::Representation
|
||
|
|
command.request_object = object_object
|
||
|
|
command.response_representation = Google::Apis::StorageV1beta1::Object::Representation
|
||
|
|
command.response_class = Google::Apis::StorageV1beta1::Object
|
||
|
|
command.params['bucket'] = bucket unless bucket.nil?
|
||
|
|
command.params['object'] = object unless object.nil?
|
||
|
|
command.query['projection'] = projection unless projection.nil?
|
||
|
|
command.query['fields'] = fields unless fields.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
execute_or_queue_command(command, &block)
|
||
|
|
end
|
||
|
|
|
||
|
|
protected
|
||
|
|
|
||
|
|
def apply_command_defaults(command)
|
||
|
|
command.query['key'] = key unless key.nil?
|
||
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
|
command.query['userIp'] = user_ip unless user_ip.nil?
|
||
|
|
end
|
||
|
|
end
|
||
|
|
end
|
||
|
|
end
|
||
|
|
end
|