SrSSKJr SSKJr SSKJr SSKrSSKJr "SS\R5r "S S \R5r "S S \R5r "S S\R5r "SS\R5r "SS\R5r"SS\R5r"SS\R5r\R"R$rSr"SS\5rg)z;API interface for interacting with cloud storage providers.)absolute_import)division)unicode_literalsN) storage_urlc@\rSrSrSrSrSrSrSrSr Sr S r S r S r S rS rg) Capabilityz:Used to track API capabilities relevant to logic in tasks.COMPOSE_OBJECTSCLIENT_SIDE_HASH_VALIDATION ENCRYPTIONMANAGED_FOLDERSFOLDERSSTORAGE_LAYOUTRESUMABLE_UPLOADSLICED_DOWNLOADAPPENDABLE_UPLOAD"DAISY_CHAIN_SEEKABLE_UPLOAD_STREAMN)__name__ __module__ __qualname____firstlineno____doc__r r r r rrrrrr__static_attributes__r/lib/googlecloudsdk/api_lib/storage/cloud_api.pyrrs>B%/ =*%/ '#.'%/)(L$rrc$\rSrSrSrSrSrSrSrg)DownloadStrategy4z,Enum class for specifying download strategy.oneshotretriable_in_flight resumablerN) rrrrrONE_SHOTRETRIABLE_IN_FLIGHT RESUMABLErrrrrr4s4 (-)rrc(\rSrSrSrSrSrSrSrSr g) UploadStrategy>z*Enum class for specifying upload strategy.simpler" streaming appendablerN) rrrrrSIMPLEr% STREAMING APPENDABLErrrrr'r'>s2 &))*rr'c(\rSrSrSrSrSrSrSrSr g) FieldsScopeFzDValues used to determine fields and projection values for API calls.rN) rrrrrFULLNO_ACLRSYNCSHORTrrrrr0r0FsL $ & % %rr0c\rSrSrSrSrSrg) HmacKeyStateOACTIVEINACTIVErN)rrrrr=r>rrrrr;r;Os & (rr;c(\rSrSrSrSrSrSrSrSr g) NotificationEventTypeTzDUsed to filter what events a notification configuration notifies on.OBJECT_ARCHIVE OBJECT_DELETEOBJECT_FINALIZEOBJECT_METADATA_UPDATErN) rrrrrrBrCrDrErrrrr@r@TsL#.!-%/3rr@c \rSrSrSrSrSrSrg)NotificationPayloadFormat\z)Used to format the body of notifications.jsonnonerN)rrrrrJSONNONErrrrrGrG\s1 $ $rrGc$\rSrSrSrSrSrSrSrg) ObjectStatebzDFor whether to operate on live, noncurrent, or soft-deleted objects.livezlive-and-noncurrentz soft-deletedrN) rrrrrLIVELIVE_AND_NONCURRENT SOFT_DELETEDrrrrrNrNbsL $-,rrNic\rSrSrSr\"5rSrSrSBSjr Sr Sr S r S r S rSBS jrSCS jrSrSDSjrSrSESjrSrSrSCSjrSrSrSrSrSESjrSrSBSjrSDSjrSr SS\!RDSSS4S jr#SCS!jr$SFS"jr%SSSS#SS\&RNS4S$jr(SGS%jr)SCS&jr*SSSS\+RX4S'jr-S(r.S)r/S*r0S+r1SCS,jr2S-r3SHS.jr4S/r5S0r6SCS1jr7S2r8SBS3jr9SSS\:Rv4S4jrS7r?SCS8jr@S9rAS:rBSCS;jrCS<rDS=rESIS>jrFS?rGS@rHSArIg)JCloudApinaAbstract base class for interacting with cloud storage providers. Implementations of the Cloud API are not guaranteed to be thread-safe. Behavior when calling a Cloud API instance simultaneously across threads is undefined and doing so will likely cause errors. Therefore, a separate instance of the Cloud API should be instantiated per-thread. Attributes: capabilities (set[Capability]): If a Capability is present in this set, this API can be used to execute related logic in tasks. r2iNc[S5e)aCreates Anywhere Cache for given bucket. Args: bucket_name (str): The name of the bucket where the Anywhere Cache should be created. zone (str): Name of the zonal locations where the Anywhere Cache should be created. admission_policy (str|None): The cache admission policy decides for each cache miss, that is whether to insert the missed block or not. ttl (str|None): Cache entry time-to-live in seconds Returns: GoogleLongrunningOperation Apitools object for creating caches. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z)create_anywhere_cache must be overridden.NotImplementedError)self bucket_namezoneadmission_policyttls rcreate_anywhere_cacheCloudApi.create_anywhere_caches, I JJrc[S5e)azGets Anywhere Cache Instance for a zone in bucket. Args: bucket_name (str): The name of the bucket. anywhere_cache_id (str): Unique identifier for a cache instance in bucket. Returns: AnywhereCache: the Anywhere Cache Instance Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z&get_anywhere_cache must be overridden.rXrZr[anywhere_cache_ids rget_anywhere_cacheCloudApi.get_anywhere_cache F GGrc[S5e)aEPauses Anywhere Cache Instance for a zone in bucket. Args: bucket_name (str): The name of the bucket. anywhere_cache_id (str): Unique identifier for a cache instance in bucket. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z(pause_anywhere_cache must be overridden.rXrbs rpause_anywhere_cacheCloudApi.pause_anywhere_caches H IIrc[S5e)avResumes Anywhere Cache in particular zone of a bucket. Args: bucket_name (str): The name of the bucket where the Anywhere Cache should be resumed. anywhere_cache_id (str): Unique identifier for a cache instance in bucket. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z)resume_anywhere_cache must be overridden.rXrbs rresume_anywhere_cacheCloudApi.resume_anywhere_caches I JJrc[S5e)axDisables Anywhere Cache in particular zone of a bucket. Args: bucket_name (str): The name of the bucket where the Anywhere Cache should be disabled. anywhere_cache_id (str): Unique identifier for a cache instance in bucket. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z*disable_anywhere_cache must be overridden.rXrbs rdisable_anywhere_cacheCloudApi.disable_anywhere_caches J KKrc[S5e)aGLists all Anywhere Cache instances of the bucket. Args: bucket_name (str): The name of the bucket. Yields: Iterator over gcs_resource_reference.GcsAnywhereCacheResource objects. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z'list_anywhere_cache must be overridden.rXrZr[s rlist_anywhere_cachesCloudApi.list_anywhere_cachess G HHrc[S5e)a|Updates Anywhere Cache instance of a bucket. Args: bucket_name (str): The name of the bucket where the Anywhere Cache should be updated. anywhere_cache_id (str): Unique identifier for a cache instance in bucket. admission_policy (str|None): The cache admission policy decides for each cache miss, that is whether to insert the missed block or not. ttl (str|None): Cache entry time-to-live in seconds Returns: GoogleLongrunningOperation Apitools object for creating caches. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z(patch_anywhere_cache must be overridden.rX)rZr[rcr]r^s rpatch_anywhere_cacheCloudApi.patch_anywhere_caches* H IIrc[S5e)a#Creates a new bucket with the specified metadata. Args: bucket_resource (resource_reference.UnknownResource): The bucket to create. request_config (RequestConfig): Contains metadata for new bucket. fields_scope (FieldsScope): Determines the fields and projection parameters of API call. Raises: CloudApiError: API returned an error. Error: Invalid fields_scope. NotImplementedError: This function was not implemented by a class using this interface. Returns: resource_reference.BucketResource representing new bucket. z!create_bucket must be overridden.rXrZbucket_resourcerequest_config fields_scopes r create_bucketCloudApi.create_bucket& A BBrc[S5e)ajDeletes a bucket. Args: bucket_name (str): Name of the bucket to delete. request_config (RequestConfig): Object containing general API function arguments. Subclasses for specific cloud providers are available. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z!delete_bucket must be overridden.rX)rZr[rzs r delete_bucketCloudApi.delete_bucket A BBrFc[S5e)a(Gets bucket metadata. Args: bucket_name (str): Name of the bucket. generation (int|None): Generation of the bucket. fields_scope (FieldsScope): Determines the fields and projection parameters of API call. soft_deleted (bool): If true, return the soft-deleted version of this bucket. Returns: resource_reference.BucketResource containing the bucket metadata. Raises: CloudApiError: API returned an error. Error: Invalid fields_scope. NotImplementedError: This function was not implemented by a class using this interface. zget_bucket must be overridden.rX)rZr[ generationr{ soft_deleteds r get_bucketCloudApi.get_bucket(s, > ??rc[S5e)aGets bucket IAM policy. Args: bucket_name (str): Name of the bucket. Returns: Provider-specific data type. Currently, only available for GCS so returns Apitools messages.Policy object. If supported for more providers in the future, use a generic container. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. )get_bucket_iam_policy must be overridden.rXrqs rget_bucket_iam_policyCloudApi.get_bucket_iam_policy@s I JJrc[S5e)a Lists bucket metadata for the given project. Args: fields_scope (FieldsScope): Determines the fields and projection parameters of API call. soft_deleted (bool): If true, only soft-deleted bucket versions will be returned. prefix (str): If provided, only buckets with the given prefix will be returned. Yields: Iterator over resource_reference.BucketResource objects Raises: Error: Invalid fields_scope. NotImplementedError: This function was not implemented by a class using this interface. z list_buckets must be overridden.rX)rZr{rprefixs r list_bucketsCloudApi.list_bucketsRs& @ AArc[S5e)a7Relocates a bucket between different locations. Args: bucket_name (str): Name of the bucket. destination_location (str): The new location the bucket will be relocated to. destination_custom_placement_config (list[str]): The bucket's new custom placement configuration if relocating to a Custom Dual Region. validate_only (bool): If true, validate the operation, but do not actually relocate the bucket. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z#relocate_bucket must be overridden.rX)rZr[destination_location#destination_custom_placement_config validate_onlys rrelocate_bucketCloudApi.relocate_bucketgs. C DDrc[S5e)aLocks a bucket's retention policy. Args: bucket_resource (UnknownResource): The bucket with the policy to lock. request_config (RequestConfig): Object containing general API function arguments. Subclasses for specific cloud providers are available. Returns: resource_reference.BucketResource containing the bucket metadata. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z0lock_bucket_retention_policy must be overridden.rX)rZryrzs rlock_bucket_retention_policy%CloudApi.lock_bucket_retention_policys : < ??rc[S5e)axDeletes an object. Args: object_url (storage_url.CloudUrl): Url of object to delete. request_config (RequestConfig): Object containing general API function arguments. Subclasses for specific cloud providers are available. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z!delete_object must be overridden.rX)rZ object_urlrzs r delete_objectCloudApi.delete_object]rrrc [S5e)aGets object data. Args: cloud_resource (resource_reference.ObjectResource): Contains metadata and information about object being downloaded. download_stream (stream): Stream to send the object data to. request_config (RequestConfig): Contains arguments for API calls. digesters (dict): Dict of {string : digester}, where string is the name of a hash algorithm, and digester is a validation digester object that update(bytes) and digest() using that algorithm. Implementation can set the digester value to None to indicate supports bytes were not successfully digested on-the-fly. do_not_decompress (bool): If true, gzipped objects will not be decompressed on-the-fly if supported by the API. download_strategy (DownloadStrategy): Cloud API download strategy to use for download. progress_callback (function): Optional callback function for progress notifications. Receives calls with arguments (bytes_transferred, total_size). start_byte (int): Starting point for download (for resumable downloads and range requests). Can be set to negative to request a range of bytes (python equivalent of [:-3]). end_byte (int): Ending byte number, inclusive, for download (for range requests). If None, download the rest of the object. Returns: server_encoding (str): Useful for determining what the server actually sent versus what object metadata claims. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z#download_object must be overridden.rX) rZcloud_resourcedownload_streamrz digestersdo_not_decompressdownload_strategyr start_byteend_bytes rdownload_objectCloudApi.download_objectlsX C DDrc[S5e)aGets object IAM policy. Args: bucket_name (str): Name of the bucket. object_name (str): Name of the object. generation (str|None): Generation of object. Returns: Provider-specific data type. Currently, only available for GCS so returns Apitools messages.Policy object. If supported for more providers in the future, use a generic container. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z)get_object_iam_policy must be overridden.rX)rZr[ object_namers rget_object_iam_policyCloudApi.get_object_iam_policys$ I JJrc[S5e)aGets object metadata. If decryption is supported by the implementing class, this function will read decryption keys from configuration and appropriately retry requests to encrypted objects with the correct key. Args: bucket_name (str): Bucket containing the object. object_name (str): Object name. request_config (RequestConfig): Contains API call arguments. generation (string): Generation of the object to retrieve. fields_scope (FieldsScope): Determines the fields and projection parameters of API call. soft_deleted (bool): Returns the soft-deleted version of an object (not the live version or a past version in a bucket with versioning enabled). Returns: resource_reference.ObjectResource with object metadata. Raises: CloudApiError: API returned an error. Error: Invalid fields_scope. NotImplementedError: This function was not implemented by a class using this interface. NotFoundError: Raised if object does not exist. z'get_object_metadata must be overridden.rX)rZr[rrzrr{rs rget_object_metadataCloudApi.get_object_metadatasF G HHrTc [S5e)aLists objects (with metadata) and prefixes in a bucket. Args: bucket_name (str): Bucket containing the objects. prefix (str|None): Prefix for directory-like behavior. delimiter (str|None): Delimiter for directory-like behavior. fields_scope (FieldsScope): Determines the fields and projection parameters of API call. halt_on_empty_response (bool): For features like soft delete, the API may return an empty list and a next page token. If true, print a warning instead of using the next page token. See the warning text details. include_folders_as_prefixes (bool): If True, includes managed folders as prefixes in list responses. This means that managed folders that don't contain objects will be listed. next_page_token (str|None): Used to resume LIST calls. For example, if halt_on_empty_response was true and a halt warning is printed, it will contain a next_page_token the user can use to resume querying. object_state (ObjectState): What versions of an object to query. list_filter (str|None): If provided, objects with matching filters will be returned, The prefixes would still be returned regardless of whether they match the specified filter, See go/gcs-object-context-filtering for more details. Yields: Iterator over resource_reference.ObjectResource objects. Raises: Error: Invalid fields_scope. NotImplementedError: This function was not implemented by a class using this interface. z list_objects must be overridden.rX) rZr[r delimiterr{halt_on_empty_responseinclude_folders_as_prefixesnext_page_token object_state list_filters r list_objectsCloudApi.list_objectssV @ AArc[S5e)aUpdates object metadata with patch semantics. Args: bucket_name (str): Bucket containing the object. object_name (str): Object name. object_resource (resource_reference.ObjectResource): Contains metadata that will be used to update cloud object. May have different name than object_name argument. request_config (RequestConfig): Object containing general API function arguments. Subclasses for specific cloud providers are available. fields_scope (FieldsScope): Determines the fields and projection parameters of API call. generation (string): Generation (or version) of the object to update. posix_to_set (PosixAttributes|None): Set as custom metadata on target. Returns: resource_reference.ObjectResource with patched object metadata. Raises: CloudApiError: API returned an error. Error: Invalid fields_scope. NotImplementedError: This function was not implemented by a class using this interface. z)patch_object_metadata must be overridden.rX)rZr[robject_resourcerzr{rrs rpatch_object_metadataCloudApi.patch_object_metadatasD I JJrc[S5e)aSets object IAM policy. Args: bucket_name (str): Name of the bucket. object_name (str): Name of the object. policy (object): Provider-specific data type. Currently, only available for GCS so Apitools messages.Policy object. If supported for more providers in the future, use a generic container. generation (str|None): Generation of object. Returns: Provider-specific data type. Currently, only available for GCS so returns Apitools messages.Policy object. If supported for more providers in the future, use a generic container. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z)set_bucket_iam_policy must be overridden.rX)rZr[rrrs rset_object_iam_policyCloudApi.set_object_iam_policy$s2 I JJrc [S5e)aoUploads object data and metadata. Args: source_stream (stream): Seekable stream of object data. destination_resource (resource_reference.ObjectResource|UnknownResource): Contains the correct metadata to upload. request_config (RequestConfig): Object containing general API function arguments. Subclasses for specific cloud providers are available. posix_to_set (PosixAttributes|None): Set as custom metadata on target. serialization_data (dict): API-specific data needed to resume an upload. Only used with UploadStrategy.RESUMABLE. source_resource (resource_reference.FileObjectResource|None): Contains the source StorageUrl. Can be None if source is pure stream. tracker_callback (Callable[[dict]|None]): Function that writes a tracker file with serialization data. Only used with UploadStrategy.RESUMABLE. upload_strategy (UploadStrategy): Strategy to use for this upload. Returns: resource_reference.ObjectResource with uploaded object's metadata. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z!upload_object must be overridden.rX) rZ source_streamrrzrserialization_datartracker_callbackupload_strategys r upload_objectCloudApi.upload_object?sH A BBrc[S5e)aCreates a managed folder. Args: bucket_name (str): The bucket to create the managed folder in. managed_folder_name (str): The name of the managed folder to create. Returns: A resource_reference.ManagedFolderResource for the new managed folder. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z)create_managed_folder must be overridden.rXrZr[managed_folder_names rcreate_managed_folderCloudApi.create_managed_folderes I JJrc[S5e)a@Deletes a managed folder. Args: bucket_name (str): The bucket containing the managed folder to delete. managed_folder_name (str): The name of the managed folder to delete. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z)delete_managed_folder must be overridden.rXrs rdelete_managed_folderCloudApi.delete_managed_foldervs I JJrc[S5e)a|Gets metadata for a managed folder. Args: bucket_name (str): The bucket containing the managed folder to get. managed_folder_name (str): The name of the managed folder to get. Returns: A resource_reference.ManagedFolderResource. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z&get_managed_folder must be overridden.rXrs rget_managed_folderCloudApi.get_managed_folderrfrc[S5e)aGets the IAM policy for a managed folder. Args: bucket_name (str): The bucket containing the managed folder to get the IAM policy for. managed_folder_name (str): The name of the managed folder to get the IAM policy for. Returns: An Apitools message.Policy object. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z1get_managed_folder_iam_policy must be overridden.rXrs rget_managed_folder_iam_policy&CloudApi.get_managed_folder_iam_policys" ; rc[S5e)aLists managed folders in a bucket. Args: bucket_name (str): The bucket to list managed folders in. prefix (str|None): Only managed folders beginning with `prefix` are listed if specified. Yields: resource_reference.ManagedFolderResources Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z(list_managed_folders must be overridden.rXrZr[rs rlist_managed_foldersCloudApi.list_managed_folderss H IIrc[S5e)aSets the IAM policy for a managed folder. Args: bucket_name (str): The bucket containing the managed folder to get the IAM policy for. managed_folder_name (str): The name of the managed folder to get the IAM policy for. policy (object): Provider-specific data type. Currently, only available for GCS so Apitools messages.Policy object. If supported for more providers in the future, use a generic container. Returns: Provider-specific data type. Currently, only available for GCS so returns Apitools messages.Policy object. If supported for more providers in the future, use a generic container. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z1set_managed_folder_iam_policy must be overridden.rX)rZr[rrs rset_managed_folder_iam_policy&CloudApi.set_managed_folder_iam_policys0 ; rc[S5e)aCreates a folder. Args: bucket_name (str): The bucket to create the folder in. folder_name (str): The name of the folder to create. is_recursive (bool): Whether to create all folders in a given path if they do not exist. Returns: A resource_reference.FolderResource for the new folder. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z!create_folder must be overridden.rX)rZr[ folder_name is_recursives r create_folderCloudApi.create_folders" A BBrc[S5e)a Deletes a folder. Args: bucket_name (str): The bucket containing the folder to delete. folder_name (str): The name of the folder to delete. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z!delete_folder must be overridden.rXrZr[rs r delete_folderCloudApi.delete_folders A BBrc[S5e)aUGets metadata for a folder. Args: bucket_name (str): The bucket containing the folder to get. folder_name (str): The name of the folder to get. Returns: A resource_reference.FolderResource. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. zget_folder must be overridden.rXr s r get_folderCloudApi.get_folders > ??rc[S5e)ajLists folders in a bucket. Args: bucket_name (str): The bucket to list folders in. prefix (str|None): Only folders beginning with `prefix` are listed if specified. Yields: resource_reference.FolderResources Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z list_folders must be overridden.rXrs r list_foldersCloudApi.list_folders rrc[S5e)aRenames a folder to a specified destination folder name in a bucket. Args: bucket_name (str): The bucket to list folders in. source_folder_name (str): Name of the folder which needs to be renamed. destination_folder_name (str): Name of the folder to which the source folder needs to be renamed. Returns: GoogleLongrunningOperation Apitools object for renaming folders. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z!rename_folder must be overridden.rX)rZr[source_folder_namedestination_folder_names r rename_folderCloudApi.rename_folderr~rc[S5e)aHReturns the email address (str) used to identify the service agent. For some providers, the service agent is responsible for encrypting and decrypting objects using CMEKs. project_number is useful because it may be in bucket metadata when project ID is not. If neither project_id or project_number are available, uses the default project configured in gcloud. Args: project_id (str|None): Project to get service account for. Takes precedence over project_number. project_number (int|None): Project to get service account for. Returns: Email of service account (str). z%get_service_agent must be overridden.rX)rZ project_idproject_numbers rget_service_agentCloudApi.get_service_agent1s& E FFrc[S5e)aUCreates a new notification on a bucket with the specified parameters. Args: url (storage_url.CloudUrl): Bucket URL. pubsub_topic (str): Cloud Pub/Sub topic to publish to. custom_attributes (dict[str, str]|None): Dictionary of custom attributes to apply to all notifications sent by the new configuration. event_types (list[NotificationEventType]|None): Event type filters, e.g. 'OBJECT_FINALIZE'. object_name_prefix (str|None): Filter on object name. payload_format (NotificationPayloadFormat): Format of body of notifications sent by the new configuration. Raises: CloudApiError: API returned an error. InvalidUrlError: Received a non-bucket URL. NotImplementedError: This function was not implemented by a class using this interface. Returns: Apitools Notification object for the new notification configuration. z5create_notification_configuration must be overridden.rX)rZurl pubsub_topiccustom_attributes event_typesobject_name_prefixpayload_formats r!create_notification_configuration*CloudApi.create_notification_configurationFs< ? AArc[S5e)aaDeletes a notification configuration on a bucket. Args: url (storage_url.CloudUrl): Bucket URL. notification_id (str): Name of the notification configuration. Raises: CloudApiError: API returned an error. InvalidUrlError: Received a non-bucket URL. NotImplementedError: This function was not implemented by a class using this interface. z5delete_notification_configuration must be overridden.rXrZrnotification_ids r!delete_notification_configuration*CloudApi.delete_notification_configurationgs ? AArc[S5e)a^Gets a notification configuration on a bucket. Args: url (storage_url.CloudUrl): Bucket URL. notification_id (str): Name of the notification configuration. Raises: CloudApiError: API returned an error. InvalidUrlError: Received a non-bucket URL. NotImplementedError: This function was not implemented by a class using this interface. z2get_notification_configuration must be overridden.rXr(s rget_notification_configuration'CloudApi.get_notification_configurationws < >>rc[S5e)aPLists notification configurations on a bucket. Args: url (storage_url.CloudUrl): Bucket URL. Raises: CloudApiError: API returned an error. InvalidUrlError: Received a non-bucket URL. NotImplementedError: This function was not implemented by a class using this interface. Yields: List of apitools Notification objects. z4list_notification_configurations must be overridden.rXrZrs r list_notification_configurations)CloudApi.list_notification_configurationss > @@rc[S5e)a3Advances a bucket relocation operation, by applying write lock. Args: bucket_name (str): Name of the bucket to advance the relocate for. operation_id (str): ID of the operation resource. ttl (int | None): Specifies the duration in int seconds, after which the relocation will revert to the sync stage if the relocation hasn't succeeded. Optional, if not supplied, a default value of 12h will be used. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. z+advance_relocate_bucket must be overridden.rX)rZr[ operation_idr^s radvance_relocate_bucket CloudApi.advance_relocate_buckets K LLrc[S5e)aCancels a long-running operation if it's still running. Args: bucket_name (str): Bucket associated with operation. operation_id (str): Operation to cancel. Raises: CloudApiError: API returned an error. NotImplementedError: Function not implemented by child class. z$cancel_operation must be overridden.rXrZr[r4s rcancel_operationCloudApi.cancel_operations D EErc[S5e)aFReturns metadata of a long-running operation. Args: bucket_name (str): Bucket associated with operation. operation_id (str): Operation to fetch. Raises: CloudApiError: API returned an error. NotImplementedError: Function not implemented by child class. Returns: Apitools Operation object (currently Google-only). z!get_operation must be overridden.rXr8s r get_operationCloudApi.get_operations A BBrc[S5e)aULists long-running operations. Args: bucket_name (str): Bucket associated with target operations. server_side_filter: (str|None): Filter operations on backend. Raises: CloudApiError: API returned an error. NotImplementedError: Function not implemented by child class. Yields: Apitools Operation objects (currently Google-only). z#list_operations must be overridden.rX)rZr[server_side_filters rlist_operationsCloudApi.list_operationsrrc[S5e)aRestores soft-deleted object. Args: url (storage_url.CloudUrl): Object URL. request_config (RequestConfig): Contains preconditions for API requests. Raises: CloudApiError: API returned an error. InvalidUrlError: Received invalid object URL. NotImplementedError: This function was not implemented by a class using this interface. Returns: ObjectResource of restored resource. z"restore_object must be overridden.rX)rZrrzs rrestore_objectCloudApi.restore_objects B CCrc[S5e)aQRestores a soft-deleted bucket. Args: url (storage_url.CloudUrl): Bucket URL with generation. Raises: CloudApiError: API returned an error. InvalidUrlError: Received invalid Bucket URL. NotImplementedError: This function was not implemented by a class using this interface. Returns: BucketResource of restored resource. z"restore_bucket must be overridden.rXr0s rrestore_bucketCloudApi.restore_buckets B CCrc [S5e)a Initiates long-running operation to restore soft-deleted objects. Args: bucket_url (StorageUrl): Launch a bulk restore operation for this bucket. object_globs (list[str]): Objects in the target bucket matching these glob patterns will be restored. request_config (RequestConfig): Contains preconditions for API requests. allow_overwrite (bool): Allow overwriting live objects with soft-deleted versions. created_after_time (datetime|None): Restore only objects created after this time. created_before_time (datetime|None): Restore only objects created before this time. deleted_after_time (datetime|None): Restore only objects soft-deleted after this time. deleted_before_time (datetime|None): Restore only objects soft-deleted before this time. Raises: CloudApiError: API returned an error. InvalidUrlError: Received invalid object URL. NotImplementedError: This function was not implemented by a class using this interface. Returns: GoogleLongrunningOperation Apitools object for restoring objects. z'bulk_restore_object must be overridden.rX) rZ bucket_url object_globsrzallow_overwritecreated_after_timecreated_before_timedeleted_after_timedeleted_before_times rbulk_restore_objectsCloudApi.bulk_restore_objectssL G HHrc[S5e)aReturns the storage layout configuration for the specified bucket. Note that this operation requires storage.objects.list permission. Args: bucket_name (str): Name of the Bucket for which we need layout configuration details. Raises: CloudApiError: API returned an error. NotImplementedError: This function was not implemented by a class using this interface. Returns: apitools BucketStorageLayout object. z&get_storage_layout must be overridden.rXrqs rget_storage_layoutCloudApi.get_storage_layout#s" F GGrc[S5e)zWaits for the given google.longrunning.Operation to complete. Args: operation_ref: The operation to poll. Returns: The Operation once it completes. Raises: apitools.base.py.HttpError: if the request returns an HTTP error. z&wait_for_operation must be overridden.rX)rZ operation_refs rwait_for_operationCloudApi.wait_for_operation6s F GGrr)NN)N)NNF)NFN)NNNF)NNN)F)FNNNN)Jrrrrrset capabilitiesMAX_OBJECTS_PER_COMPOSE_CALLMAX_OBJECT_NAME_LENGTHr_rdrhrkrnrrrur|rrrrrrrrrrrrrrrrrr#rrrrNrQrrrr'r,rrrrrrrrr rrrrrGrKr%r*r-r1r5r9r<r@rCrFrPrSrWrrrrrUrUns9 , "#  ;?K0H"J K LI"HLJ.C* C KP@0K$B*E2<&B(K*E$E B$JO"& *D2 $ DJ %"@H C&!%(-(8(A(A(,!"#,E\K0#IP!"&##+Bf"KP(, K@$++$CLK" KH"*J$8C& C@"B$C*G2.33ABA > @$M$ FC E D$D,&IPH& HrrU)r __future__rrrenum"googlecloudsdk.command_lib.storagerEnumrrr'r0r;r@rGrNProviderPrefixGCSDEFAULT_PROVIDERNUM_ITEMS_PER_LIST_PAGEobjectrUrrrrfsB'' :LL0tyyTYY $)) 499 4DII4   $)) --11THvTHr