Class: Google::Apis::StorageV1::StorageService

Inherits:

Core::BaseService

Object
Core::BaseService
Google::Apis::StorageV1::StorageService

show all

Defined in:: lib/google/apis/storage_v1/service.rb

Overview

Cloud Storage JSON API

Stores and retrieves potentially large, immutable data objects.

Examples:

require 'google/apis/storage_v1'

Storage = Google::Apis::StorageV1 # Alias the module
service = Storage::StorageService.new

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =

"https://storage.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

#key ⇒ String
API key.
#quota_user ⇒ String
An opaque string that represents a user for quota purposes.
#user_ip ⇒ String
Deprecated.

Instance Method Summary collapse

#advance_relocate_bucket_operation(bucket, operation_id, advance_relocate_bucket_operation_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Starts asynchronous advancement of the relocate bucket operation in the case of required write downtime, to allow it to lock the bucket at the source location, and proceed with the bucket location swap.
#bulk_restore_objects(bucket, bulk_restore_objects_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation
Initiates a long-running bulk restore operation on the specified bucket.
#cancel_bucket_operation(bucket, operation_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Starts asynchronous cancellation on a long-running operation.
#compose_object(destination_bucket, destination_object, compose_request_object = nil, destination_predefined_acl: nil, drop_context_groups: nil, if_generation_match: nil, if_metageneration_match: nil, kms_key_name: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Object
Concatenates a list of existing objects into a new object in the same bucket.
#copy_object(source_bucket, source_object, destination_bucket, destination_object, object_object = nil, destination_kms_key_name: nil, destination_predefined_acl: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, projection: nil, source_generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Object
Copies a source object to a destination object.
#create_project_hmac_key(project_id, service_account_email, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::HmacKey
Creates a new HMAC key for the specified service account.
#delete_bucket(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes an empty bucket.
#delete_bucket_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Permanently deletes the ACL entry for the specified entity on the specified bucket.
#delete_default_object_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Permanently deletes the default object ACL entry for the specified entity on the specified bucket.
#delete_folder(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Permanently deletes a folder.
#delete_folder_recursive(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation
Deletes a folder recursively.
#delete_managed_folder(bucket, managed_folder, allow_non_empty: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Permanently deletes a managed folder.
#delete_notification(bucket, notification, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Permanently deletes a notification subscription.
#delete_object(bucket, object, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes an object and its metadata.
#delete_object_access_control(bucket, object, entity, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Permanently deletes the ACL entry for the specified entity on the specified object.
#delete_project_hmac_key(project_id, access_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes an HMAC key.
#disable_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::AnywhereCache
Disables an Anywhere Cache instance.
#get_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::AnywhereCache
Returns the metadata of an Anywhere Cache instance.
#get_bucket(bucket, generation: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, soft_deleted: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Bucket
Returns metadata for the specified bucket.
#get_bucket_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::BucketAccessControl
Returns the ACL entry for the specified entity on the specified bucket.
#get_bucket_iam_policy(bucket, options_requested_policy_version: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Policy
Returns an IAM policy for the specified bucket.
#get_bucket_operation(bucket, operation_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
#get_bucket_storage_layout(bucket, prefix: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::BucketStorageLayout
Returns the storage layout configuration for the specified bucket.
#get_default_object_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl
Returns the default object ACL entry for the specified entity on the specified bucket.
#get_folder(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Folder
Returns metadata for the specified folder.
#get_managed_folder(bucket, managed_folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ManagedFolder
Returns metadata of the specified managed folder.
#get_managed_folder_iam_policy(bucket, managed_folder, options_requested_policy_version: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Policy
Returns an IAM policy for the specified managed folder.
#get_notification(bucket, notification, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Notification
View a notification configuration.
#get_object(bucket, object, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, restore_token: nil, soft_deleted: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Object
Retrieves an object or its metadata.
#get_object_access_control(bucket, object, entity, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl
Returns the ACL entry for the specified entity on the specified object.
#get_object_iam_policy(bucket, object, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Policy
Returns an IAM policy for the specified object.
#get_project_hmac_key(project_id, access_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::HmacKeyMetadata
Retrieves an HMAC key's metadata.
#get_project_service_account(project_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ServiceAccount
Get the email address of this project's Google Cloud Storage service account.
#initialize ⇒ StorageService constructor
A new instance of StorageService.
#insert_anywhere_cach(bucket, anywhere_cache_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation
Creates an Anywhere Cache instance.
#insert_bucket(project, bucket_object = nil, enable_object_retention: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Bucket
Creates a new bucket.
#insert_bucket_access_control(bucket, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::BucketAccessControl
Creates a new ACL entry on the specified bucket.
#insert_default_object_access_control(bucket, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl
Creates a new default object ACL entry on the specified bucket.
#insert_folder(bucket, folder_object = nil, recursive: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Folder
Creates a new folder.
#insert_managed_folder(bucket, managed_folder_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ManagedFolder
Creates a new managed folder.
#insert_notification(bucket, notification_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Notification
Creates a notification subscription for a given bucket.
#insert_object(bucket, object_object = nil, content_encoding: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, kms_key_name: nil, name: nil, predefined_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Object
Stores a new object and metadata.
#insert_object_access_control(bucket, object, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl
Creates a new ACL entry on the specified object.
#list_anywhere_caches(bucket, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::AnywhereCaches
Returns a list of Anywhere Cache instances of the bucket matching the criteria.
#list_bucket_access_controls(bucket, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::BucketAccessControls
Retrieves ACL entries on the specified bucket.
#list_bucket_operations(bucket, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request.
#list_buckets(project, max_results: nil, page_token: nil, prefix: nil, projection: nil, return_partial_success: nil, soft_deleted: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Buckets
Retrieves a list of buckets for a given project.
#list_default_object_access_controls(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControls
Retrieves default object ACL entries on the specified bucket.
#list_folders(bucket, delimiter: nil, end_offset: nil, page_size: nil, page_token: nil, prefix: nil, start_offset: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Folders
Retrieves a list of folders matching the criteria.
#list_managed_folders(bucket, page_size: nil, page_token: nil, prefix: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ManagedFolders
Lists managed folders in the given bucket.
#list_notifications(bucket, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Notifications
Retrieves a list of notification subscriptions for a given bucket.
#list_object_access_controls(bucket, object, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControls
Retrieves ACL entries on the specified object.
#list_objects(bucket, delimiter: nil, end_offset: nil, filter: nil, include_folders_as_prefixes: nil, include_trailing_delimiter: nil, match_glob: nil, max_results: nil, page_token: nil, prefix: nil, projection: nil, soft_deleted: nil, start_offset: nil, user_project: nil, versions: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Objects
Retrieves a list of objects matching the criteria.
#list_project_hmac_keys(project_id, max_results: nil, page_token: nil, service_account_email: nil, show_deleted_keys: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::HmacKeysMetadata
Retrieves a list of HMAC keys matching the criteria.
#lock_bucket_retention_policy(bucket, if_metageneration_match, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Bucket
Locks retention policy on a bucket.
#move_object(bucket, source_object, destination_object, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Object
Moves the source object to the destination object in the same bucket.
#patch_bucket(bucket, bucket_object = nil, if_metageneration_match: nil, if_metageneration_not_match: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Bucket
Patches a bucket.
#patch_bucket_access_control(bucket, entity, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::BucketAccessControl
Patches an ACL entry on the specified bucket.
#patch_default_object_access_control(bucket, entity, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl
Patches a default object ACL entry on the specified bucket.
#patch_object(bucket, object, object_object = nil, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, override_unlocked_retention: nil, predefined_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Object
Patches an object's metadata.
#patch_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl
Patches an ACL entry on the specified object.
#pause_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::AnywhereCache
Pauses an Anywhere Cache instance.
#relocate_bucket(bucket, relocate_bucket_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation
Initiates a long-running Relocate Bucket operation on the specified bucket.
#rename_folder(bucket, source_folder, destination_folder, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation
Renames a source folder to a destination folder.
#restore_bucket(bucket, generation, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Bucket
Restores a soft-deleted bucket.
#restore_object(bucket, object, generation, copy_source_acl: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, restore_token: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Object
Restores a soft-deleted object.
#resume_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::AnywhereCache
Resumes a paused or disabled Anywhere Cache instance.
#rewrite_object(source_bucket, source_object, destination_bucket, destination_object, object_object = nil, destination_kms_key_name: nil, destination_predefined_acl: nil, drop_context_groups: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, max_bytes_rewritten_per_call: nil, projection: nil, rewrite_token: nil, source_generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::RewriteResponse
Rewrites a source object to a destination object.
#set_bucket_iam_policy(bucket, policy_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Policy
Updates an IAM policy for the specified bucket.
#set_managed_folder_iam_policy(bucket, managed_folder, policy_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Policy
Updates an IAM policy for the specified managed folder.
#set_object_iam_policy(bucket, object, policy_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Policy
Updates an IAM policy for the specified object.
#stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Stop watching resources through this channel.
#test_bucket_iam_permissions(bucket, permissions, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::TestIamPermissionsResponse
Tests a set of permissions on the given bucket to see which, if any, are held by the caller.
#test_managed_folder_iam_permissions(bucket, managed_folder, permissions, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::TestIamPermissionsResponse
Tests a set of permissions on the given managed folder to see which, if any, are held by the caller.
#test_object_iam_permissions(bucket, object, permissions, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::TestIamPermissionsResponse
Tests a set of permissions on the given object to see which, if any, are held by the caller.
#update_anywhere_cach(bucket, anywhere_cache_id, anywhere_cache_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation
Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.
#update_bucket(bucket, bucket_object = nil, if_metageneration_match: nil, if_metageneration_not_match: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Bucket
Updates a bucket.
#update_bucket_access_control(bucket, entity, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::BucketAccessControl
Updates an ACL entry on the specified bucket.
#update_default_object_access_control(bucket, entity, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl
Updates a default object ACL entry on the specified bucket.
#update_object(bucket, object, object_object = nil, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, override_unlocked_retention: nil, predefined_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Object
Updates an object's metadata.
#update_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl
Updates an ACL entry on the specified object.
#update_project_hmac_key(project_id, access_id, hmac_key_metadata_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::HmacKeyMetadata
Updates the state of an HMAC key.
#watch_all_objects(bucket, channel_object = nil, delimiter: nil, end_offset: nil, include_trailing_delimiter: nil, max_results: nil, page_token: nil, prefix: nil, projection: nil, start_offset: nil, user_project: nil, versions: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Channel
Watch for changes on all objects in a bucket.

Constructor Details

#initialize ⇒ `StorageService`

Returns a new instance of StorageService.

# File 'lib/google/apis/storage_v1/service.rb', line 51

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, 'storage/v1/',
        client_name: 'google-apis-storage_v1',
        client_version: Google::Apis::StorageV1::GEM_VERSION)
  @batch_path = 'batch/storage/v1'
end

Instance Attribute Details

#key ⇒ `String`

Returns 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.

Returns:

(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.



40
41
42

# File 'lib/google/apis/storage_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ `String`

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

(String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



45
46
47

# File 'lib/google/apis/storage_v1/service.rb', line 45

def quota_user
  @quota_user
end

#user_ip ⇒ `String`

Returns Deprecated. Please use quotaUser instead.

Returns:

(String) —
Deprecated. Please use quotaUser instead.



49
50
51

# File 'lib/google/apis/storage_v1/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#advance_relocate_bucket_operation(bucket, operation_id, advance_relocate_bucket_operation_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Starts asynchronous advancement of the relocate bucket operation in the case of required write downtime, to allow it to lock the bucket at the source location, and proceed with the bucket location swap. The server makes a best effort to advance the relocate bucket operation, but success is not guaranteed.

Parameters:

bucket (String) —
Name of the bucket to advance the relocate for.
operation_id (String) —
ID of the operation resource.
advance_relocate_bucket_operation_request_object (Google::Apis::StorageV1::AdvanceRelocateBucketOperationRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3710

def advance_relocate_bucket_operation(bucket, operation_id, advance_relocate_bucket_operation_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/operations/{operationId}/advanceRelocateBucket', options)
  command.request_representation = Google::Apis::StorageV1::AdvanceRelocateBucketOperationRequest::Representation
  command.request_object = advance_relocate_bucket_operation_request_object
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['operationId'] = operation_id unless operation_id.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

#bulk_restore_objects(bucket, bulk_restore_objects_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

Initiates a long-running bulk restore operation on the specified bucket.

Parameters:

bucket (String) —
Name of the bucket in which the object resides.
bulk_restore_objects_request_object (Google::Apis::StorageV1::BulkRestoreObjectsRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2482

def bulk_restore_objects(bucket, bulk_restore_objects_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/o/bulkRestore', options)
  command.request_representation = Google::Apis::StorageV1::BulkRestoreObjectsRequest::Representation
  command.request_object = bulk_restore_objects_request_object
  command.response_representation = Google::Apis::StorageV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::StorageV1::GoogleLongrunningOperation
  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

#cancel_bucket_operation(bucket, operation_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.

Parameters:

bucket (String) —
The parent bucket of the operation resource.
operation_id (String) —
The ID of the operation resource.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3747

def cancel_bucket_operation(bucket, operation_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/operations/{operationId}/cancel', options)
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['operationId'] = operation_id unless operation_id.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

#compose_object(destination_bucket, destination_object, compose_request_object = nil, destination_predefined_acl: nil, drop_context_groups: nil, if_generation_match: nil, if_metageneration_match: nil, kms_key_name: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Object`

Concatenates a list of existing objects into a new object in the same bucket.

Parameters:

destination_bucket (String) —
Name of the bucket containing the source objects. The destination object is stored in this bucket.
destination_object (String) —
Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
compose_request_object (Google::Apis::StorageV1::ComposeRequest) (defaults to: nil)
destination_predefined_acl (String) (defaults to: nil) —
Apply a predefined set of access controls to the destination object.
drop_context_groups (Array<String>, String) (defaults to: nil) —
Specifies which groups of Object Contexts from the source object(s) should be dropped from the destination object.
if_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current metageneration matches the given value.
kms_key_name (String) (defaults to: nil) —
Resource name of the Cloud KMS key, of the form projects/my-project/locations/ global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Object) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Object)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2541

def compose_object(destination_bucket, destination_object, compose_request_object = nil, destination_predefined_acl: nil, drop_context_groups: nil, if_generation_match: nil, if_metageneration_match: nil, kms_key_name: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{destinationBucket}/o/{destinationObject}/compose', options)
  command.request_representation = Google::Apis::StorageV1::ComposeRequest::Representation
  command.request_object = compose_request_object
  command.response_representation = Google::Apis::StorageV1::Object::Representation
  command.response_class = Google::Apis::StorageV1::Object
  command.params['destinationBucket'] = destination_bucket unless destination_bucket.nil?
  command.params['destinationObject'] = destination_object unless destination_object.nil?
  command.query['destinationPredefinedAcl'] = destination_predefined_acl unless destination_predefined_acl.nil?
  command.query['dropContextGroups'] = drop_context_groups unless drop_context_groups.nil?
  command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['kmsKeyName'] = kms_key_name unless kms_key_name.nil?
  command.query['userProject'] = user_project unless user_project.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

#copy_object(source_bucket, source_object, destination_bucket, destination_object, object_object = nil, destination_kms_key_name: nil, destination_predefined_acl: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, projection: nil, source_generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Object`

Copies a source object to a destination object. Optionally overrides metadata.

Parameters:

source_bucket (String) —
Name of the bucket in which to find the source object.
source_object (String) —
Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
destination_bucket (String) —
Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
destination_object (String) —
Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.
object_object (Google::Apis::StorageV1::Object) (defaults to: nil)
destination_kms_key_name (String) (defaults to: nil) —
Resource name of the Cloud KMS key, of the form projects/my-project/locations/ global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
destination_predefined_acl (String) (defaults to: nil) —
Apply a predefined set of access controls to the destination object.
if_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
if_generation_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the destination object's current metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
if_source_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current generation matches the given value.
if_source_generation_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current generation does not match the given value.
if_source_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current metageneration matches the given value.
if_source_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current metageneration does not match the given value.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
source_generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of the source object (as opposed to the latest version, the default).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Object) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Object)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2637

def copy_object(source_bucket, source_object, destination_bucket, destination_object, object_object = nil, destination_kms_key_name: nil, destination_predefined_acl: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, projection: nil, source_generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}', options)
  command.request_representation = Google::Apis::StorageV1::Object::Representation
  command.request_object = object_object
  command.response_representation = Google::Apis::StorageV1::Object::Representation
  command.response_class = Google::Apis::StorageV1::Object
  command.params['sourceBucket'] = source_bucket unless source_bucket.nil?
  command.params['sourceObject'] = source_object unless source_object.nil?
  command.params['destinationBucket'] = destination_bucket unless destination_bucket.nil?
  command.params['destinationObject'] = destination_object unless destination_object.nil?
  command.query['destinationKmsKeyName'] = destination_kms_key_name unless destination_kms_key_name.nil?
  command.query['destinationPredefinedAcl'] = destination_predefined_acl unless destination_predefined_acl.nil?
  command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil?
  command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['ifSourceGenerationMatch'] = if_source_generation_match unless if_source_generation_match.nil?
  command.query['ifSourceGenerationNotMatch'] = if_source_generation_not_match unless if_source_generation_not_match.nil?
  command.query['ifSourceMetagenerationMatch'] = if_source_metageneration_match unless if_source_metageneration_match.nil?
  command.query['ifSourceMetagenerationNotMatch'] = if_source_metageneration_not_match unless if_source_metageneration_not_match.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['sourceGeneration'] = source_generation unless source_generation.nil?
  command.query['userProject'] = user_project unless user_project.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

#create_project_hmac_key(project_id, service_account_email, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::HmacKey`

Creates a new HMAC key for the specified service account.

Parameters:

project_id (String) —
Project ID owning the service account.
service_account_email (String) —
Email address of the service account.
user_project (String) (defaults to: nil) —
The project to be billed for this request.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::HmacKey) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::HmacKey)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3865

def create_project_hmac_key(project_id, service_account_email, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'projects/{projectId}/hmacKeys', options)
  command.response_representation = Google::Apis::StorageV1::HmacKey::Representation
  command.response_class = Google::Apis::StorageV1::HmacKey
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['serviceAccountEmail'] = service_account_email unless service_account_email.nil?
  command.query['userProject'] = user_project unless user_project.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

#delete_bucket(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an empty bucket. Deletions are permanent unless soft delete is enabled on the bucket.

Parameters:

bucket (String) —
Name of a bucket.
if_metageneration_match (Fixnum) (defaults to: nil) —
If set, only deletes the bucket if its metageneration matches this value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
If set, only deletes the bucket if its metageneration does not match this value.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 587

def delete_bucket(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, 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['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['userProject'] = user_project unless user_project.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

#delete_bucket_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Permanently deletes the ACL entry for the specified entity on the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
entity (String) —
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 345

def delete_bucket_access_control(bucket, entity, user_project: nil, 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['userProject'] = user_project unless user_project.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

#delete_default_object_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Permanently deletes the default object ACL entry for the specified entity on the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
entity (String) —
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1215

def delete_default_object_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'b/{bucket}/defaultObjectAcl/{entity}', options)
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['entity'] = entity unless entity.nil?
  command.query['userProject'] = user_project unless user_project.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

#delete_folder(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Permanently deletes a folder. Only applicable to buckets with hierarchical namespace enabled.

Parameters:

bucket (String) —
Name of the bucket in which the folder resides.
folder (String) —
Name of a folder.
if_metageneration_match (Fixnum) (defaults to: nil) —
If set, only deletes the folder if its metageneration matches this value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
If set, only deletes the folder if its metageneration does not match this value.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1466

def delete_folder(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'b/{bucket}/folders/{folder}', options)
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['folder'] = folder unless folder.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.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

#delete_folder_recursive(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

Deletes a folder recursively. Only applicable to buckets with hierarchical namespace enabled.

Parameters:

bucket (String) —
Name of the bucket in which the folder resides.
folder (String) —
Name of a folder.
if_metageneration_match (Fixnum) (defaults to: nil) —
If set, only deletes the folder if its metageneration matches this value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
If set, only deletes the folder if its metageneration does not match this value.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1508

def delete_folder_recursive(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/folders/{folder}/deleteRecursive', options)
  command.response_representation = Google::Apis::StorageV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::StorageV1::GoogleLongrunningOperation
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['folder'] = folder unless folder.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.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

#delete_managed_folder(bucket, managed_folder, allow_non_empty: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Permanently deletes a managed folder.

Parameters:

bucket (String) —
Name of the bucket containing the managed folder.
managed_folder (String) —
The managed folder name/path.
allow_non_empty (Boolean) (defaults to: nil) —
Allows the deletion of a managed folder even if it is not empty. A managed folder is empty if there are no objects or managed folders that it applies to. Callers must have storage.managedFolders.setIamPolicy permission.
if_metageneration_match (Fixnum) (defaults to: nil) —
If set, only deletes the managed folder if its metageneration matches this value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
If set, only deletes the managed folder if its metageneration does not match this value.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1749

def delete_managed_folder(bucket, managed_folder, allow_non_empty: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'b/{bucket}/managedFolders/{managedFolder}', options)
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['managedFolder'] = managed_folder unless managed_folder.nil?
  command.query['allowNonEmpty'] = allow_non_empty unless allow_non_empty.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.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

#delete_notification(bucket, notification, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Permanently deletes a notification subscription.

Parameters:

bucket (String) —
The parent bucket of the notification.
notification (String) —
ID of the notification to delete.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2040

def delete_notification(bucket, notification, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'b/{bucket}/notificationConfigs/{notification}', options)
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['notification'] = notification unless notification.nil?
  command.query['userProject'] = user_project unless user_project.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

#delete_object(bucket, object, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.

Parameters:

bucket (String) —
Name of the bucket in which the object resides.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
generation (Fixnum) (defaults to: nil) —
If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).
if_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
if_generation_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current metageneration does not match the given value.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2713

def delete_object(bucket, object, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, 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['generation'] = generation unless generation.nil?
  command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil?
  command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['userProject'] = user_project unless user_project.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

#delete_object_access_control(bucket, object, entity, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Permanently deletes the ACL entry for the specified entity on the specified object.

Parameters:

bucket (String) —
Name of a bucket.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
entity (String) —
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of this object (as opposed to the latest version, the default).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2200

def delete_object_access_control(bucket, object, entity, generation: nil, user_project: nil, 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['generation'] = generation unless generation.nil?
  command.query['userProject'] = user_project unless user_project.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

#delete_project_hmac_key(project_id, access_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an HMAC key.

Parameters:

project_id (String) —
Project ID owning the requested key
access_id (String) —
Name of the HMAC key to be deleted.
user_project (String) (defaults to: nil) —
The project to be billed for this request.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3904

def delete_project_hmac_key(project_id, access_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, 'projects/{projectId}/hmacKeys/{accessId}', options)
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['accessId'] = access_id unless access_id.nil?
  command.query['userProject'] = user_project unless user_project.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

#disable_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::AnywhereCache`

Disables an Anywhere Cache instance.

Parameters:

bucket (String) —
Name of the parent bucket.
anywhere_cache_id (String) —
The ID of requested Anywhere Cache instance.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::AnywhereCache) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::AnywhereCache)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 82

def disable_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/anywhereCaches/{anywhereCacheId}/disable', options)
  command.response_representation = Google::Apis::StorageV1::AnywhereCache::Representation
  command.response_class = Google::Apis::StorageV1::AnywhereCache
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['anywhereCacheId'] = anywhere_cache_id unless anywhere_cache_id.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

#get_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::AnywhereCache`

Returns the metadata of an Anywhere Cache instance.

Parameters:

bucket (String) —
Name of the parent bucket.
anywhere_cache_id (String) —
The ID of requested Anywhere Cache instance.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::AnywhereCache) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::AnywhereCache)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 118

def get_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/anywhereCaches/{anywhereCacheId}', options)
  command.response_representation = Google::Apis::StorageV1::AnywhereCache::Representation
  command.response_class = Google::Apis::StorageV1::AnywhereCache
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['anywhereCacheId'] = anywhere_cache_id unless anywhere_cache_id.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

#get_bucket(bucket, generation: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, soft_deleted: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Bucket`

Returns metadata for the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
generation (Fixnum) (defaults to: nil) —
If present, specifies the generation of the bucket. This is required if softDeleted is true.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to noAcl.
soft_deleted (Boolean) (defaults to: nil) —
If true, return the soft-deleted version of this bucket. The default is false. For more information, see Soft Delete.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Bucket) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Bucket)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 638

def get_bucket(bucket, generation: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, soft_deleted: nil, user_project: 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::StorageV1::Bucket::Representation
  command.response_class = Google::Apis::StorageV1::Bucket
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['softDeleted'] = soft_deleted unless soft_deleted.nil?
  command.query['userProject'] = user_project unless user_project.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

#get_bucket_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::BucketAccessControl`

Returns the ACL entry for the specified entity on the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
entity (String) —
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::BucketAccessControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::BucketAccessControl)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 383

def get_bucket_access_control(bucket, entity, user_project: nil, 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::StorageV1::BucketAccessControl::Representation
  command.response_class = Google::Apis::StorageV1::BucketAccessControl
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['entity'] = entity unless entity.nil?
  command.query['userProject'] = user_project unless user_project.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

#get_bucket_iam_policy(bucket, options_requested_policy_version: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Policy`

Returns an IAM policy for the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
options_requested_policy_version (Fixnum) (defaults to: nil) —
The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Policy) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Policy)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 683

def get_bucket_iam_policy(bucket, options_requested_policy_version: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/iam', options)
  command.response_representation = Google::Apis::StorageV1::Policy::Representation
  command.response_class = Google::Apis::StorageV1::Policy
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['optionsRequestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['userProject'] = user_project unless user_project.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

#get_bucket_operation(bucket, operation_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

Gets the latest state of a long-running operation.

Parameters:

bucket (String) —
The parent bucket of the operation resource.
operation_id (String) —
The ID of the operation resource.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3781

def get_bucket_operation(bucket, operation_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/operations/{operationId}', options)
  command.response_representation = Google::Apis::StorageV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::StorageV1::GoogleLongrunningOperation
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['operationId'] = operation_id unless operation_id.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

#get_bucket_storage_layout(bucket, prefix: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::BucketStorageLayout`

Returns the storage layout configuration for the specified bucket. Note that this operation requires storage.objects.list permission.

Parameters:

bucket (String) —
Name of a bucket.
prefix (String) (defaults to: nil) —
An optional prefix used for permission check. It is useful when the caller only has storage.objects.list permission under a specific prefix.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::BucketStorageLayout) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::BucketStorageLayout)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 722

def get_bucket_storage_layout(bucket, prefix: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/storageLayout', options)
  command.response_representation = Google::Apis::StorageV1::BucketStorageLayout::Representation
  command.response_class = Google::Apis::StorageV1::BucketStorageLayout
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['prefix'] = prefix unless prefix.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

#get_default_object_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

Returns the default object ACL entry for the specified entity on the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
entity (String) —
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ObjectAccessControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ObjectAccessControl)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1254

def get_default_object_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/defaultObjectAcl/{entity}', options)
  command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation
  command.response_class = Google::Apis::StorageV1::ObjectAccessControl
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['entity'] = entity unless entity.nil?
  command.query['userProject'] = user_project unless user_project.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

#get_folder(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Folder`

Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.

Parameters:

bucket (String) —
Name of the bucket in which the folder resides.
folder (String) —
Name of a folder.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the return of the folder metadata conditional on whether the folder's current metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the return of the folder metadata conditional on whether the folder's current metageneration does not match the given value.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Folder) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Folder)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1553

def get_folder(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/folders/{folder}', options)
  command.response_representation = Google::Apis::StorageV1::Folder::Representation
  command.response_class = Google::Apis::StorageV1::Folder
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['folder'] = folder unless folder.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.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

#get_managed_folder(bucket, managed_folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ManagedFolder`

Returns metadata of the specified managed folder.

Parameters:

bucket (String) —
Name of the bucket containing the managed folder.
managed_folder (String) —
The managed folder name/path.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration does not match the given value.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ManagedFolder) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ManagedFolder)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1792

def get_managed_folder(bucket, managed_folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/managedFolders/{managedFolder}', options)
  command.response_representation = Google::Apis::StorageV1::ManagedFolder::Representation
  command.response_class = Google::Apis::StorageV1::ManagedFolder
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['managedFolder'] = managed_folder unless managed_folder.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.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

#get_managed_folder_iam_policy(bucket, managed_folder, options_requested_policy_version: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Policy`

Returns an IAM policy for the specified managed folder.

Parameters:

bucket (String) —
Name of the bucket containing the managed folder.
managed_folder (String) —
The managed folder name/path.
options_requested_policy_version (Fixnum) (defaults to: nil) —
The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Policy) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Policy)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1836

def get_managed_folder_iam_policy(bucket, managed_folder, options_requested_policy_version: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/managedFolders/{managedFolder}/iam', options)
  command.response_representation = Google::Apis::StorageV1::Policy::Representation
  command.response_class = Google::Apis::StorageV1::Policy
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['managedFolder'] = managed_folder unless managed_folder.nil?
  command.query['optionsRequestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['userProject'] = user_project unless user_project.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

#get_notification(bucket, notification, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Notification`

View a notification configuration.

Parameters:

bucket (String) —
The parent bucket of the notification.
notification (String) —
Notification ID
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Notification) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Notification)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2077

def get_notification(bucket, notification, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/notificationConfigs/{notification}', options)
  command.response_representation = Google::Apis::StorageV1::Notification::Representation
  command.response_class = Google::Apis::StorageV1::Notification
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['notification'] = notification unless notification.nil?
  command.query['userProject'] = user_project unless user_project.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

#get_object(bucket, object, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, restore_token: nil, soft_deleted: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Object`

Retrieves an object or its metadata.

Parameters:

bucket (String) —
Name of the bucket in which the object resides.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of this object (as opposed to the latest version, the default).
if_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
if_generation_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current metageneration does not match the given value.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to noAcl.
restore_token (String) (defaults to: nil) —
Restore token used to differentiate soft-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets and if softDeleted is set to true. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation.
soft_deleted (Boolean) (defaults to: nil) —
If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
download_dest (IO, String) (defaults to: nil) —
IO stream or filename to receive content download
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Object) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Object)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2789

def get_object(bucket, object, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, restore_token: nil, soft_deleted: nil, user_project: 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_storage_download_command(:get, 'b/{bucket}/o/{object}', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::StorageV1::Object::Representation
  command.response_class = Google::Apis::StorageV1::Object
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['object'] = object unless object.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil?
  command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['restoreToken'] = restore_token unless restore_token.nil?
  command.query['softDeleted'] = soft_deleted unless soft_deleted.nil?
  command.query['userProject'] = user_project unless user_project.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

#get_object_access_control(bucket, object, entity, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

Returns the ACL entry for the specified entity on the specified object.

Parameters:

bucket (String) —
Name of a bucket.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
entity (String) —
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of this object (as opposed to the latest version, the default).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ObjectAccessControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ObjectAccessControl)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2247

def get_object_access_control(bucket, object, entity, generation: nil, user_project: nil, 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::StorageV1::ObjectAccessControl::Representation
  command.response_class = Google::Apis::StorageV1::ObjectAccessControl
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['object'] = object unless object.nil?
  command.params['entity'] = entity unless entity.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['userProject'] = user_project unless user_project.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

#get_object_iam_policy(bucket, object, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Policy`

Returns an IAM policy for the specified object.

Parameters:

bucket (String) —
Name of the bucket in which the object resides.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of this object (as opposed to the latest version, the default).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Policy) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Policy)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2847

def get_object_iam_policy(bucket, object, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/o/{object}/iam', options)
  command.response_representation = Google::Apis::StorageV1::Policy::Representation
  command.response_class = Google::Apis::StorageV1::Policy
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['object'] = object unless object.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['userProject'] = user_project unless user_project.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

#get_project_hmac_key(project_id, access_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::HmacKeyMetadata`

Retrieves an HMAC key's metadata

Parameters:

project_id (String) —
Project ID owning the service account of the requested key.
access_id (String) —
Name of the HMAC key.
user_project (String) (defaults to: nil) —
The project to be billed for this request.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::HmacKeyMetadata) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::HmacKeyMetadata)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3941

def get_project_hmac_key(project_id, access_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'projects/{projectId}/hmacKeys/{accessId}', options)
  command.response_representation = Google::Apis::StorageV1::HmacKeyMetadata::Representation
  command.response_class = Google::Apis::StorageV1::HmacKeyMetadata
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['accessId'] = access_id unless access_id.nil?
  command.query['userProject'] = user_project unless user_project.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

#get_project_service_account(project_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ServiceAccount`

Get the email address of this project's Google Cloud Storage service account.

Parameters:

project_id (String) —
Project ID
user_project (String) (defaults to: nil) —
The project to be billed for this request.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ServiceAccount) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ServiceAccount)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 4075

def get_project_service_account(project_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'projects/{projectId}/serviceAccount', options)
  command.response_representation = Google::Apis::StorageV1::ServiceAccount::Representation
  command.response_class = Google::Apis::StorageV1::ServiceAccount
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['userProject'] = user_project unless user_project.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

#insert_anywhere_cach(bucket, anywhere_cache_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

Creates an Anywhere Cache instance.

Parameters:

bucket (String) —
Name of the parent bucket.
anywhere_cache_object (Google::Apis::StorageV1::AnywhereCache) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 153

def insert_anywhere_cach(bucket, anywhere_cache_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/anywhereCaches', options)
  command.request_representation = Google::Apis::StorageV1::AnywhereCache::Representation
  command.request_object = anywhere_cache_object
  command.response_representation = Google::Apis::StorageV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::StorageV1::GoogleLongrunningOperation
  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

#insert_bucket(project, bucket_object = nil, enable_object_retention: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Bucket`

Creates a new bucket.

Parameters:

project (String) —
A valid API project identifier.
bucket_object (Google::Apis::StorageV1::Bucket) (defaults to: nil)
enable_object_retention (Boolean) (defaults to: nil) —
When set to true, object retention is enabled for this bucket.
predefined_acl (String) (defaults to: nil) —
Apply a predefined set of access controls to this bucket.
predefined_default_object_acl (String) (defaults to: nil) —
Apply a predefined set of default object access controls to this bucket.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
user_project (String) (defaults to: nil) —
The project to be billed for this request.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Bucket) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Bucket)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 768

def insert_bucket(project, bucket_object = nil, enable_object_retention: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b', options)
  command.request_representation = Google::Apis::StorageV1::Bucket::Representation
  command.request_object = bucket_object
  command.response_representation = Google::Apis::StorageV1::Bucket::Representation
  command.response_class = Google::Apis::StorageV1::Bucket
  command.query['enableObjectRetention'] = enable_object_retention unless enable_object_retention.nil?
  command.query['predefinedAcl'] = predefined_acl unless predefined_acl.nil?
  command.query['predefinedDefaultObjectAcl'] = predefined_default_object_acl unless predefined_default_object_acl.nil?
  command.query['project'] = project unless project.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['userProject'] = user_project unless user_project.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

#insert_bucket_access_control(bucket, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::BucketAccessControl`

Creates a new ACL entry on the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
bucket_access_control_object (Google::Apis::StorageV1::BucketAccessControl) (defaults to: nil)
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::BucketAccessControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::BucketAccessControl)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 421

def insert_bucket_access_control(bucket, bucket_access_control_object = nil, user_project: 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::StorageV1::BucketAccessControl::Representation
  command.request_object = bucket_access_control_object
  command.response_representation = Google::Apis::StorageV1::BucketAccessControl::Representation
  command.response_class = Google::Apis::StorageV1::BucketAccessControl
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['userProject'] = user_project unless user_project.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

#insert_default_object_access_control(bucket, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

Creates a new default object ACL entry on the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
object_access_control_object (Google::Apis::StorageV1::ObjectAccessControl) (defaults to: nil)
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ObjectAccessControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ObjectAccessControl)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1292

def insert_default_object_access_control(bucket, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/defaultObjectAcl', options)
  command.request_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation
  command.request_object = object_access_control_object
  command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation
  command.response_class = Google::Apis::StorageV1::ObjectAccessControl
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['userProject'] = user_project unless user_project.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

#insert_folder(bucket, folder_object = nil, recursive: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Folder`

Creates a new folder. Only applicable to buckets with hierarchical namespace enabled.

Parameters:

bucket (String) —
Name of the bucket in which the folder resides.
folder_object (Google::Apis::StorageV1::Folder) (defaults to: nil)
recursive (Boolean) (defaults to: nil) —
If true, any parent folder which doesn't exist will be created automatically.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Folder) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Folder)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1593

def insert_folder(bucket, folder_object = nil, recursive: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/folders', options)
  command.request_representation = Google::Apis::StorageV1::Folder::Representation
  command.request_object = folder_object
  command.response_representation = Google::Apis::StorageV1::Folder::Representation
  command.response_class = Google::Apis::StorageV1::Folder
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['recursive'] = recursive unless recursive.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

#insert_managed_folder(bucket, managed_folder_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ManagedFolder`

Creates a new managed folder.

Parameters:

bucket (String) —
Name of the bucket containing the managed folder.
managed_folder_object (Google::Apis::StorageV1::ManagedFolder) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ManagedFolder) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ManagedFolder)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1873

def insert_managed_folder(bucket, managed_folder_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/managedFolders', options)
  command.request_representation = Google::Apis::StorageV1::ManagedFolder::Representation
  command.request_object = managed_folder_object
  command.response_representation = Google::Apis::StorageV1::ManagedFolder::Representation
  command.response_class = Google::Apis::StorageV1::ManagedFolder
  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

#insert_notification(bucket, notification_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Notification`

Creates a notification subscription for a given bucket.

Parameters:

bucket (String) —
The parent bucket of the notification.
notification_object (Google::Apis::StorageV1::Notification) (defaults to: nil)
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Notification) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Notification)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2115

def insert_notification(bucket, notification_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/notificationConfigs', options)
  command.request_representation = Google::Apis::StorageV1::Notification::Representation
  command.request_object = notification_object
  command.response_representation = Google::Apis::StorageV1::Notification::Representation
  command.response_class = Google::Apis::StorageV1::Notification
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['userProject'] = user_project unless user_project.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

#insert_object(bucket, object_object = nil, content_encoding: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, kms_key_name: nil, name: nil, predefined_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Object`

Stores a new object and metadata.

Parameters:

bucket (String) —
Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.
object_object (Google::Apis::StorageV1::Object) (defaults to: nil)
content_encoding (String) (defaults to: nil) —
If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.
if_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
if_generation_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current metageneration does not match the given value.
kms_key_name (String) (defaults to: nil) —
Resource name of the Cloud KMS key, of the form projects/my-project/locations/ global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
name (String) (defaults to: nil) —
Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
predefined_acl (String) (defaults to: nil) —
Apply a predefined set of access controls to this object.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
upload_source (IO, String) (defaults to: nil) —
IO stream or filename containing content to upload
content_type (String) (defaults to: nil) —
Content type of the uploaded content.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Object) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Object)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2925

def insert_object(bucket, object_object = nil, content_encoding: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, kms_key_name: nil, name: nil, predefined_acl: nil, projection: nil, user_project: 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_storage_upload_command(:post, 'b/{bucket}/o', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::StorageV1::Object::Representation
  command.request_object = object_object
  command.response_representation = Google::Apis::StorageV1::Object::Representation
  command.response_class = Google::Apis::StorageV1::Object
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['contentEncoding'] = content_encoding unless content_encoding.nil?
  command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil?
  command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['kmsKeyName'] = kms_key_name unless kms_key_name.nil?
  command.query['name'] = name unless name.nil?
  command.query['predefinedAcl'] = predefined_acl unless predefined_acl.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['userProject'] = user_project unless user_project.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

#insert_object_access_control(bucket, object, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

Creates a new ACL entry on the specified object.

Parameters:

bucket (String) —
Name of a bucket.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
object_access_control_object (Google::Apis::StorageV1::ObjectAccessControl) (defaults to: nil)
generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of this object (as opposed to the latest version, the default).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ObjectAccessControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ObjectAccessControl)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2294

def insert_object_access_control(bucket, object, object_access_control_object = nil, generation: nil, user_project: 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::StorageV1::ObjectAccessControl::Representation
  command.request_object = object_access_control_object
  command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation
  command.response_class = Google::Apis::StorageV1::ObjectAccessControl
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['object'] = object unless object.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['userProject'] = user_project unless user_project.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

#list_anywhere_caches(bucket, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::AnywhereCaches`

Returns a list of Anywhere Cache instances of the bucket matching the criteria.

Parameters:

bucket (String) —
Name of the parent bucket.
page_size (Fixnum) (defaults to: nil) —
Maximum number of items to return in a single page of responses. Maximum 1000.
page_token (String) (defaults to: nil) —
A previously-returned page token representing part of the larger set of results to view.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::AnywhereCaches) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::AnywhereCaches)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 193

def list_anywhere_caches(bucket, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/anywhereCaches', options)
  command.response_representation = Google::Apis::StorageV1::AnywhereCaches::Representation
  command.response_class = Google::Apis::StorageV1::AnywhereCaches
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.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

#list_bucket_access_controls(bucket, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::BucketAccessControls`

Retrieves ACL entries on the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::BucketAccessControls) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::BucketAccessControls)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 459

def list_bucket_access_controls(bucket, user_project: nil, 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::StorageV1::BucketAccessControls::Representation
  command.response_class = Google::Apis::StorageV1::BucketAccessControls
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['userProject'] = user_project unless user_project.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

#list_bucket_operations(bucket, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningListOperationsResponse`

Lists operations that match the specified filter in the request.

Parameters:

bucket (String) —
Name of the bucket in which to look for operations.
filter (String) (defaults to: nil) —
A filter to narrow down results to a preferred subset. The filtering language is documented in more detail in AIP-160.
page_size (Fixnum) (defaults to: nil) —
Maximum number of items to return in a single page of responses. Fewer total results may be returned than requested. The service uses this parameter or 100 items, whichever is smaller.
page_token (String) (defaults to: nil) —
A previously-returned page token representing part of the larger set of results to view.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::GoogleLongrunningListOperationsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::GoogleLongrunningListOperationsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3825

def list_bucket_operations(bucket, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/operations', options)
  command.response_representation = Google::Apis::StorageV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::StorageV1::GoogleLongrunningListOperationsResponse
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.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

#list_buckets(project, max_results: nil, page_token: nil, prefix: nil, projection: nil, return_partial_success: nil, soft_deleted: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Buckets`

Retrieves a list of buckets for a given project.

Parameters:

project (String) —
A valid API project identifier.
max_results (Fixnum) (defaults to: nil) —
Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
page_token (String) (defaults to: nil) —
A previously-returned page token representing part of the larger set of results to view.
prefix (String) (defaults to: nil) —
Filter results to buckets whose names begin with this prefix.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to noAcl.
return_partial_success (Boolean) (defaults to: nil) —
If true, return a list of bucket resource names for buckets that are in unreachable locations.
soft_deleted (Boolean) (defaults to: nil) —
If true, only soft-deleted bucket versions will be returned. The default is false. For more information, see Soft Delete.
user_project (String) (defaults to: nil) —
The project to be billed for this request.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Buckets) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Buckets)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 827

def list_buckets(project, max_results: nil, page_token: nil, prefix: nil, projection: nil, return_partial_success: nil, soft_deleted: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b', options)
  command.response_representation = Google::Apis::StorageV1::Buckets::Representation
  command.response_class = Google::Apis::StorageV1::Buckets
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['prefix'] = prefix unless prefix.nil?
  command.query['project'] = project unless project.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
  command.query['softDeleted'] = soft_deleted unless soft_deleted.nil?
  command.query['userProject'] = user_project unless user_project.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

#list_default_object_access_controls(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControls`

Retrieves default object ACL entries on the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
if_metageneration_match (Fixnum) (defaults to: nil) —
If present, only return default ACL listing if the bucket's current metageneration matches this value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
If present, only return default ACL listing if the bucket's current metageneration does not match the given value.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ObjectAccessControls) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ObjectAccessControls)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1336

def list_default_object_access_controls(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/defaultObjectAcl', options)
  command.response_representation = Google::Apis::StorageV1::ObjectAccessControls::Representation
  command.response_class = Google::Apis::StorageV1::ObjectAccessControls
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['userProject'] = user_project unless user_project.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

#list_folders(bucket, delimiter: nil, end_offset: nil, page_size: nil, page_token: nil, prefix: nil, start_offset: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Folders`

Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.

Parameters:

bucket (String) —
Name of the bucket in which to look for folders.
delimiter (String) (defaults to: nil) —
Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.
end_offset (String) (defaults to: nil) —
Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
page_size (Fixnum) (defaults to: nil) —
Maximum number of items to return in a single page of responses.
page_token (String) (defaults to: nil) —
A previously-returned page token representing part of the larger set of results to view.
prefix (String) (defaults to: nil) —
Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.
start_offset (String) (defaults to: nil) —
Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Folders) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Folders)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1650

def list_folders(bucket, delimiter: nil, end_offset: nil, page_size: nil, page_token: nil, prefix: nil, start_offset: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/folders', options)
  command.response_representation = Google::Apis::StorageV1::Folders::Representation
  command.response_class = Google::Apis::StorageV1::Folders
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['delimiter'] = delimiter unless delimiter.nil?
  command.query['endOffset'] = end_offset unless end_offset.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['prefix'] = prefix unless prefix.nil?
  command.query['startOffset'] = start_offset unless start_offset.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

#list_managed_folders(bucket, page_size: nil, page_token: nil, prefix: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ManagedFolders`

Lists managed folders in the given bucket.

Parameters:

bucket (String) —
Name of the bucket containing the managed folder.
page_size (Fixnum) (defaults to: nil) —
Maximum number of items to return in a single page of responses.
page_token (String) (defaults to: nil) —
A previously-returned page token representing part of the larger set of results to view.
prefix (String) (defaults to: nil) —
The managed folder name/path prefix to filter the output list of results.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ManagedFolders) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ManagedFolders)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1915

def list_managed_folders(bucket, page_size: nil, page_token: nil, prefix: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/managedFolders', options)
  command.response_representation = Google::Apis::StorageV1::ManagedFolders::Representation
  command.response_class = Google::Apis::StorageV1::ManagedFolders
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['prefix'] = prefix unless prefix.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

#list_notifications(bucket, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Notifications`

Retrieves a list of notification subscriptions for a given bucket.

Parameters:

bucket (String) —
Name of a Google Cloud Storage bucket.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Notifications) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Notifications)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2153

def list_notifications(bucket, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/notificationConfigs', options)
  command.response_representation = Google::Apis::StorageV1::Notifications::Representation
  command.response_class = Google::Apis::StorageV1::Notifications
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['userProject'] = user_project unless user_project.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

#list_object_access_controls(bucket, object, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControls`

Retrieves ACL entries on the specified object.

Parameters:

bucket (String) —
Name of a bucket.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of this object (as opposed to the latest version, the default).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ObjectAccessControls) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ObjectAccessControls)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2341

def list_object_access_controls(bucket, object, generation: nil, user_project: nil, 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::StorageV1::ObjectAccessControls::Representation
  command.response_class = Google::Apis::StorageV1::ObjectAccessControls
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['object'] = object unless object.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['userProject'] = user_project unless user_project.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

#list_objects(bucket, delimiter: nil, end_offset: nil, filter: nil, include_folders_as_prefixes: nil, include_trailing_delimiter: nil, match_glob: nil, max_results: nil, page_token: nil, prefix: nil, projection: nil, soft_deleted: nil, start_offset: nil, user_project: nil, versions: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Objects`

Retrieves a list of objects matching the criteria.

Parameters:

bucket (String) —
Name of the bucket in which to look for objects.
delimiter (String) (defaults to: nil) —
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.
end_offset (String) (defaults to: nil) —
Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
filter (String) (defaults to: nil) —
Filter the returned objects. Currently only supported for the contexts field. If delimiter is set, the returned prefixes are exempt from this filter.
include_folders_as_prefixes (Boolean) (defaults to: nil) —
Only applicable if delimiter is set to '/'. If true, will also include folders and managed folders (besides objects) in the returned prefixes.
include_trailing_delimiter (Boolean) (defaults to: nil) —
If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
match_glob (String) (defaults to: nil) —
Filter results to objects and prefixes that match this glob pattern.
max_results (Fixnum) (defaults to: nil) —
Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
page_token (String) (defaults to: nil) —
A previously-returned page token representing part of the larger set of results to view.
prefix (String) (defaults to: nil) —
Filter results to objects whose names begin with this prefix.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to noAcl.
soft_deleted (Boolean) (defaults to: nil) —
If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.
start_offset (String) (defaults to: nil) —
Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
versions (Boolean) (defaults to: nil) —
If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Objects) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Objects)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3024

def list_objects(bucket, delimiter: nil, end_offset: nil, filter: nil, include_folders_as_prefixes: nil, include_trailing_delimiter: nil, match_glob: nil, max_results: nil, page_token: nil, prefix: nil, projection: nil, soft_deleted: nil, start_offset: nil, user_project: nil, versions: 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::StorageV1::Objects::Representation
  command.response_class = Google::Apis::StorageV1::Objects
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['delimiter'] = delimiter unless delimiter.nil?
  command.query['endOffset'] = end_offset unless end_offset.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['includeFoldersAsPrefixes'] = include_folders_as_prefixes unless include_folders_as_prefixes.nil?
  command.query['includeTrailingDelimiter'] = include_trailing_delimiter unless include_trailing_delimiter.nil?
  command.query['matchGlob'] = match_glob unless match_glob.nil?
  command.query['maxResults'] = 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['softDeleted'] = soft_deleted unless soft_deleted.nil?
  command.query['startOffset'] = start_offset unless start_offset.nil?
  command.query['userProject'] = user_project unless user_project.nil?
  command.query['versions'] = versions unless versions.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

#list_project_hmac_keys(project_id, max_results: nil, page_token: nil, service_account_email: nil, show_deleted_keys: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::HmacKeysMetadata`

Retrieves a list of HMAC keys matching the criteria.

Parameters:

project_id (String) —
Name of the project in which to look for HMAC keys.
max_results (Fixnum) (defaults to: nil) —
Maximum number of items to return in a single page of responses. The service uses this parameter or 250 items, whichever is smaller. The max number of items per page will also be limited by the number of distinct service accounts in the response. If the number of service accounts in a single response is too high, the page will truncated and a next page token will be returned.
page_token (String) (defaults to: nil) —
A previously-returned page token representing part of the larger set of results to view.
service_account_email (String) (defaults to: nil) —
If present, only keys for the given service account are returned.
show_deleted_keys (Boolean) (defaults to: nil) —
Whether or not to show keys in the DELETED state.
user_project (String) (defaults to: nil) —
The project to be billed for this request.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::HmacKeysMetadata) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::HmacKeysMetadata)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3991

def list_project_hmac_keys(project_id, max_results: nil, page_token: nil, service_account_email: nil, show_deleted_keys: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'projects/{projectId}/hmacKeys', options)
  command.response_representation = Google::Apis::StorageV1::HmacKeysMetadata::Representation
  command.response_class = Google::Apis::StorageV1::HmacKeysMetadata
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['serviceAccountEmail'] = service_account_email unless service_account_email.nil?
  command.query['showDeletedKeys'] = show_deleted_keys unless show_deleted_keys.nil?
  command.query['userProject'] = user_project unless user_project.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

#lock_bucket_retention_policy(bucket, if_metageneration_match, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Bucket`

Locks retention policy on a bucket.

Parameters:

bucket (String) —
Name of a bucket.
if_metageneration_match (Fixnum) —
Makes the operation conditional on whether bucket's current metageneration matches the given value.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Bucket) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Bucket)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 872

def lock_bucket_retention_policy(bucket, if_metageneration_match, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/lockRetentionPolicy', options)
  command.response_representation = Google::Apis::StorageV1::Bucket::Representation
  command.response_class = Google::Apis::StorageV1::Bucket
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['userProject'] = user_project unless user_project.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

#move_object(bucket, source_object, destination_object, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Object`

Moves the source object to the destination object in the same bucket.

Parameters:

bucket (String) —
Name of the bucket in which the object resides.
source_object (String) —
Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
destination_object (String) —
Name of the destination object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
if_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. ifGenerationMatch and ifGenerationNotMatch conditions are mutually exclusive: it's an error for both of them to be set in the request.
if_generation_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.ifGenerationMatch and ifGenerationNotMatch conditions are mutually exclusive: it's an error for both of them to be set in the request.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the destination object's current metageneration matches the given value. ifMetagenerationMatch and ifMetagenerationNotMatch conditions are mutually exclusive: it's an error for both of them to be set in the request.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the destination object's current metageneration does not match the given value. ifMetagenerationMatch and ifMetagenerationNotMatch conditions are mutually exclusive: it's an error for both of them to be set in the request.
if_source_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current generation matches the given value. ifSourceGenerationMatch and ifSourceGenerationNotMatch conditions are mutually exclusive: it's an error for both of them to be set in the request.
if_source_generation_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current generation does not match the given value. ifSourceGenerationMatch and ifSourceGenerationNotMatch conditions are mutually exclusive: it's an error for both of them to be set in the request.
if_source_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current metageneration matches the given value. ifSourceMetagenerationMatch and ifSourceMetagenerationNotMatch conditions are mutually exclusive: it's an error for both of them to be set in the request.
if_source_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current metageneration does not match the given value. ifSourceMetagenerationMatch and ifSourceMetagenerationNotMatch conditions are mutually exclusive: it's an error for both of them to be set in the request.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to noAcl.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Object) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Object)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3126

def move_object(bucket, source_object, destination_object, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/o/{sourceObject}/moveTo/o/{destinationObject}', options)
  command.response_representation = Google::Apis::StorageV1::Object::Representation
  command.response_class = Google::Apis::StorageV1::Object
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['sourceObject'] = source_object unless source_object.nil?
  command.params['destinationObject'] = destination_object unless destination_object.nil?
  command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil?
  command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['ifSourceGenerationMatch'] = if_source_generation_match unless if_source_generation_match.nil?
  command.query['ifSourceGenerationNotMatch'] = if_source_generation_not_match unless if_source_generation_not_match.nil?
  command.query['ifSourceMetagenerationMatch'] = if_source_metageneration_match unless if_source_metageneration_match.nil?
  command.query['ifSourceMetagenerationNotMatch'] = if_source_metageneration_not_match unless if_source_metageneration_not_match.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['userProject'] = user_project unless user_project.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

#patch_bucket(bucket, bucket_object = nil, if_metageneration_match: nil, if_metageneration_not_match: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Bucket`

Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

Parameters:

bucket (String) —
Name of a bucket.
bucket_object (Google::Apis::StorageV1::Bucket) (defaults to: nil)
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
predefined_acl (String) (defaults to: nil) —
Apply a predefined set of access controls to this bucket.
predefined_default_object_acl (String) (defaults to: nil) —
Apply a predefined set of default object access controls to this bucket.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to full.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Bucket) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Bucket)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 923

def patch_bucket(bucket, bucket_object = nil, if_metageneration_match: nil, if_metageneration_not_match: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: 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::StorageV1::Bucket::Representation
  command.request_object = bucket_object
  command.response_representation = Google::Apis::StorageV1::Bucket::Representation
  command.response_class = Google::Apis::StorageV1::Bucket
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['predefinedAcl'] = predefined_acl unless predefined_acl.nil?
  command.query['predefinedDefaultObjectAcl'] = predefined_default_object_acl unless predefined_default_object_acl.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['userProject'] = user_project unless user_project.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

#patch_bucket_access_control(bucket, entity, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::BucketAccessControl`

Patches an ACL entry on the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
entity (String) —
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
bucket_access_control_object (Google::Apis::StorageV1::BucketAccessControl) (defaults to: nil)
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::BucketAccessControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::BucketAccessControl)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 499

def patch_bucket_access_control(bucket, entity, bucket_access_control_object = nil, user_project: 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::StorageV1::BucketAccessControl::Representation
  command.request_object = bucket_access_control_object
  command.response_representation = Google::Apis::StorageV1::BucketAccessControl::Representation
  command.response_class = Google::Apis::StorageV1::BucketAccessControl
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['entity'] = entity unless entity.nil?
  command.query['userProject'] = user_project unless user_project.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

#patch_default_object_access_control(bucket, entity, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

Patches a default object ACL entry on the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
entity (String) —
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
object_access_control_object (Google::Apis::StorageV1::ObjectAccessControl) (defaults to: nil)
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ObjectAccessControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ObjectAccessControl)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1378

def patch_default_object_access_control(bucket, entity, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'b/{bucket}/defaultObjectAcl/{entity}', options)
  command.request_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation
  command.request_object = object_access_control_object
  command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation
  command.response_class = Google::Apis::StorageV1::ObjectAccessControl
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['entity'] = entity unless entity.nil?
  command.query['userProject'] = user_project unless user_project.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

#patch_object(bucket, object, object_object = nil, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, override_unlocked_retention: nil, predefined_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Object`

Patches an object's metadata.

Parameters:

bucket (String) —
Name of the bucket in which the object resides.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
object_object (Google::Apis::StorageV1::Object) (defaults to: nil)
generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of this object (as opposed to the latest version, the default).
if_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
if_generation_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current metageneration does not match the given value.
override_unlocked_retention (Boolean) (defaults to: nil) —
Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.
predefined_acl (String) (defaults to: nil) —
Apply a predefined set of access controls to this object.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to full.
user_project (String) (defaults to: nil) —
The project to be billed for this request, for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Object) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Object)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3203

def patch_object(bucket, object, object_object = nil, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, override_unlocked_retention: nil, predefined_acl: nil, projection: nil, user_project: 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::StorageV1::Object::Representation
  command.request_object = object_object
  command.response_representation = Google::Apis::StorageV1::Object::Representation
  command.response_class = Google::Apis::StorageV1::Object
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['object'] = object unless object.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil?
  command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['overrideUnlockedRetention'] = override_unlocked_retention unless override_unlocked_retention.nil?
  command.query['predefinedAcl'] = predefined_acl unless predefined_acl.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['userProject'] = user_project unless user_project.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

#patch_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

Patches an ACL entry on the specified object.

Parameters:

bucket (String) —
Name of a bucket.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
entity (String) —
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
object_access_control_object (Google::Apis::StorageV1::ObjectAccessControl) (defaults to: nil)
generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of this object (as opposed to the latest version, the default).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ObjectAccessControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ObjectAccessControl)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2390

def patch_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, user_project: 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::StorageV1::ObjectAccessControl::Representation
  command.request_object = object_access_control_object
  command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation
  command.response_class = Google::Apis::StorageV1::ObjectAccessControl
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['object'] = object unless object.nil?
  command.params['entity'] = entity unless entity.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['userProject'] = user_project unless user_project.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

#pause_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::AnywhereCache`

Pauses an Anywhere Cache instance.

Parameters:

bucket (String) —
Name of the parent bucket.
anywhere_cache_id (String) —
The ID of requested Anywhere Cache instance.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::AnywhereCache) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::AnywhereCache)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 230

def pause_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/anywhereCaches/{anywhereCacheId}/pause', options)
  command.response_representation = Google::Apis::StorageV1::AnywhereCache::Representation
  command.response_class = Google::Apis::StorageV1::AnywhereCache
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['anywhereCacheId'] = anywhere_cache_id unless anywhere_cache_id.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

#relocate_bucket(bucket, relocate_bucket_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

Initiates a long-running Relocate Bucket operation on the specified bucket.

Parameters:

bucket (String) —
Name of the bucket to be moved.
relocate_bucket_request_object (Google::Apis::StorageV1::RelocateBucketRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 965

def relocate_bucket(bucket, relocate_bucket_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/relocate', options)
  command.request_representation = Google::Apis::StorageV1::RelocateBucketRequest::Representation
  command.request_object = relocate_bucket_request_object
  command.response_representation = Google::Apis::StorageV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::StorageV1::GoogleLongrunningOperation
  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

#rename_folder(bucket, source_folder, destination_folder, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

Renames a source folder to a destination folder. Only applicable to buckets with hierarchical namespace enabled.

Parameters:

bucket (String) —
Name of the bucket in which the folders are in.
source_folder (String) —
Name of the source folder.
destination_folder (String) —
Name of the destination folder.
if_source_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current metageneration matches the given value.
if_source_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current metageneration does not match the given value.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1700

def rename_folder(bucket, source_folder, destination_folder, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/folders/{sourceFolder}/renameTo/folders/{destinationFolder}', options)
  command.response_representation = Google::Apis::StorageV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::StorageV1::GoogleLongrunningOperation
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['sourceFolder'] = source_folder unless source_folder.nil?
  command.params['destinationFolder'] = destination_folder unless destination_folder.nil?
  command.query['ifSourceMetagenerationMatch'] = if_source_metageneration_match unless if_source_metageneration_match.nil?
  command.query['ifSourceMetagenerationNotMatch'] = if_source_metageneration_not_match unless if_source_metageneration_not_match.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

#restore_bucket(bucket, generation, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Bucket`

Restores a soft-deleted bucket.

Parameters:

bucket (String) —
Name of a bucket.
generation (Fixnum) —
Generation of a bucket.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to full.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Bucket) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Bucket)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1006

def restore_bucket(bucket, generation, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/restore', options)
  command.response_representation = Google::Apis::StorageV1::Bucket::Representation
  command.response_class = Google::Apis::StorageV1::Bucket
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['userProject'] = user_project unless user_project.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

#restore_object(bucket, object, generation, copy_source_acl: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, restore_token: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Object`

Restores a soft-deleted object.

Parameters:

bucket (String) —
Name of the bucket in which the object resides.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
generation (Fixnum) —
Selects a specific revision of this object.
copy_source_acl (Boolean) (defaults to: nil) —
If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false.
if_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's one live generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
if_generation_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether none of the object's live generations match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's one live metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether none of the object's live metagenerations match the given value.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to full.
restore_token (String) (defaults to: nil) —
Restore token used to differentiate sof-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Object) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Object)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3281

def restore_object(bucket, object, generation, copy_source_acl: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, restore_token: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/o/{object}/restore', options)
  command.response_representation = Google::Apis::StorageV1::Object::Representation
  command.response_class = Google::Apis::StorageV1::Object
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['object'] = object unless object.nil?
  command.query['copySourceAcl'] = copy_source_acl unless copy_source_acl.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil?
  command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['restoreToken'] = restore_token unless restore_token.nil?
  command.query['userProject'] = user_project unless user_project.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

#resume_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::AnywhereCache`

Resumes a paused or disabled Anywhere Cache instance.

Parameters:

bucket (String) —
Name of the parent bucket.
anywhere_cache_id (String) —
The ID of requested Anywhere Cache instance.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::AnywhereCache) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::AnywhereCache)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 266

def resume_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/anywhereCaches/{anywhereCacheId}/resume', options)
  command.response_representation = Google::Apis::StorageV1::AnywhereCache::Representation
  command.response_class = Google::Apis::StorageV1::AnywhereCache
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['anywhereCacheId'] = anywhere_cache_id unless anywhere_cache_id.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

#rewrite_object(source_bucket, source_object, destination_bucket, destination_object, object_object = nil, destination_kms_key_name: nil, destination_predefined_acl: nil, drop_context_groups: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, max_bytes_rewritten_per_call: nil, projection: nil, rewrite_token: nil, source_generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::RewriteResponse`

Rewrites a source object to a destination object. Optionally overrides metadata.

Parameters:

source_bucket (String) —
Name of the bucket in which to find the source object.
source_object (String) —
Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
destination_bucket (String) —
Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.
destination_object (String) —
Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
object_object (Google::Apis::StorageV1::Object) (defaults to: nil)
destination_kms_key_name (String) (defaults to: nil) —
Resource name of the Cloud KMS key, of the form projects/my-project/locations/ global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
destination_predefined_acl (String) (defaults to: nil) —
Apply a predefined set of access controls to the destination object.
drop_context_groups (Array<String>, String) (defaults to: nil) —
Specifies which groups of Object Contexts from the source object should be dropped from the destination object.
if_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
if_generation_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the destination object's current metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
if_source_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current generation matches the given value.
if_source_generation_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current generation does not match the given value.
if_source_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current metageneration matches the given value.
if_source_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the source object's current metageneration does not match the given value.
max_bytes_rewritten_per_call (Fixnum) (defaults to: nil) —
The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB ( 1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
rewrite_token (String) (defaults to: nil) —
Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.
source_generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of the source object (as opposed to the latest version, the default).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::RewriteResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::RewriteResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3395

def rewrite_object(source_bucket, source_object, destination_bucket, destination_object, object_object = nil, destination_kms_key_name: nil, destination_predefined_acl: nil, drop_context_groups: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, max_bytes_rewritten_per_call: nil, projection: nil, rewrite_token: nil, source_generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}', options)
  command.request_representation = Google::Apis::StorageV1::Object::Representation
  command.request_object = object_object
  command.response_representation = Google::Apis::StorageV1::RewriteResponse::Representation
  command.response_class = Google::Apis::StorageV1::RewriteResponse
  command.params['sourceBucket'] = source_bucket unless source_bucket.nil?
  command.params['sourceObject'] = source_object unless source_object.nil?
  command.params['destinationBucket'] = destination_bucket unless destination_bucket.nil?
  command.params['destinationObject'] = destination_object unless destination_object.nil?
  command.query['destinationKmsKeyName'] = destination_kms_key_name unless destination_kms_key_name.nil?
  command.query['destinationPredefinedAcl'] = destination_predefined_acl unless destination_predefined_acl.nil?
  command.query['dropContextGroups'] = drop_context_groups unless drop_context_groups.nil?
  command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil?
  command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['ifSourceGenerationMatch'] = if_source_generation_match unless if_source_generation_match.nil?
  command.query['ifSourceGenerationNotMatch'] = if_source_generation_not_match unless if_source_generation_not_match.nil?
  command.query['ifSourceMetagenerationMatch'] = if_source_metageneration_match unless if_source_metageneration_match.nil?
  command.query['ifSourceMetagenerationNotMatch'] = if_source_metageneration_not_match unless if_source_metageneration_not_match.nil?
  command.query['maxBytesRewrittenPerCall'] = max_bytes_rewritten_per_call unless max_bytes_rewritten_per_call.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['rewriteToken'] = rewrite_token unless rewrite_token.nil?
  command.query['sourceGeneration'] = source_generation unless source_generation.nil?
  command.query['userProject'] = user_project unless user_project.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

#set_bucket_iam_policy(bucket, policy_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Policy`

Updates an IAM policy for the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
policy_object (Google::Apis::StorageV1::Policy) (defaults to: nil)
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Policy) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Policy)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1045

def set_bucket_iam_policy(bucket, policy_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'b/{bucket}/iam', options)
  command.request_representation = Google::Apis::StorageV1::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::StorageV1::Policy::Representation
  command.response_class = Google::Apis::StorageV1::Policy
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['userProject'] = user_project unless user_project.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

#set_managed_folder_iam_policy(bucket, managed_folder, policy_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Policy`

Updates an IAM policy for the specified managed folder.

Parameters:

bucket (String) —
Name of the bucket containing the managed folder.
managed_folder (String) —
The managed folder name/path.
policy_object (Google::Apis::StorageV1::Policy) (defaults to: nil)
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Policy) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Policy)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1956

def set_managed_folder_iam_policy(bucket, managed_folder, policy_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'b/{bucket}/managedFolders/{managedFolder}/iam', options)
  command.request_representation = Google::Apis::StorageV1::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::StorageV1::Policy::Representation
  command.response_class = Google::Apis::StorageV1::Policy
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['managedFolder'] = managed_folder unless managed_folder.nil?
  command.query['userProject'] = user_project unless user_project.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

#set_object_iam_policy(bucket, object, policy_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Policy`

Updates an IAM policy for the specified object.

Parameters:

bucket (String) —
Name of the bucket in which the object resides.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
policy_object (Google::Apis::StorageV1::Policy) (defaults to: nil)
generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of this object (as opposed to the latest version, the default).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Policy) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Policy)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3459

def set_object_iam_policy(bucket, object, policy_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'b/{bucket}/o/{object}/iam', options)
  command.request_representation = Google::Apis::StorageV1::Policy::Representation
  command.request_object = policy_object
  command.response_representation = Google::Apis::StorageV1::Policy::Representation
  command.response_class = Google::Apis::StorageV1::Policy
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['object'] = object unless object.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['userProject'] = user_project unless user_project.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

#stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Stop watching resources through this channel

Parameters:

channel_object (Google::Apis::StorageV1::Channel) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1177

def stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'channels/stop', options)
  command.request_representation = Google::Apis::StorageV1::Channel::Representation
  command.request_object = channel_object
  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

#test_bucket_iam_permissions(bucket, permissions, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::TestIamPermissionsResponse`

Tests a set of permissions on the given bucket to see which, if any, are held by the caller.

Parameters:

bucket (String) —
Name of a bucket.
permissions (Array<String>, String) —
Permissions to test.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::TestIamPermissionsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::TestIamPermissionsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1086

def test_bucket_iam_permissions(bucket, permissions, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/iam/testPermissions', options)
  command.response_representation = Google::Apis::StorageV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::StorageV1::TestIamPermissionsResponse
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['permissions'] = permissions unless permissions.nil?
  command.query['userProject'] = user_project unless user_project.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

#test_managed_folder_iam_permissions(bucket, managed_folder, permissions, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::TestIamPermissionsResponse`

Tests a set of permissions on the given managed folder to see which, if any, are held by the caller.

Parameters:

bucket (String) —
Name of the bucket containing the managed folder.
managed_folder (String) —
The managed folder name/path.
permissions (Array<String>, String) —
Permissions to test.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::TestIamPermissionsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::TestIamPermissionsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2000

def test_managed_folder_iam_permissions(bucket, managed_folder, permissions, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/managedFolders/{managedFolder}/iam/testPermissions', options)
  command.response_representation = Google::Apis::StorageV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::StorageV1::TestIamPermissionsResponse
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['managedFolder'] = managed_folder unless managed_folder.nil?
  command.query['permissions'] = permissions unless permissions.nil?
  command.query['userProject'] = user_project unless user_project.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

#test_object_iam_permissions(bucket, object, permissions, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::TestIamPermissionsResponse`

Tests a set of permissions on the given object to see which, if any, are held by the caller.

Parameters:

bucket (String) —
Name of the bucket in which the object resides.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
permissions (Array<String>, String) —
Permissions to test.
generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of this object (as opposed to the latest version, the default).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::TestIamPermissionsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::TestIamPermissionsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3509

def test_object_iam_permissions(bucket, object, permissions, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'b/{bucket}/o/{object}/iam/testPermissions', options)
  command.response_representation = Google::Apis::StorageV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::StorageV1::TestIamPermissionsResponse
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['object'] = object unless object.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['permissions'] = permissions unless permissions.nil?
  command.query['userProject'] = user_project unless user_project.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

#update_anywhere_cach(bucket, anywhere_cache_id, anywhere_cache_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.

Parameters:

bucket (String) —
Name of the parent bucket.
anywhere_cache_id (String) —
The ID of requested Anywhere Cache instance.
anywhere_cache_object (Google::Apis::StorageV1::AnywhereCache) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::GoogleLongrunningOperation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::GoogleLongrunningOperation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 303

def update_anywhere_cach(bucket, anywhere_cache_id, anywhere_cache_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, 'b/{bucket}/anywhereCaches/{anywhereCacheId}', options)
  command.request_representation = Google::Apis::StorageV1::AnywhereCache::Representation
  command.request_object = anywhere_cache_object
  command.response_representation = Google::Apis::StorageV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::StorageV1::GoogleLongrunningOperation
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['anywhereCacheId'] = anywhere_cache_id unless anywhere_cache_id.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

#update_bucket(bucket, bucket_object = nil, if_metageneration_match: nil, if_metageneration_not_match: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Bucket`

Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

Parameters:

bucket (String) —
Name of a bucket.
bucket_object (Google::Apis::StorageV1::Bucket) (defaults to: nil)
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
predefined_acl (String) (defaults to: nil) —
Apply a predefined set of access controls to this bucket.
predefined_default_object_acl (String) (defaults to: nil) —
Apply a predefined set of default object access controls to this bucket.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to full.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Bucket) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Bucket)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1137

def update_bucket(bucket, bucket_object = nil, if_metageneration_match: nil, if_metageneration_not_match: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: 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::StorageV1::Bucket::Representation
  command.request_object = bucket_object
  command.response_representation = Google::Apis::StorageV1::Bucket::Representation
  command.response_class = Google::Apis::StorageV1::Bucket
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['predefinedAcl'] = predefined_acl unless predefined_acl.nil?
  command.query['predefinedDefaultObjectAcl'] = predefined_default_object_acl unless predefined_default_object_acl.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['userProject'] = user_project unless user_project.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

#update_bucket_access_control(bucket, entity, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::BucketAccessControl`

Updates an ACL entry on the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
entity (String) —
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
bucket_access_control_object (Google::Apis::StorageV1::BucketAccessControl) (defaults to: nil)
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::BucketAccessControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::BucketAccessControl)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 542

def update_bucket_access_control(bucket, entity, bucket_access_control_object = nil, user_project: 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::StorageV1::BucketAccessControl::Representation
  command.request_object = bucket_access_control_object
  command.response_representation = Google::Apis::StorageV1::BucketAccessControl::Representation
  command.response_class = Google::Apis::StorageV1::BucketAccessControl
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['entity'] = entity unless entity.nil?
  command.query['userProject'] = user_project unless user_project.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

#update_default_object_access_control(bucket, entity, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

Updates a default object ACL entry on the specified bucket.

Parameters:

bucket (String) —
Name of a bucket.
entity (String) —
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
object_access_control_object (Google::Apis::StorageV1::ObjectAccessControl) (defaults to: nil)
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ObjectAccessControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ObjectAccessControl)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 1421

def update_default_object_access_control(bucket, entity, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'b/{bucket}/defaultObjectAcl/{entity}', options)
  command.request_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation
  command.request_object = object_access_control_object
  command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation
  command.response_class = Google::Apis::StorageV1::ObjectAccessControl
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['entity'] = entity unless entity.nil?
  command.query['userProject'] = user_project unless user_project.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

#update_object(bucket, object, object_object = nil, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, override_unlocked_retention: nil, predefined_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Object`

Updates an object's metadata.

Parameters:

bucket (String) —
Name of the bucket in which the object resides.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
object_object (Google::Apis::StorageV1::Object) (defaults to: nil)
generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of this object (as opposed to the latest version, the default).
if_generation_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
if_generation_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
if_metageneration_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current metageneration matches the given value.
if_metageneration_not_match (Fixnum) (defaults to: nil) —
Makes the operation conditional on whether the object's current metageneration does not match the given value.
override_unlocked_retention (Boolean) (defaults to: nil) —
Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.
predefined_acl (String) (defaults to: nil) —
Apply a predefined set of access controls to this object.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to full.
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Object) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Object)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3578

def update_object(bucket, object, object_object = nil, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, override_unlocked_retention: nil, predefined_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'b/{bucket}/o/{object}', options)
  command.request_representation = Google::Apis::StorageV1::Object::Representation
  command.request_object = object_object
  command.response_representation = Google::Apis::StorageV1::Object::Representation
  command.response_class = Google::Apis::StorageV1::Object
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['object'] = object unless object.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['ifGenerationMatch'] = if_generation_match unless if_generation_match.nil?
  command.query['ifGenerationNotMatch'] = if_generation_not_match unless if_generation_not_match.nil?
  command.query['ifMetagenerationMatch'] = if_metageneration_match unless if_metageneration_match.nil?
  command.query['ifMetagenerationNotMatch'] = if_metageneration_not_match unless if_metageneration_not_match.nil?
  command.query['overrideUnlockedRetention'] = override_unlocked_retention unless override_unlocked_retention.nil?
  command.query['predefinedAcl'] = predefined_acl unless predefined_acl.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['userProject'] = user_project unless user_project.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

#update_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

Updates an ACL entry on the specified object.

Parameters:

bucket (String) —
Name of a bucket.
object (String) —
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
entity (String) —
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
object_access_control_object (Google::Apis::StorageV1::ObjectAccessControl) (defaults to: nil)
generation (Fixnum) (defaults to: nil) —
If present, selects a specific revision of this object (as opposed to the latest version, the default).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::ObjectAccessControl) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::ObjectAccessControl)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 2442

def update_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, user_project: 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::StorageV1::ObjectAccessControl::Representation
  command.request_object = object_access_control_object
  command.response_representation = Google::Apis::StorageV1::ObjectAccessControl::Representation
  command.response_class = Google::Apis::StorageV1::ObjectAccessControl
  command.params['bucket'] = bucket unless bucket.nil?
  command.params['object'] = object unless object.nil?
  command.params['entity'] = entity unless entity.nil?
  command.query['generation'] = generation unless generation.nil?
  command.query['userProject'] = user_project unless user_project.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

#update_project_hmac_key(project_id, access_id, hmac_key_metadata_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::HmacKeyMetadata`

Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.

Parameters:

project_id (String) —
Project ID owning the service account of the updated key.
access_id (String) —
Name of the HMAC key being updated.
hmac_key_metadata_object (Google::Apis::StorageV1::HmacKeyMetadata) (defaults to: nil)
user_project (String) (defaults to: nil) —
The project to be billed for this request.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::HmacKeyMetadata) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::HmacKeyMetadata)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 4036

def update_project_hmac_key(project_id, access_id, hmac_key_metadata_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'projects/{projectId}/hmacKeys/{accessId}', options)
  command.request_representation = Google::Apis::StorageV1::HmacKeyMetadata::Representation
  command.request_object = hmac_key_metadata_object
  command.response_representation = Google::Apis::StorageV1::HmacKeyMetadata::Representation
  command.response_class = Google::Apis::StorageV1::HmacKeyMetadata
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['accessId'] = access_id unless access_id.nil?
  command.query['userProject'] = user_project unless user_project.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

#watch_all_objects(bucket, channel_object = nil, delimiter: nil, end_offset: nil, include_trailing_delimiter: nil, max_results: nil, page_token: nil, prefix: nil, projection: nil, start_offset: nil, user_project: nil, versions: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Channel`

Watch for changes on all objects in a bucket.

Parameters:

bucket (String) —
Name of the bucket in which to look for objects.
channel_object (Google::Apis::StorageV1::Channel) (defaults to: nil)
delimiter (String) (defaults to: nil) —
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.
end_offset (String) (defaults to: nil) —
Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
include_trailing_delimiter (Boolean) (defaults to: nil) —
If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
max_results (Fixnum) (defaults to: nil) —
Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
page_token (String) (defaults to: nil) —
A previously-returned page token representing part of the larger set of results to view.
prefix (String) (defaults to: nil) —
Filter results to objects whose names begin with this prefix.
projection (String) (defaults to: nil) —
Set of properties to return. Defaults to noAcl.
start_offset (String) (defaults to: nil) —
Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
user_project (String) (defaults to: nil) —
The project to be billed for this request. Required for Requester Pays buckets.
versions (Boolean) (defaults to: nil) —
If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) (defaults to: nil) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::StorageV1::Channel) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::StorageV1::Channel)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/storage_v1/service.rb', line 3659

def watch_all_objects(bucket, channel_object = nil, delimiter: nil, end_offset: nil, include_trailing_delimiter: nil, max_results: nil, page_token: nil, prefix: nil, projection: nil, start_offset: nil, user_project: nil, versions: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'b/{bucket}/o/watch', options)
  command.request_representation = Google::Apis::StorageV1::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::StorageV1::Channel::Representation
  command.response_class = Google::Apis::StorageV1::Channel
  command.params['bucket'] = bucket unless bucket.nil?
  command.query['delimiter'] = delimiter unless delimiter.nil?
  command.query['endOffset'] = end_offset unless end_offset.nil?
  command.query['includeTrailingDelimiter'] = include_trailing_delimiter unless include_trailing_delimiter.nil?
  command.query['maxResults'] = 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['startOffset'] = start_offset unless start_offset.nil?
  command.query['userProject'] = user_project unless user_project.nil?
  command.query['versions'] = versions unless versions.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

Class: Google::Apis::StorageV1::StorageService

Overview

Examples:

Constant Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ StorageService

Instance Attribute Details

#key ⇒ String

#quota_user ⇒ String

#user_ip ⇒ String

Instance Method Details

#advance_relocate_bucket_operation(bucket, operation_id, advance_relocate_bucket_operation_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#bulk_restore_objects(bucket, bulk_restore_objects_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation

#cancel_bucket_operation(bucket, operation_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#create_project_hmac_key(project_id, service_account_email, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::HmacKey

#delete_bucket(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_bucket_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_default_object_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_folder(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_folder_recursive(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation

#delete_managed_folder(bucket, managed_folder, allow_non_empty: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_notification(bucket, notification, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_object(bucket, object, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_object_access_control(bucket, object, entity, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#delete_project_hmac_key(project_id, access_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#disable_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::AnywhereCache

#get_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::AnywhereCache

#get_bucket(bucket, generation: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, soft_deleted: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Bucket

#get_bucket_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::BucketAccessControl

#get_bucket_iam_policy(bucket, options_requested_policy_version: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Policy

#get_bucket_operation(bucket, operation_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation

#get_bucket_storage_layout(bucket, prefix: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::BucketStorageLayout

#get_default_object_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl

#get_folder(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Folder

#get_managed_folder(bucket, managed_folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ManagedFolder

#get_managed_folder_iam_policy(bucket, managed_folder, options_requested_policy_version: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Policy

#get_notification(bucket, notification, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Notification

#get_object_access_control(bucket, object, entity, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl

#get_object_iam_policy(bucket, object, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Policy

#get_project_hmac_key(project_id, access_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::HmacKeyMetadata

#get_project_service_account(project_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ServiceAccount

#insert_anywhere_cach(bucket, anywhere_cache_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation

#insert_bucket(project, bucket_object = nil, enable_object_retention: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Bucket

#insert_bucket_access_control(bucket, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::BucketAccessControl

#insert_default_object_access_control(bucket, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl

#insert_folder(bucket, folder_object = nil, recursive: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Folder

#insert_managed_folder(bucket, managed_folder_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ManagedFolder

#insert_notification(bucket, notification_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Notification

#insert_object_access_control(bucket, object, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl

#list_anywhere_caches(bucket, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::AnywhereCaches

#list_bucket_access_controls(bucket, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::BucketAccessControls

#list_bucket_operations(bucket, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningListOperationsResponse

#list_buckets(project, max_results: nil, page_token: nil, prefix: nil, projection: nil, return_partial_success: nil, soft_deleted: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Buckets

#list_default_object_access_controls(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControls

#list_folders(bucket, delimiter: nil, end_offset: nil, page_size: nil, page_token: nil, prefix: nil, start_offset: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Folders

#list_managed_folders(bucket, page_size: nil, page_token: nil, prefix: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ManagedFolders

#list_notifications(bucket, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Notifications

#list_object_access_controls(bucket, object, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControls

#list_project_hmac_keys(project_id, max_results: nil, page_token: nil, service_account_email: nil, show_deleted_keys: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::HmacKeysMetadata

#lock_bucket_retention_policy(bucket, if_metageneration_match, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Bucket

#patch_bucket_access_control(bucket, entity, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::BucketAccessControl

#patch_default_object_access_control(bucket, entity, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl

#patch_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl

#pause_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::AnywhereCache

#relocate_bucket(bucket, relocate_bucket_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation

#rename_folder(bucket, source_folder, destination_folder, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation

#restore_bucket(bucket, generation, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Bucket

#resume_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::AnywhereCache

#set_bucket_iam_policy(bucket, policy_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Policy

#set_managed_folder_iam_policy(bucket, managed_folder, policy_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Policy

#set_object_iam_policy(bucket, object, policy_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::Policy

#stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

#test_bucket_iam_permissions(bucket, permissions, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::TestIamPermissionsResponse

#test_managed_folder_iam_permissions(bucket, managed_folder, permissions, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::TestIamPermissionsResponse

#test_object_iam_permissions(bucket, object, permissions, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::TestIamPermissionsResponse

#update_anywhere_cach(bucket, anywhere_cache_id, anywhere_cache_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::GoogleLongrunningOperation

#update_bucket_access_control(bucket, entity, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::BucketAccessControl

#update_default_object_access_control(bucket, entity, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::StorageV1::ObjectAccessControl

#initialize ⇒ `StorageService`

#key ⇒ `String`

#quota_user ⇒ `String`

#user_ip ⇒ `String`

#bulk_restore_objects(bucket, bulk_restore_objects_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

#create_project_hmac_key(project_id, service_account_email, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::HmacKey`

#delete_folder_recursive(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

#disable_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::AnywhereCache`

#get_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::AnywhereCache`

#get_bucket(bucket, generation: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, projection: nil, soft_deleted: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Bucket`

#get_bucket_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::BucketAccessControl`

#get_bucket_iam_policy(bucket, options_requested_policy_version: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Policy`

#get_bucket_operation(bucket, operation_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

#get_bucket_storage_layout(bucket, prefix: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::BucketStorageLayout`

#get_default_object_access_control(bucket, entity, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

#get_folder(bucket, folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Folder`

#get_managed_folder(bucket, managed_folder, if_metageneration_match: nil, if_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ManagedFolder`

#get_managed_folder_iam_policy(bucket, managed_folder, options_requested_policy_version: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Policy`

#get_notification(bucket, notification, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Notification`

#get_object_access_control(bucket, object, entity, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

#get_object_iam_policy(bucket, object, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Policy`

#get_project_hmac_key(project_id, access_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::HmacKeyMetadata`

#get_project_service_account(project_id, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ServiceAccount`

#insert_anywhere_cach(bucket, anywhere_cache_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

#insert_bucket(project, bucket_object = nil, enable_object_retention: nil, predefined_acl: nil, predefined_default_object_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Bucket`

#insert_bucket_access_control(bucket, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::BucketAccessControl`

#insert_default_object_access_control(bucket, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

#insert_folder(bucket, folder_object = nil, recursive: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Folder`

#insert_managed_folder(bucket, managed_folder_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ManagedFolder`

#insert_notification(bucket, notification_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Notification`

#insert_object_access_control(bucket, object, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

#list_anywhere_caches(bucket, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::AnywhereCaches`

#list_bucket_access_controls(bucket, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::BucketAccessControls`

#list_bucket_operations(bucket, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningListOperationsResponse`

#list_buckets(project, max_results: nil, page_token: nil, prefix: nil, projection: nil, return_partial_success: nil, soft_deleted: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Buckets`

#list_default_object_access_controls(bucket, if_metageneration_match: nil, if_metageneration_not_match: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControls`

#list_folders(bucket, delimiter: nil, end_offset: nil, page_size: nil, page_token: nil, prefix: nil, start_offset: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Folders`

#list_managed_folders(bucket, page_size: nil, page_token: nil, prefix: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ManagedFolders`

#list_notifications(bucket, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Notifications`

#list_object_access_controls(bucket, object, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControls`

#list_project_hmac_keys(project_id, max_results: nil, page_token: nil, service_account_email: nil, show_deleted_keys: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::HmacKeysMetadata`

#lock_bucket_retention_policy(bucket, if_metageneration_match, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Bucket`

#patch_bucket_access_control(bucket, entity, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::BucketAccessControl`

#patch_default_object_access_control(bucket, entity, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

#patch_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

#pause_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::AnywhereCache`

#relocate_bucket(bucket, relocate_bucket_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

#rename_folder(bucket, source_folder, destination_folder, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

#restore_bucket(bucket, generation, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Bucket`

#resume_anywhere_cach(bucket, anywhere_cache_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::AnywhereCache`

#set_bucket_iam_policy(bucket, policy_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Policy`

#set_managed_folder_iam_policy(bucket, managed_folder, policy_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Policy`

#set_object_iam_policy(bucket, object, policy_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::Policy`

#test_bucket_iam_permissions(bucket, permissions, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::TestIamPermissionsResponse`

#test_managed_folder_iam_permissions(bucket, managed_folder, permissions, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::TestIamPermissionsResponse`

#test_object_iam_permissions(bucket, object, permissions, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::TestIamPermissionsResponse`

#update_anywhere_cach(bucket, anywhere_cache_id, anywhere_cache_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::GoogleLongrunningOperation`

#update_bucket_access_control(bucket, entity, bucket_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::BucketAccessControl`

#update_default_object_access_control(bucket, entity, object_access_control_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

#update_object_access_control(bucket, object, entity, object_access_control_object = nil, generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::ObjectAccessControl`

#update_project_hmac_key(project_id, access_id, hmac_key_metadata_object = nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::StorageV1::HmacKeyMetadata`