File manager - Edit - /opt/gsutil/gslib/__pycache__/cloud_api.cpython-39.pyc
Back
a +(Wgޣ � @ s\ d Z ddlmZ ddlmZ ddlmZ G dd� de�ZG dd� de�ZG d d � d e�Z G d d � d e�Z G d d� de �Z G dd� de�Z G dd� de �Z G dd� de �ZG dd� de �ZG dd� de �ZG dd� de �ZG dd � d e �ZG d d � d e �ZG d d � d e �ZG d!d"� d"e�ZG d#d$� d$e �ZG d%d&� d&e �ZG d'd(� d(e �ZG d)d*� d*e �Zd+S ),z8Gsutil API for interacting with cloud storage providers.� )�absolute_import)�division)�unicode_literalsc @ s� e Zd ZdZdQdd�Zdd� ZdRdd �ZdSd d �ZdTd d �Zdd� Z dUdd�Z dVdd�Z dWdd�Z dXdd�Z dYdd�ZG dd� de�ZG d d � d e�ZdZd d �Zd[d d!�Zd\d"d#�Zd]d$d%�Zd^d&d'�ZG d(d)� d)e�Zdddd*ejddddddf d+d,�Zd_d-d.�Zd`d/d0�Zdad1d2�Z dbd3d4�Z dcd5d6�Z ddd7d8�Z ded9d:�Z dfd;d<�Z!dgd=d>�Z"dhd?d@�Z#didAdB�Z$djdCdD�Z%dkdEdF�Z&dGdH� Z'dIdJ� Z(dKdL� Z)dldMdN�Z*dOdP� Z+dS )m�CloudApiay Abstract base class for interacting with cloud storage providers. Implementations of the gsutil Cloud API are not guaranteed to be thread-safe. Behavior when calling a gsutil Cloud API instance simultaneously across threads is undefined and doing so will likely cause errors. Therefore, a separate instance of the gsutil Cloud API should be instantiated per-thread. Nr c C s: || _ || _|| _|| _|| _|| _|| _|| _| | _dS )aF Performs necessary setup for interacting with the cloud storage provider. Args: bucket_storage_uri_class: boto storage_uri class, used by APIs that provide boto translation or mocking. logger: logging.logger for outputting log messages. status_queue: Queue for relaying status to UI. provider: Default provider prefix describing cloud storage provider to connect to. debug: Debug level for the API implementation (0..3). http_headers (dict|None): Arbitrary headers to be included in every request. trace_token: Google internal trace token to pass to the API implementation (string). perf_trace_token: Performance trace token to use when making API calls. user_project: Project to be billed for this request. N) �bucket_storage_uri_class�logger� status_queue�provider�debug� http_headers� trace_token�perf_trace_token� user_project) �selfr r r r r r r r r � r � /opt/gsutil/gslib/cloud_api.py�__init__ s zCloudApi.__init__c C s t d��dS )z%Returns the service account email id.z'GetServiceAccountId must be overridden.N��NotImplementedError�r r r r �GetServiceAccountIdC s z CloudApi.GetServiceAccountIdc C s t d��dS )a� Gets Bucket metadata. Args: bucket_name: Name of the bucket. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these Bucket metadata fields, for example, ['logging', 'defaultObjectAcl'] Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Bucket object. z GetBucket must be overloadedNr �r � bucket_namer �fieldsr r r � GetBucketG s zCloudApi.GetBucketc C s t d��dS )a� Returns an IAM policy for the specified Bucket. Args: bucket_name: Name of the bucket. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only the IAM policy fields specified. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with the cloud storage providers. Returns: Policy object of the bucket. z%GetBucketIamPolicy must be overloadedNr r r r r �GetBucketIamPolicyZ s zCloudApi.GetBucketIamPolicyc C s t d��dS )a� Sets an IAM policy for the specified Bucket. Args: bucket_name: Name of the bucket. policy: A Policy object describing the IAM policy. provider: Cloud storage provider to connect to. If not present, class-wide default is used. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with the cloud storage providers. Returns: Policy object of the bucket. May differ from input Policy. z%SetBucketIamPolicy must be overloadedNr )r r �policyr r r r �SetBucketIamPolicyl s zCloudApi.SetBucketIamPolicyc C s t d��dS )aW Sign a url using service account's system managed private key. Args: method: The HTTP method to be used with the signed URL. duration: timedelta for which the constructed signed URL should be valid. path: String path to the bucket or object for signing, in the form 'bucket' or 'bucket/object'. generation: If not None, specifies a version of an object for signing. logger: logging.Logger for warning and debug output. region: Geographic region in which the requested resource resides. signed_headers: Dict containing the header info like host content-type etc. string_to_sign_debug: If true AND logger is enabled for debug level, print string to sign to debug. Used to differentiate user's signed URL from the probing permissions-check signed URL. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. CommandException for errors because of invalid account used for signing. Returns: The signed url. zSignUrl must be overloadedNr ) r �methodZduration�path� generationr �region�signed_headersZstring_to_sign_debugr r r �SignUrl~ s zCloudApi.SignUrlc C s t d��dS )a� Lists bucket metadata for the given project. Args: project_id: Project owning the buckets, default from config if None. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these metadata fields for the listing, for example: ['items/logging', 'items/defaultObjectAcl']. Note that the WildcardIterator class should be used to list buckets instead of calling this function directly. It amends the fields definition from get-like syntax such as ['logging', 'defaultObjectAcl'] so that the caller does not need to prepend 'items/' or specify fields necessary for listing (like nextPageToken). Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Iterator over Bucket objects. z ListBuckets must be overloadedNr )r � project_idr r r r r � ListBuckets� s zCloudApi.ListBucketsc C s t d��dS )a� Updates bucket metadata for the bucket with patch semantics. Args: bucket_name: Name of bucket to update. metadata: Bucket object defining metadata to be updated. canned_acl: Canned ACL to apply to the bucket. canned_def_acl: Canned default object ACL to apply to the bucket. preconditions: Preconditions for the request. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these Bucket metadata fields. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Bucket object describing new bucket metadata. z PatchBucket must be overloadedNr )r r �metadata� canned_aclZcanned_def_acl� preconditionsr r r r r � PatchBucket� s zCloudApi.PatchBucketc C s t d��dS )a� Locks the Retention Policy on the bucket. Args: bucket_name: Name of bucket to update. metageneration: Bucket metageneration to use as a precondition. provider: Cloud storage provider to connect to. If not present, class-wide default is used. Raises: ServiceException for errors interacting with cloud storage providers. Returns: None z&LockRetentionPolicy must be overloadedNr )r r �metagenerationr r r r �LockRetentionPolicy� s z CloudApi.LockRetentionPolicyc C s t d��dS )a� Creates a new bucket with the specified metadata. Args: bucket_name: Name of the new bucket. project_id: Project owner of the new bucket, default from config if None. metadata: Bucket object defining new bucket metadata. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these Bucket metadata fields. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Bucket object describing new bucket metadata. z CreateBucket must be overloadedNr )r r r$ r& r r r r r � CreateBucket� s zCloudApi.CreateBucketc C s t d��dS )a� Deletes a bucket. Args: bucket_name: Name of the bucket to delete. preconditions: Preconditions for the request. provider: Cloud storage provider to connect to. If not present, class-wide default is used. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: None. z DeleteBucket must be overloadedNr )r r r( r r r r � DeleteBucket� s zCloudApi.DeleteBucketc @ s e Zd ZdZdZdZdS )z CloudApi.CsObjectOrPrefixTypez1Enum class for describing CsObjectOrPrefix types.�object�prefixN)�__name__� __module__� __qualname__�__doc__�OBJECT�PREFIXr r r r �CsObjectOrPrefixType s r6 c @ s e Zd ZdZdd� ZdS )zCloudApi.CsObjectOrPrefixz(Container class for ListObjects results.c C s || _ || _dS )z�Stores a ListObjects result. Args: data: Root object, either an apitools Object or a string Prefix. datatype: CsObjectOrPrefixType of data. N)�data�datatype)r r7 r8 r r r r s z"CloudApi.CsObjectOrPrefix.__init__N�r0 r1 r2 r3 r r r r r �CsObjectOrPrefix s r: c C s t d��dS )a� Lists objects (with metadata) and prefixes in a bucket. Args: bucket_name: Bucket containing the objects. prefix: Prefix for directory-like behavior. delimiter: Delimiter for directory-like behavior. all_versions: If true, list all object versions. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these metadata fields for the listing, for example: ['items/acl', 'items/updated', 'prefixes']. Note that the WildcardIterator class should be used to list objects instead of calling this function directly. It amends the fields definition from get-like syntax such as ['acl', 'updated'] so that the caller does not need to prepend 'items/' or specify any fields necessary for listing (such as prefixes or nextPageToken). Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Iterator over CsObjectOrPrefix wrapper class. z ListObjects must be overloadedNr )r r r/ � delimiter� all_versionsr r r r r � ListObjects s !zCloudApi.ListObjectsc C s t d��dS )a; Gets IAM policy for specified Object. Args: bucket_name: Bucket containing the object. object_name: Name of the object. generation: Generation of the object to retrieve. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only the IAM policy fields specified. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Object IAM policy. z%GetObjectIamPolicy must be overloadedNr �r r � object_namer r r r r r �GetObjectIamPolicyB s zCloudApi.GetObjectIamPolicyc C s t d��dS )aS Sets IAM policy for specified Object. Args: bucket_name: Bucket containing the object. object_name: Name of the object. policy: IAM Policy object. generation: Generation of the object to which the IAM policy will apply. provider: Cloud storage provider to connect to. If not present, class-wide default is used. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Policy object of the object. May differ from input Policy. z%SetObjectIamPolicy must be overloadedNr )r r r? r r r r r r �SetObjectIamPolicy[ s zCloudApi.SetObjectIamPolicyc C s t d��dS )a Gets 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: Bucket containing the object. object_name: Object name. generation: Generation of the object to retrieve. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these Object metadata fields, for example, ['acl', 'updated']. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Object object. z$GetObjectMetadata must be overloadedNr r> r r r �GetObjectMetadatat s zCloudApi.GetObjectMetadatac C s t d��dS )a� Updates object metadata with patch semantics. Args: bucket_name: Bucket containing the object. object_name: Object name for object. metadata: Object object defining metadata to be updated. canned_acl: Canned ACL to be set on the object. generation: Generation (or version) of the object to update. preconditions: Preconditions for the request. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these Object metadata fields. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Updated object metadata. z&PatchObjectMetadata must be overloadedNr ) r r r? r& r' r r( r r r r r �PatchObjectMetadata� s z CloudApi.PatchObjectMetadatac @ s e Zd ZdZdZdZdS )zCloudApi.DownloadStrategyz,Enum class for specifying download strategy.ZoneshotZ resumableN)r0 r1 r2 r3 �ONE_SHOTZ RESUMABLEr r r r �DownloadStrategy� s rE Fc C s t d��dS )a Gets object data. Args: bucket_name: Bucket containing the object. object_name: Object name. download_stream: Stream to send the object data to. provider: Cloud storage provider to connect to. If not present, class-wide default is used. generation: Generation of the object to retrieve. object_size: Total size of the object being downloaded. compressed_encoding: If true, object is stored with a compressed encoding. download_strategy: Cloud API download strategy to use for download. start_byte: 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: Ending byte number, inclusive, for download (for range requests). If None, download the rest of the object. progress_callback: Optional callback function for progress notifications. Receives calls with arguments (bytes_transferred, total_size). serialization_data: Implementation-specific JSON string of a dict containing serialization information for the download. digesters: Dict of {string : digester}, where string is a name of a hash algorithm, and digester is a validation digester that supports update(bytes) and digest() using that algorithm. Implementation can set the digester value to None to indicate bytes were not successfully digested on-the-fly. decryption_tuple: Optional utils.encryption_helper.CryptoKeyWrapper for decrypting an encrypted object. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Content-encoding string if it was detected that the server sent an encoded object during transfer, None otherwise. z!GetObjectMedia must be overloadedNr )r r r? Zdownload_streamr r Z object_sizeZcompressed_encodingZdownload_strategyZ start_byteZend_byte�progress_callback�serialization_data� digesters�decryption_tupler r r �GetObjectMedia� s 5zCloudApi.GetObjectMediac C s t d��dS )a� Uploads object data and metadata. Args: upload_stream: Seekable stream of object data. object_metadata: Object metadata for new object. Must include bucket and object name. canned_acl: Optional canned ACL to apply to object. Overrides ACL set in object_metadata. size: Optional object size. preconditions: Preconditions for the request. progress_callback: Optional callback function for progress notifications. Receives calls with arguments (bytes_transferred, total_size). encryption_tuple: Optional utils.encryption_helper.CryptoKeyWrapper for encrypting the uploaded object. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these Object metadata fields. gzip_encoded: Whether to use gzip transport encoding for the upload. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Object object for newly created destination object. z UploadObject must be overloadedNr ) r � upload_stream�object_metadatar' �sizer( rF �encryption_tupler r � gzip_encodedr r r � UploadObject� s &zCloudApi.UploadObjectc C s t d��dS )a� Uploads object data and metadata. Args: upload_stream: Stream of object data. May not be seekable. object_metadata: Object metadata for new object. Must include bucket and object name. canned_acl: Optional canned ACL to apply to object. Overrides ACL set in object_metadata. preconditions: Preconditions for the request. progress_callback: Optional callback function for progress notifications. Receives calls with arguments (bytes_transferred, total_size), but fills in only bytes_transferred. encryption_tuple: Optional utils.encryption_helper.CryptoKeyWrapper for encrypting the uploaded object. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these Object metadata fields. gzip_encoded: Whether to use gzip transport encoding for the upload. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Object object for newly created destination object. z(UploadObjectStreaming must be overloadedNr ) r rK rL r' r( rF rN r r rO r r r �UploadObjectStreaming s %z CloudApi.UploadObjectStreamingc C s t d��dS )a� Uploads object data and metadata using a resumable upload strategy. Args: upload_stream: Seekable stream of object data. object_metadata: Object metadata for new object. Must include bucket and object name. canned_acl: Optional canned ACL to apply to object. Overrides ACL set in object_metadata. size: Total size of the object. preconditions: Preconditions for the request. serialization_data: Dict of {'url' : UploadURL} allowing for uploads to be resumed. tracker_callback: Callback function taking a upload URL string. Guaranteed to be called when the implementation gets an upload URL, allowing the caller to resume the upload across process breaks by saving the upload URL in a tracker file. progress_callback: Optional callback function for progress notifications. Receives calls with arguments (bytes_transferred, total_size). encryption_tuple: Optional utils.encryption_helper.CryptoKeyWrapper for encrypting the uploaded object. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these Object metadata fields when the upload is complete. gzip_encoded: Whether to use gzip transport encoding for the upload. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Object object for newly created destination object. z(UploadObjectResumable must be overloadedNr ) r rK rL r' rM r( rG Ztracker_callbackrF rN r r rO r r r �UploadObjectResumable> s 0z CloudApi.UploadObjectResumablec C s t d��dS )a� Copies an object in the cloud. Args: src_obj_metadata: Object metadata for source object. Must include bucket name, object name, and etag. dst_obj_metadata: Object metadata for new object. Must include bucket and object name. src_generation: Generation of the source object to copy. canned_acl: Optional canned ACL to apply to destination object. Overrides ACL set in dst_obj_metadata. preconditions: Destination object preconditions for the request. progress_callback: Optional callback function for progress notifications. Receives calls with arguments (bytes_transferred, total_size). max_bytes_per_call: Integer describing maximum number of bytes to rewrite per service call. encryption_tuple: Optional utils.encryption_helper.CryptoKeyWrapper for encrypting the destination object. decryption_tuple: Optional utils.encryption_helper.CryptoKeyWrapper for decrypting the source object. If supplied without encryption_tuple, destination object will be written without customer-supplied encryption. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these Object metadata fields. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Object object for newly created destination object. z CopyObject must be overloadedNr ) r Zsrc_obj_metadata�dst_obj_metadata�src_generationr' r( rF Zmax_bytes_per_callrN rI r r r r r � CopyObjectr s -zCloudApi.CopyObjectc C s t d��dS )a� Composes an object in the cloud. Args: src_objs_metadata: List of ComposeRequest.SourceObjectsValueListEntries specifying the objects to compose. dst_obj_metadata: Metadata for the destination object including bucket and object name. preconditions: Destination object preconditions for the request. encryption_tuple: Optional utils.encryption_helper.CryptoKeyWrapper for decrypting source objects and encrypting the destination object. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these Object metadata fields. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Composed object metadata. z ComposeObject must be overloadedNr )r Zsrc_objs_metadatarS r( rN r r r r r � ComposeObject� s zCloudApi.ComposeObjectc C s t d��dS )aR Deletes an object. Args: bucket_name: Name of the containing bucket. object_name: Name of the object to delete. preconditions: Preconditions for the request. generation: Generation (or version) of the object to delete; if None, deletes the live object. provider: Cloud storage provider to connect to. If not present, class-wide default is used. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: None. z DeleteObject must be overloadedNr )r r r? r( r r r r r � DeleteObject� s zCloudApi.DeleteObjectc C s t d��dS )a� Creates a notification subscription for changes to objects in a bucket. Args: bucket_name: Bucket containing the objects. address: Address to which to send notifications. channel_id: Unique ID string for the channel. token: If present, token string is delivered with each notification. provider: Cloud storage provider to connect to. If not present, class-wide default is used. fields: If present, return only these Channel metadata fields. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Channel object describing the notification subscription. z WatchBucket must be overloadedNr )r r �address� channel_id�tokenr r r r r � WatchBucket� s zCloudApi.WatchBucketc C s t d��dS )a� Stops a notification channel. Args: channel_id: Unique ID string for the channel. resource_id: Version-agnostic ID string for the channel. provider: Cloud storage provider to connect to. If not present, class-wide default is used. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: None. z StopChannel must be overloadedNr )r rY Z resource_idr r r r � StopChannel� s zCloudApi.StopChannelc C s t d��dS )a� Lists object change notifications for a bucket. Args: bucket_name: Bucket containing the objects provider: Cloud storage provider to connect to. If not present, class-wide default is used. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: None. z ListChannels must be overloadedNr �r r r r r r � ListChannels s zCloudApi.ListChannelsc C s t d��dS )a� Get the GCS-owned service account representing this project. Args: project_number: the project in question. provider: Cloud storage provider to connect to. If not present, class-wide default is used. Raises: ServiceException for errors interacting with cloud storage providers. Returns: Service account object (with email_address string field) z+GetProjectServiceAccount must be overloadedNr )r Zproject_numberr r r r �GetProjectServiceAccount s z!CloudApi.GetProjectServiceAccountc C s t d��dS )a$ Creates a new notification with the specified parameters. Args: bucket_name: (Required) Name of the bucket. pubsub_topic: (Required) Cloud Pub/Sub topic to which to publish. payload_format: (Required) payload format, must be 'JSON' or 'NONE'. event_types: (Opt) List of event type filters, e.g. 'OBJECT_FINALIZE'. custom_attributes: (Opt) Dictionary of custom attributes. object_name_prefix: (Opt) Filter on object name. provider: Cloud storage provider to connect to. If not present, class-wide default is used. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: Notification object describing new notificationConfig z+CreateNotificationConfig must be overloadedNr )r r Z pubsub_topicZpayload_formatZ event_typesZcustom_attributesZobject_name_prefixr r r r �CreateNotificationConfig( s z!CloudApi.CreateNotificationConfigc C s t d��dS )a� Deletes a notification. Args: bucket_name: (Required) Name of the bucket. notification: (Required) Integer name of the notification. provider: Cloud storage provider to connect to. If not present, class-wide default is used. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Returns: None z+DeleteNotificationConfig must be overloadedNr )r r Z notificationr r r r �DeleteNotificationConfigE s z!CloudApi.DeleteNotificationConfigc C s t d��dS )a� Lists notification configs in a bucket. Args: bucket_name: Name of the bucket. provider: Cloud storage provider to connect to. If not present, class-wide default is used. Raises: ArgumentException for errors during input validation. ServiceException for errors interacting with cloud storage providers. Yields: List of notification objects. z)ListNotificationConfig must be overloadedNr r] r r r �ListNotificationConfigsW s z CloudApi.ListNotificationConfigsc C s t d��dS )a� Creates a new HMAC key for the specified service account. Args: project_id: Project ID owning the service account for which the key is to be created. service_account_email: Email address of the service account for which to create a key. Raises: NotImplementedError: not implemented TODO(tuckerkirven) Returns The key metadata and the secret key material. z CreateHmacKey must be overloadedNr )r r$ �service_account_emailr r r � CreateHmacKeyh s zCloudApi.CreateHmacKeyc C s t d��dS )z�Deletes an HMAC key. Args: project_id: Project ID owning the requested key. access_id: Name of the HMAC key to be deleted. Raises: NotImplementedError: not implemented TODO(tuckerkirven) z DeleteHmacKey must be overloadedNr �r r$ � access_idr r r � DeleteHmacKeyy s zCloudApi.DeleteHmacKeyc C s t d��dS )aQ Retrieves an HMAC key's metadata. Args: project_id: Project ID owning the service account of the requested key. access_id: Name of the HMAC key for which the metadata is being requested. Raises: NotImplementedError: not implemented TODO(tuckerkirven) Returns: Metadata for the specified key. z GetHmacKey must be overloadedNr re r r r � GetHmacKey� s zCloudApi.GetHmacKeyc C s t d��dS )a� Lists HMAC keys matching the criteria. Args: project_id: Name of the project from which to list HMAC keys. service_account_email: If present, only keys for the given service account will be returned. show_deleted_keys: If set, show keys in the DELETED state. Raises: NotImplementedError: not implemented TODO(tuckerkirven) Yields: List of HMAC key metadata objects. z ListHmacKeys must be overloadedNr )r r$ rc Zshow_deleted_keysr r r � ListHmacKeys� s zCloudApi.ListHmacKeysc C s t d��dS )a� Updates the state of an HMAC key. Args: project_id: Project ID owning the service account of the updated key. access_id: Name of the HMAC key being updated. state: The state to which the key should be updated. etag: None or a string matching the key's etag to ensure the appropriate version of the key is updated. Raises: NotImplementedError: not implemented TODO(tuckerkirven) Returns: The updated key metadata. z UpdateHmacKey must be overloadedNr )r r$ rf �state�etagr r r � UpdateHmacKey� s zCloudApi.UpdateHmacKey)Nr NNNN)NN)NN)N)NNN)NNNNN)N)NNNN)NN)NNNNN)NNN)NN)NNN)NNNNN)NNNNNNNF)NNNNNNF) NNNNNNNNNF) NNNNNNNNN)NNNN)NNN)NNN)N)N)N)NNNN)N)N)F),r0 r1 r2 r3 r r r r r r# r% r) r+ r, r- r. r6 r: r= r@ rA rB rC rE rD rJ rP rQ rR rU rV rW r[ r\ r^ r_ r` ra rb rd rg rh ri rl r r r r r s � $ � � � & � � � " � � : � + � * � 7 � 2 � " � � � � r c @ s e Zd ZdZddd�ZdS )� PreconditionszGPreconditions class for specifying preconditions to cloud API requests.Nc C s || _ || _dS )aH Instantiates a Preconditions object. Args: gen_match: Perform request only if generation of target object matches the given integer. Ignored for bucket requests. meta_gen_match: Perform request only if metageneration of target object/bucket matches the given integer. N)� gen_match�meta_gen_match)r rn ro r r r r � s zPreconditions.__init__)NNr9 r r r r rm � s rm c @ s e Zd ZdZdS )�EncryptionExceptionz@Exception raised when an encrypted resource cannot be decrypted.N�r0 r1 r2 r3 r r r r rp � s rp c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �ArgumentExceptionz�Exception raised when arguments to a Cloud API method are invalid. This exception is never raised as a result of a failed call to a cloud storage provider. c C s t �| � || _d S �N)� Exceptionr �reason)r ru r r r r � s zArgumentException.__init__c C s t | �S rs ��strr r r r �__repr__� s zArgumentException.__repr__c C s d| j j| jf S )Nz%s: %s)� __class__r0 ru r r r r �__str__� s zArgumentException.__str__N�r0 r1 r2 r3 r rx rz r r r r rr � s rr c @ s e Zd ZdZdS )�ProjectIdExceptionzHException raised when a Project ID argument is required but not present.Nrq r r r r r| � s r| c @ s* e Zd ZdZd dd�Zdd� Zdd� ZdS ) �ServiceExceptionz�Exception raised when a cloud storage provider request fails. This exception is raised only as a result of a failed remote call. Nc C s t �| � || _|| _|| _d S rs )rt r ru �status�body)r ru r~ r r r r r � s zServiceException.__init__c C s t | �S rs rv r r r r rx � s zServiceException.__repr__c C sF d| j j }| jr |d| j 7 }|d| j 7 }| jrB|d| j 7 }|S )Nz%s:z %sz %s)ry r0 r~ ru r )r �messager r r rz � s zServiceException.__str__)NNr{ r r r r r} � s r} c @ s e Zd ZdZdS )�RetryableServiceExceptionz)Exception class for retryable exceptions.Nrq r r r r r� � s r� c @ s e Zd ZdZdS )�ResumableDownloadExceptionz>Exception raised for res. downloads that can be retried later.Nrq r r r r r� s r� c @ s e Zd ZdZdS )�ResumableUploadExceptionzHException raised for res. uploads that can be retried w/ same upload ID.Nrq r r r r r� s r� c @ s e Zd ZdZdS )�!ResumableUploadStartOverExceptionzGException raised for res. uploads that can be retried w/ new upload ID.Nrq r r r r r� s r� c @ s e Zd ZdZdS )� ResumableUploadAbortExceptionzDException raised for resumable uploads that cannot be retried later.Nrq r r r r r� s r� c @ s e Zd ZdZdS )�AuthenticationExceptionz>Exception raised for errors during the authentication process.Nrq r r r r r� s r� c @ s e Zd ZdZdS )�PreconditionExceptionz+Exception raised for precondition failures.Nrq r r r r r� s r� c @ s e Zd ZdZdS )�NotFoundExceptionz4Exception raised when a resource is not found (404).Nrq r r r r r� s r� c s" e Zd ZdZd� fdd� Z� ZS )�BucketNotFoundExceptionz;Exception raised when a bucket resource is not found (404).Nc s t t| �j|||d� || _d S )N)r~ r )�superr� r r )r ru r r~ r �ry r r r s �z BucketNotFoundException.__init__)NN)r0 r1 r2 r3 r � __classcell__r r r� r r� s r� c @ s e Zd ZdZdS )�NotEmptyExceptionz=Exception raised when trying to delete a bucket is not empty.Nrq r r r r r� ' s r� c @ s e Zd ZdZdS )�BadRequestExceptionz�Exception raised for malformed requests. Where it is possible to detect invalid arguments prior to sending them to the server, an ArgumentException should be raised instead. Nrq r r r r r� + s r� c @ s e Zd ZdZdS )�AccessDeniedExceptionz�Exception raised when authenticated user has insufficient access rights. This is raised when the authentication process succeeded but the authenticated user does not have access rights to the requested resource. Nrq r r r r r� 3 s r� c @ s e Zd ZdZdS )� PublishPermissionDeniedExceptiona Exception raised when bucket does not have publish permission to a topic. This is raised when a custom attempts to set up a notification config to a Cloud Pub/Sub topic, but their GCS bucket does not have permission to publish to the specified topic. Nrq r r r r r� ; s r� N)r3 � __future__r r r r. r rm rt rp rr r| r} r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r �<module> s: +
| ver. 1.4 |
Github
|
.
| PHP 8.2.28 | Generation time: 0.02 |
proxy
|
phpinfo
|
Settings