U $FZhq@sdZddlZddlZddlZddlZddlmZddlZddlm Z ddl m Z ddl m Z ddl mZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddlmZddlmZddlmZddlmZddlmZddl m!Z!ddl"m#Z#ddl"m$Z$ddl%m&Z&ddl'm(Z(ddl'm)Z)ddl'm*Z*ddl'm+Z+ddl'm,Z,ddl'm-Z-ddl'm.Z.dd l'm/Z/dd!l'm0Z0dd"l'm1Z1dd#l'm2Z2dd$l'm3Z3dd%l4m5Z5dd&l4m6Z6dd'l7m8Z8dd(l7m9Z9dd)l7m:Z:dd*l7m;Z;d+Zd.Z?d/Z@d0ZAd1d2ZBd3d4ZCd5d6ZDGd7d8d8eEZFGd9d:d:eEZGGd;d<dd>eEZIeJZKGd?d@d@eEZLGdAdBdBeZMGdCdDdDeEZNdEdFZOdS)Gz4Create / interact with Google Cloud Storage buckets.N)urlsplit)datetime_helpers)_datetime_to_rfc3339)_rfc3339_nanos_to_datetime)NotFound)Policy)_signing)_add_etag_match_headers) _add_generation_match_parameters)_NOW)_PropertyMixin)_UTC)_scalar_property)_validate_name)generate_signed_url_v2)generate_signed_url_v4)_bucket_bound_hostname_url)_virtual_hosted_style_base_url)create_trace_span) BucketACL)DefaultObjectACLBlob)_DEFAULT_TIMEOUT)ARCHIVE_STORAGE_CLASS)COLDLINE_STORAGE_CLASS)DUAL_REGION_LOCATION_TYPE)1DURABLE_REDUCED_AVAILABILITY_LEGACY_STORAGE_CLASS)#MULTI_REGIONAL_LEGACY_STORAGE_CLASS)MULTI_REGION_LOCATION_TYPE)NEARLINE_STORAGE_CLASS)"PUBLIC_ACCESS_PREVENTION_INHERITED)REGIONAL_LEGACY_STORAGE_CLASS)REGION_LOCATION_TYPE)STANDARD_STORAGE_CLASSBucketNotification)NONE_PAYLOAD_FORMAT) DEFAULT_RETRY)%DEFAULT_RETRY_IF_GENERATION_SPECIFIED)DEFAULT_RETRY_IF_ETAG_IN_JSON))DEFAULT_RETRY_IF_METAGENERATION_SPECIFIEDzlPass only one of 'uniform_bucket_level_access_enabled' / 'bucket_policy_only_enabled' to 'IAMConfiguration'.z'IAMConfiguration.bucket_policy_only_enabled' is deprecated. Instead, use 'IAMConfiguration.uniform_bucket_level_access_enabled'.zpPass only one of 'uniform_bucket_level_access_lock_time' / 'bucket_policy_only_lock_time' to 'IAMConfiguration'.z'IAMConfiguration.bucket_policy_only_lock_time' is deprecated. Instead, use 'IAMConfiguration.uniform_bucket_level_access_lock_time'.zAssignment to 'Bucket.location' is deprecated, as it is only valid before the bucket is created. Instead, pass the location to `Bucket.create`.zBBucket.from_string() is deprecated. Use Bucket.from_uri() instead.cCs$t|dd|_|j|jdS)aGrab prefixes after a :class:`~google.cloud.iterator.Page` started. :type iterator: :class:`~google.api_core.page_iterator.Iterator` :param iterator: The iterator that is currently in use. :type page: :class:`~google.cloud.api.core.page_iterator.Page` :param page: The page that was just created. :type response: dict :param response: The JSON API response for a page of blobs. prefixesN)tuplegetr,update)iteratorpageresponser-r-b/home/aprabhat/apps/x.techxrdev.in/venv/lib/python3.8/site-packages/google/cloud/storage/bucket.py_blobs_page_start]s r5cCs&|d}t||jd}|||S)aConvert a JSON blob to the native object. .. note:: This assumes that the ``bucket`` attribute has been added to the iterator after being created. :type iterator: :class:`~google.api_core.page_iterator.Iterator` :param iterator: The iterator that has retrieved the item. :type item: dict :param item: An item to be converted to a blob. :rtype: :class:`.Blob` :returns: The next blob in the page. namebucket)r/rr8_set_properties)r1itemr6blobr-r-r4 _item_to_blobms  r<cCstj||jdS)aConvert a JSON blob to the native object. .. note:: This assumes that the ``bucket`` attribute has been added to the iterator after being created. :type iterator: :class:`~google.api_core.page_iterator.Iterator` :param iterator: The iterator that has retrieved the item. :type item: dict :param item: An item to be converted to a blob. :rtype: :class:`.BucketNotification` :returns: The next notification being iterated. r7)r& from_api_reprr8)r1r:r-r-r4_item_to_notificationsr>c seZdZdZdfdd ZeddZedd Zed d Z ed d Z eddZ eddZ eddZ eddZeddZeddZeddZeddZZS)LifecycleRuleConditionsaE Map a single lifecycle rule for a bucket. See: https://cloud.google.com/storage/docs/lifecycle :type age: int :param age: (Optional) Apply rule action to items whose age, in days, exceeds this value. :type created_before: datetime.date :param created_before: (Optional) Apply rule action to items created before this date. :type is_live: bool :param is_live: (Optional) If true, apply rule action to non-versioned items, or to items with no newer versions. If false, apply rule action to versioned items with at least one newer version. :type matches_prefix: list(str) :param matches_prefix: (Optional) Apply rule action to items which any prefix matches the beginning of the item name. :type matches_storage_class: list(str), one or more of :attr:`Bucket.STORAGE_CLASSES`. :param matches_storage_class: (Optional) Apply rule action to items whose storage class matches this value. :type matches_suffix: list(str) :param matches_suffix: (Optional) Apply rule action to items which any suffix matches the end of the item name. :type number_of_newer_versions: int :param number_of_newer_versions: (Optional) Apply rule action to versioned items having N newer versions. :type days_since_custom_time: int :param days_since_custom_time: (Optional) Apply rule action to items whose number of days elapsed since the custom timestamp. This condition is relevant only for versioned objects. The value of the field must be a non negative integer. If it's zero, the object version will become eligible for lifecycle action as soon as it becomes custom. :type custom_time_before: :class:`datetime.date` :param custom_time_before: (Optional) Date object parsed from RFC3339 valid date, apply rule action to items whose custom time is before this date. This condition is relevant only for versioned objects, e.g., 2019-03-16. :type days_since_noncurrent_time: int :param days_since_noncurrent_time: (Optional) Apply rule action to items whose number of days elapsed since the non current timestamp. This condition is relevant only for versioned objects. The value of the field must be a non negative integer. If it's zero, the object version will become eligible for lifecycle action as soon as it becomes non current. :type noncurrent_time_before: :class:`datetime.date` :param noncurrent_time_before: (Optional) Date object parsed from RFC3339 valid date, apply rule action to items whose non current time is before this date. This condition is relevant only for versioned objects, e.g, 2019-03-16. :raises ValueError: if no arguments are passed. NFc si} |dk r|| d<|dk r(|| d<|dk r8|| d<|dk rH|| d<|dk rX|| d<|dk rh|| d<|dk r||| d<|dk r|| d<| dk r| | d <| dk r| | d <| dk r| | d <| s| std tt|| dS) Nage createdBeforeisLivematchesStorageClassnumNewerVersionsdaysSinceCustomTimecustomTimeBeforedaysSinceNoncurrentTimenoncurrentTimeBefore matchesPrefix matchesSuffixzSupply at least one condition) isoformat ValueErrorsuperr?__init__)selfr@created_beforeis_livematches_storage_classnumber_of_newer_versionsdays_since_custom_timecustom_time_beforedays_since_noncurrent_timenoncurrent_time_beforematches_prefixmatches_suffix_factory conditions __class__r-r4rNs4   z LifecycleRuleConditions.__init__cCs|dd}|||S)zFactory: construct instance from resource. :type resource: dict :param resource: mapping as returned from API call. :rtype: :class:`LifecycleRuleConditions` :returns: Instance created from resource. TrZr0clsresourceinstancer-r-r4r=s  z%LifecycleRuleConditions.from_api_reprcCs |dS)zConditon's age value.r@r/rOr-r-r4r@szLifecycleRuleConditions.agecCs |d}|dk rt|SdS)z Conditon's created_before value.rANr/rZfrom_iso8601_daterObeforer-r-r4rP"s z&LifecycleRuleConditions.created_beforecCs |dS)zConditon's 'is_live' value.rBrdrer-r-r4rQ)szLifecycleRuleConditions.is_livecCs |dS)z"Conditon's 'matches_prefix' value.rIrdrer-r-r4rX.sz&LifecycleRuleConditions.matches_prefixcCs |dS)z)Conditon's 'matches_storage_class' value.rCrdrer-r-r4rR3sz-LifecycleRuleConditions.matches_storage_classcCs |dS)z"Conditon's 'matches_suffix' value.rJrdrer-r-r4rY8sz&LifecycleRuleConditions.matches_suffixcCs |dS)z,Conditon's 'number_of_newer_versions' value.rDrdrer-r-r4rS=sz0LifecycleRuleConditions.number_of_newer_versionscCs |dS)z*Conditon's 'days_since_custom_time' value.rErdrer-r-r4rTBsz.LifecycleRuleConditions.days_since_custom_timecCs |d}|dk rt|SdS)z&Conditon's 'custom_time_before' value.rFNrfrgr-r-r4rUGs z*LifecycleRuleConditions.custom_time_beforecCs |dS)z.Conditon's 'days_since_noncurrent_time' value.rGrdrer-r-r4rVNsz2LifecycleRuleConditions.days_since_noncurrent_timecCs |d}|dk rt|SdS)z*Conditon's 'noncurrent_time_before' value.rHNrfrgr-r-r4rWSs z.LifecycleRuleConditions.noncurrent_time_before) NNNNNNNNNNNF)__name__ __module__ __qualname____doc__rN classmethodr=propertyr@rPrQrXrRrYrSrTrUrVrW __classcell__r-r-r\r4r?sLA7           r?cs,eZdZdZfddZeddZZS)LifecycleRuleDeletezMap a lifecycle rule deleting matching items. :type kw: dict :params kw: arguments passed to :class:`LifecycleRuleConditions`. c s,tf|}ddit|d}t|dS)NtypeDeleteaction conditionr?dictrMrNrOkwr[ruler\r-r4rNbs zLifecycleRuleDelete.__init__cCs|dd}|||S)zFactory: construct instance from resource. :type resource: dict :param resource: mapping as returned from API call. :rtype: :class:`LifecycleRuleDelete` :returns: Instance created from resource. Tr^r_r`r-r-r4r=gs  z!LifecycleRuleDelete.from_api_reprrirjrkrlrNrmr=ror-r-r\r4rp[s rpcs,eZdZdZfddZeddZZS)LifecycleRuleSetStorageClassa,Map a lifecycle rule updating storage class of matching items. :type storage_class: str, one of :attr:`Bucket.STORAGE_CLASSES`. :param storage_class: new storage class to assign to matching items. :type kw: dict :params kw: arguments passed to :class:`LifecycleRuleConditions`. c s.tf|}d|dt|d}t|dS)NSetStorageClass)rq storageClassrsrv)rO storage_classryr[rzr\r-r4rNs  z%LifecycleRuleSetStorageClass.__init__cCs&|d}||ddd}|||S)zFactory: construct instance from resource. :type resource: dict :param resource: mapping as returned from API call. :rtype: :class:`LifecycleRuleSetStorageClass` :returns: Instance created from resource. rtr~Tr^r_)rarbrtrcr-r-r4r=s  z*LifecycleRuleSetStorageClass.from_api_reprr{r-r-r\r4r|vs r|cs,eZdZdZfddZeddZZS)+LifecycleRuleAbortIncompleteMultipartUploadzMap a rule aborting incomplete multipart uploads of matching items. The "age" lifecycle condition is the only supported condition for this rule. :type kw: dict :params kw: arguments passed to :class:`LifecycleRuleConditions`. c s,tf|}ddit|d}t|dS)NrqAbortIncompleteMultipartUploadrsrvrxr\r-r4rNs  z4LifecycleRuleAbortIncompleteMultipartUpload.__init__cCs|dd}|||S)aFactory: construct instance from resource. :type resource: dict :param resource: mapping as returned from API call. :rtype: :class:`LifecycleRuleAbortIncompleteMultipartUpload` :returns: Instance created from resource. Tr^r_r`r-r-r4r=s  z9LifecycleRuleAbortIncompleteMultipartUpload.from_api_reprr{r-r-r\r4rs rcseZdZdZeeeeeffdd ZeddZeddZ edd Z e j d d Z ed d Z e j d d Z eddZ eddZej ddZeddZZS)IAMConfigurationaMap a bucket's IAM configuration. :type bucket: :class:`Bucket` :params bucket: Bucket for which this instance is the policy. :type public_access_prevention: str :params public_access_prevention: (Optional) Whether the public access prevention policy is 'inherited' (default) or 'enforced' See: https://cloud.google.com/storage/docs/public-access-prevention :type uniform_bucket_level_access_enabled: bool :params bucket_policy_only_enabled: (Optional) Whether the IAM-only policy is enabled for the bucket. :type uniform_bucket_level_access_locked_time: :class:`datetime.datetime` :params uniform_bucket_level_locked_time: (Optional) When the bucket's IAM-only policy was enabled. This value should normally only be set by the back-end API. :type bucket_policy_only_enabled: bool :params bucket_policy_only_enabled: Deprecated alias for :data:`uniform_bucket_level_access_enabled`. :type bucket_policy_only_locked_time: :class:`datetime.datetime` :params bucket_policy_only_locked_time: Deprecated alias for :data:`uniform_bucket_level_access_locked_time`. cs|tk r,|tk rtttjttdd|}|tk rX|tk rDtttjttdd|}|tkrdd}|tkrpt }d|i|d}|tk rt ||dd<t t | |||_dS)N stacklevelFenabled)uniformBucketLevelAccesspublicAccessPreventionr lockedTime)_defaultrL_UBLA_BPO_ENABLED_MESSAGEwarningswarn_BPO_ENABLED_MESSAGEDeprecationWarning_UBLA_BPO_LOCK_TIME_MESSAGE_BPO_LOCK_TIME_MESSAGEr!rrMrrN_bucket)rOr8public_access_prevention#uniform_bucket_level_access_enabled'uniform_bucket_level_access_locked_timebucket_policy_only_enabledbucket_policy_only_locked_timedatar\r-r4rNs2  zIAMConfiguration.__init__cCs||}|||S)aXFactory: construct instance from resource. :type bucket: :class:`Bucket` :params bucket: Bucket for which this instance is the policy. :type resource: dict :param resource: mapping as returned from API call. :rtype: :class:`IAMConfiguration` :returns: Instance created from resource. r_rarbr8rcr-r-r4r=s  zIAMConfiguration.from_api_reprcCs|jSzBucket for which this instance is the policy. :rtype: :class:`Bucket` :returns: the instance's bucket. rrer-r-r4r8szIAMConfiguration.bucketcCs|dS)a(Setting for public access prevention policy. Options are 'inherited' (default) or 'enforced'. See: https://cloud.google.com/storage/docs/public-access-prevention :rtype: string :returns: the public access prevention status, either 'enforced' or 'inherited'. rr-rer-r-r4rs z)IAMConfiguration.public_access_preventioncCs||d<|jd|dS)NriamConfigurationr8_patch_propertyrOvaluer-r-r4r'scCs|di}|ddS)zIf set, access checks only use bucket-level IAM policies or above. :rtype: bool :returns: whether the bucket is configured to allow only IAM. rrFrd)rOublar-r-r4r,s z4IAMConfiguration.uniform_bucket_level_access_enabledcCs*|di}t||d<|jd|dS)Nrrr) setdefaultboolr8r)rOrrr-r-r4r6s  cCs*|di}|d}|dk r&t|}|S)a,Deadline for changing :attr:`uniform_bucket_level_access_enabled` from true to false. If the bucket's :attr:`uniform_bucket_level_access_enabled` is true, this property is time time after which that setting becomes immutable. If the bucket's :attr:`uniform_bucket_level_access_enabled` is false, this property is ``None``. :rtype: Union[:class:`datetime.datetime`, None] :returns: (readonly) Time after which :attr:`uniform_bucket_level_access_enabled` will be frozen as true. rrNr/r)rOrZstampr-r-r4r<s   z8IAMConfiguration.uniform_bucket_level_access_locked_timecCs|jS)zDeprecated alias for :attr:`uniform_bucket_level_access_enabled`. :rtype: bool :returns: whether the bucket is configured to allow only IAM. )rrer-r-r4rPsz+IAMConfiguration.bucket_policy_only_enabledcCstjttdd||_dS)Nrr)rrrrrrr-r-r4rYscCs|jS)aDeprecated alias for :attr:`uniform_bucket_level_access_locked_time`. :rtype: Union[:class:`datetime.datetime`, None] :returns: (readonly) Time after which :attr:`bucket_policy_only_enabled` will be frozen as true. )rrer-r-r4r^s z/IAMConfiguration.bucket_policy_only_locked_time)rirjrkrlrrNrmr=rnr8rsetterrrrrror-r-r\r4rs6*         rcseZdZdZdZeeeee e e fZ e eefZdfdd ZddZedd Zfd d Zed d Zejdd ZeddZeddZeddZeddZefddZedddZedddZdddZ ddddde!dfdd Z"de#dddde$fd!d"Z%dddddd#e#e$fd$d%Z&de#dde'ffd&d' Z(dd(e#dddde$df fd)d* Z)de#dde'ffd+d, Z*ed-d.Z+ed/d0Z,e-d1d2Z.ed3d4Z/ddddddddde#e$df d5d6Z0ddddddddd(dde#e$ddddfd7d8Z1de#e$fd9d:Z2de#e$fd;d<Z3d#ddde#e$fd=d>Z4dddddde#e$fd?d@Z5ddd#e#dddde$f dAdBZ6dddCddddddddde#e7fdDdEZ8ddddddddde#e7f dFdGZ9ddddddddde#e7f dHdIZ:dddddddde#e7f dJdKZ;edLdMZedPdQZ?e?jdRdQZ?edSdTZ@e@jdUdTZ@edVdWZAedXdYZBedZd[ZCed\d]ZDed^d_ZEeEjd`d_ZEdadbZFdcddZGdedfZHdgdhZIdidjZJe=dkZKedldmZLeLjdndmZLedodpZMedqdrZNdsdtZOddvdwZPdxdyZQedzd{ZRed|d}ZSed~dZTeddZUeddZVeddZWeWjddZWeddZXeddZYeYjddZYeddZZeddZ[eddZ\e\jddZ\eddZ]e]jddZ]eddZ^e^jddZ^eddZ_eddZ`e`jddZ`eddZaeddZbeddZcecjddZcdddZdddZedde#e$fddZfde#egfddZhde#e$fddZid#d#de#dde'fddZjd#d#de#dde'fddZkdddZlde#e$fddZmdddZnZoS)BucketaA class representing a Bucket on Cloud Storage. :type client: :class:`google.cloud.storage.client.Client` :param client: A client which holds credentials and project configuration for the bucket (which requires a project). :type name: str :param name: The name of the bucket. Bucket names must start and end with a number or letter. :type user_project: str :param user_project: (Optional) the project ID to be billed for API requests made via this instance. :type generation: int :param generation: (Optional) If present, selects a specific revision of this bucket. NcsXt|}tt|j|d||_t||_t||_t |_ ||_ |dk rT||j d<dS)zJ property :attr:`name` Get the bucket's name. r6N generation) rrMrrN_clientr_aclr_default_object_aclset_label_removals _user_project _properties)rOclientr6 user_projectrr\r-r4rNs  zBucket.__init__cCsd|jdS)Nz rrer-r-r4__repr__szBucket.__repr__cCs|jS)z The client bound to this bucket.)rrer-r-r4rsz Bucket.clientcs|jtt||S)zSet the properties for the current object. :type value: dict or :class:`google.cloud.storage.batch._FutureDict` :param value: The properties to be set. )rclearrMrr9rr\r-r4r9s zBucket._set_propertiescCs |jdS)zGet the RPO (Recovery Point Objective) of this bucket See: https://cloud.google.com/storage/docs/managing-turbo-replication "ASYNC_TURBO" or "DEFAULT" :rtype: str rporr/rer-r-r4rs z Bucket.rpocCs|d|dS)z Set the RPO (Recovery Point Objective) of this bucket. See: https://cloud.google.com/storage/docs/managing-turbo-replication :type value: str :param value: "ASYNC_TURBO" or "DEFAULT" rNrrr-r-r4rs cCs|jS)aJProject ID to be billed for API requests made via this bucket. If unset, API requests are billed to the bucket owner. A user project is required for all operations on Requester Pays buckets. See https://cloud.google.com/storage/docs/requester-pays#requirements for details. :rtype: str )rrer-r-r4rs zBucket.user_projectcCs |jd}|dk rt|SdS)zRetrieve the generation for the bucket. :rtype: int or ``NoneType`` :returns: The generation of the bucket or ``None`` if the bucket's resource has not been loaded from the server. rNrr/int)rOrr-r-r4rs zBucket.generationcCs |jd}|dk rt|SdS)a9If this bucket has been soft-deleted, returns the time at which it became soft-deleted. :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: (readonly) The time that the bucket became soft-deleted. Note this property is only set for soft-deleted buckets. ZsoftDeleteTimeNrr/r)rOsoft_delete_timer-r-r4rs zBucket.soft_delete_timecCs |jd}|dk rt|SdS)aHIf this bucket has been soft-deleted, returns the time at which it will be permanently deleted. :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: (readonly) The time that the bucket will be permanently deleted. Note this property is only set for soft-deleted buckets. ZhardDeleteTimeNr)rOhard_delete_timer-r-r4rs zBucket.hard_delete_timecs tj}|S)zDefault query parameters.)rM _query_params)rOparamsr\r-r4r szBucket._query_paramscCs.t|\}}}}}|dkr"td|||dS)aGet a constructor for bucket object by URI. .. code-block:: python from google.cloud import storage from google.cloud.storage.bucket import Bucket client = storage.Client() bucket = Bucket.from_uri("gs://bucket", client=client) :type uri: str :param uri: The bucket uri pass to get bucket object. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. Application code should *always* pass ``client``. :rtype: :class:`google.cloud.storage.bucket.Bucket` :returns: The bucket object created. gszURI scheme must be gsr)rrL)raurirschemenetlocpathqueryfragr-r-r4from_uriszBucket.from_uricCstjttddtj||dS)a Get a constructor for bucket object by URI. .. note:: Deprecated alias for :meth:`from_uri`. .. code-block:: python from google.cloud import storage from google.cloud.storage.bucket import Bucket client = storage.Client() bucket = Bucket.from_string("gs://bucket", client=client) :type uri: str :param uri: The bucket uri pass to get bucket object. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. Application code should *always* pass ``client``. :rtype: :class:`google.cloud.storage.bucket.Bucket` :returns: The bucket object created. rr)rr)rr_FROM_STRING_MESSAGEPendingDeprecationWarningrr)rarrr-r-r4 from_string,szBucket.from_stringcCst||||||dS)aFactory constructor for blob object. .. note:: This will not make an HTTP request; it simply instantiates a blob object owned by this bucket. :type blob_name: str :param blob_name: The name of the blob to be instantiated. :type chunk_size: int :param chunk_size: The size of a chunk of data whenever iterating (in bytes). This must be a multiple of 256 KB per the API specification. :type encryption_key: bytes :param encryption_key: (Optional) 32 byte encryption key for customer-supplied encryption. :type kms_key_name: str :param kms_key_name: (Optional) Resource name of KMS key used to encrypt blob's content. :type generation: long :param generation: (Optional) If present, selects a specific revision of this object. :rtype: :class:`google.cloud.storage.blob.Blob` :returns: The blob object created. )r6r8 chunk_sizeencryption_key kms_key_namerr)rO blob_namerrrrr-r-r4r;Hs%z Bucket.blobc Cst||||||||dS)zFactory: create a notification resource for the bucket. See: :class:`.BucketNotification` for parameters. :rtype: :class:`.BucketNotification` ) topic_name topic_projectcustom_attributes event_typesblob_name_prefixpayload_formatnotification_idr%)rOrrrrrrrr-r-r4 notificationvszBucket.notificationc Cstdd||}ddi}|jdk r2|j|d<t|||di} t| ||dz|j|j|| ||dd Wn tk rYW5QRd SXW5QRd SQRXdS) aDetermines whether or not this bucket exists. If :attr:`user_project` is set, bills the API request to that project. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type if_etag_match: Union[str, Set[str]] :param if_etag_match: (Optional) Make the operation conditional on whether the bucket's current ETag matches the given value. :type if_etag_not_match: Union[str, Set[str]]) :param if_etag_not_match: (Optional) Make the operation conditional on whether the bucket's current ETag does not match the given value. :type if_metageneration_match: long :param if_metageneration_match: (Optional) Make the operation conditional on whether the bucket's current metageneration matches the given value. :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) Make the operation conditional on whether the bucket's current metageneration does not match the given value. :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :rtype: bool :returns: True if the bucket exists in Cloud Storage. zStorage.Bucket.existsrfieldsr6N userProjectif_metageneration_matchif_metageneration_not_match) if_etag_matchif_etag_not_match) query_paramsheaderstimeoutretry_target_objectFT)r_require_clientrr r _get_resourcerr) rOrrrrrrrrrr-r-r4existss8/     z Bucket.existsFc CsBtdd.||}|j|||j||||||d W5QRXdS)aCreates current bucket. If the bucket already exists, will raise :class:`google.cloud.exceptions.Conflict`. This implements "storage.buckets.insert". If :attr:`user_project` is set, bills the API request to that project. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type project: str :param project: (Optional) The project under which the bucket is to be created. If not passed, uses the project set on the client. :raises ValueError: if ``project`` is None and client's :attr:`project` is also None. :type location: str :param location: (Optional) The location of the bucket. If not passed, the default location, US, will be used. See https://cloud.google.com/storage/docs/bucket-locations :type predefined_acl: str :param predefined_acl: (Optional) Name of predefined ACL to apply to bucket. See: https://cloud.google.com/storage/docs/access-control/lists#predefined-acl :type predefined_default_object_acl: str :param predefined_default_object_acl: (Optional) Name of predefined ACL to apply to bucket's objects. See: https://cloud.google.com/storage/docs/access-control/lists#predefined-acl :type enable_object_retention: bool :param enable_object_retention: (Optional) Whether object retention should be enabled on this bucket. See: https://cloud.google.com/storage/docs/object-lock :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` zStorage.Bucket.creater) Zbucket_or_nameprojectrlocationpredefined_aclpredefined_default_object_aclenable_object_retentionrrN)rrZ create_bucketr) rOrrrrrrrrr-r-r4creates=  z Bucket.createc s4tdd tt|j|||||dW5QRXdS)a9Sends all properties in a PUT request. Updates the ``_properties`` with the response from the backend. If :attr:`user_project` is set, bills the API request to that project. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current object. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type if_metageneration_match: long :param if_metageneration_match: (Optional) Make the operation conditional on whether the blob's current metageneration matches the given value. :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) Make the operation conditional on whether the blob's current metageneration does not match the given value. :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` zStorage.Bucket.updaterrrrrrN)rrMrr0)rOrrrrrr\r-r4r03s$  z Bucket.updateZnoAclc s<tdd(tt|j||||||||| d W5QRXdS)a Reload properties from Cloud Storage. If :attr:`user_project` is set, bills the API request to that project. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current object. :type projection: str :param projection: (Optional) If used, must be 'full' or 'noAcl'. Defaults to ``'noAcl'``. Specifies the set of properties to return. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type if_etag_match: Union[str, Set[str]] :param if_etag_match: (Optional) Make the operation conditional on whether the bucket's current ETag matches the given value. :type if_etag_not_match: Union[str, Set[str]]) :param if_etag_not_match: (Optional) Make the operation conditional on whether the bucket's current ETag does not match the given value. :type if_metageneration_match: long :param if_metageneration_match: (Optional) Make the operation conditional on whether the bucket's current metageneration matches the given value. :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) Make the operation conditional on whether the bucket's current metageneration does not match the given value. :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :type soft_deleted: bool :param soft_deleted: (Optional) If True, looks for a soft-deleted bucket. Will only return the bucket metadata if the bucket exists and is in a soft-deleted state. The bucket ``generation`` must be set if ``soft_deleted`` is set to True. See: https://cloud.google.com/storage/docs/soft-delete zStorage.Bucket.reloadr) r projectionrrrrrr soft_deletedN)rrMrreload) rOrrrrrrrrrr\r-r4r`s:  z Bucket.reloadc sntddZ|jrF|jd|jdi|jD]}d|jd|<q2tt|j|||||dW5QRXdS)aCSends all changed properties in a PATCH request. Updates the ``_properties`` with the response from the backend. If :attr:`user_project` is set, bills the API request to that project. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: the client to use. If not passed, falls back to the ``client`` stored on the current object. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type if_metageneration_match: long :param if_metageneration_match: (Optional) Make the operation conditional on whether the blob's current metageneration matches the given value. :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) Make the operation conditional on whether the blob's current metageneration does not match the given value. :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` zStorage.Bucket.patchrlabelsN)rrrrr) rrZ_changesaddrrrMrpatch)rOrrrrrZ removed_labelr\r-r4rs$    z Bucket.patchcCs|jS)zCreate our ACL on demand.)rrer-r-r4aclsz Bucket.aclcCs|jS)z&Create our defaultObjectACL on demand.)rrer-r-r4default_object_aclszBucket.default_object_aclcCsd|S)zRelative URL path for a bucket. :type bucket_name: str :param bucket_name: The bucket name in the path. :rtype: str :returns: The relative URL path for ``bucket_name``. /b/r-) bucket_namer-r-r4 path_helpers zBucket.path_helpercCs|jstd||jS)zThe URL path to this bucket.z*Cannot determine path without bucket name.)r6rLrrer-r-r4rsz Bucket.pathc Kstddrtf||||d|}z"|j|| ||||| | | | d Wn tk rfYW5QRdSX|W5QRSW5QRXdS)az Get a blob object by name. See a [code sample](https://cloud.google.com/storage/docs/samples/storage-get-metadata#storage_get_metadata-python) on how to retrieve metadata of an object. If :attr:`user_project` is set, bills the API request to that project. :type blob_name: str :param blob_name: The name of the blob to retrieve. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type encryption_key: bytes :param encryption_key: (Optional) 32 byte encryption key for customer-supplied encryption. See https://cloud.google.com/storage/docs/encryption#customer-supplied. :type generation: long :param generation: (Optional) If present, selects a specific revision of this object. :type if_etag_match: Union[str, Set[str]] :param if_etag_match: (Optional) See :ref:`using-if-etag-match` :type if_etag_not_match: Union[str, Set[str]] :param if_etag_not_match: (Optional) See :ref:`using-if-etag-not-match` :type if_generation_match: long :param if_generation_match: (Optional) See :ref:`using-if-generation-match` :type if_generation_not_match: long :param if_generation_not_match: (Optional) See :ref:`using-if-generation-not-match` :type if_metageneration_match: long :param if_metageneration_match: (Optional) See :ref:`using-if-metageneration-match` :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) See :ref:`using-if-metageneration-not-match` :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :type soft_deleted: bool :param soft_deleted: (Optional) If True, looks for a soft-deleted object. Will only return the object metadata if the object exists and is in a soft-deleted state. Object ``generation`` is required if ``soft_deleted`` is set to True. See: https://cloud.google.com/storage/docs/soft-delete :param kwargs: Keyword arguments to pass to the :class:`~google.cloud.storage.blob.Blob` constructor. :rtype: :class:`google.cloud.storage.blob.Blob` or None :returns: The blob object if it exists, otherwise None. zStorage.Bucket.getBlobr)r8r6rr) rrrrif_generation_matchif_generation_not_matchrrrrN)rrrr)rOrrrrrrrrrrrrrkwargsr;r-r-r4get_blobs2X  zBucket.get_blobcCsXtddD|| } | j|||||||||| | || | |||dW5QRSQRXdS)asReturn an iterator used to find blobs in the bucket. If :attr:`user_project` is set, bills the API request to that project. :type max_results: int :param max_results: (Optional) The maximum number of blobs to return. :type page_token: str :param page_token: (Optional) If present, return the next batch of blobs, using the value, which must correspond to the ``nextPageToken`` value returned in the previous response. Deprecated: use the ``pages`` property of the returned iterator instead of manually passing the token. :type prefix: str :param prefix: (Optional) Prefix used to filter blobs. :type delimiter: str :param delimiter: (Optional) Delimiter, used with ``prefix`` to emulate hierarchy. :type start_offset: str :param start_offset: (Optional) 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). :type end_offset: str :param end_offset: (Optional) 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). :type include_trailing_delimiter: boolean :param include_trailing_delimiter: (Optional) If true, objects that end in exactly one instance of ``delimiter`` will have their metadata included in ``items`` in addition to ``prefixes``. :type versions: bool :param versions: (Optional) Whether object versions should be returned as separate blobs. :type projection: str :param projection: (Optional) If used, must be 'full' or 'noAcl'. Defaults to ``'noAcl'``. Specifies the set of properties to return. :type fields: str :param fields: (Optional) Selector specifying which fields to include in a partial response. Must be a list of fields. For example to get a partial response with just the next page token and the name and language of each blob returned: ``'items(name,contentLanguage),nextPageToken'``. See: https://cloud.google.com/storage/docs/json_api/v1/parameters#fields :type client: :class:`~google.cloud.storage.client.Client` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :type match_glob: str :param match_glob: (Optional) A glob pattern used to filter results (for example, foo*bar). The string value must be UTF-8 encoded. See: https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-object-glob :type include_folders_as_prefixes: bool (Optional) If true, includes Folders and Managed Folders in the set of ``prefixes`` returned by the query. Only applicable if ``delimiter`` is set to /. See: https://cloud.google.com/storage/docs/managed-folders :type soft_deleted: bool :param soft_deleted: (Optional) If true, only soft-deleted objects will be listed as distinct results in order of increasing generation number. This parameter can only be used successfully if the bucket has a soft delete policy. Note ``soft_deleted`` and ``versions`` cannot be set to True simultaneously. See: https://cloud.google.com/storage/docs/soft-delete :type page_size: int :param page_size: (Optional) Maximum number of blobs to return in each page. Defaults to a value set by the API. :rtype: :class:`~google.api_core.page_iterator.Iterator` :returns: Iterator of all :class:`~google.cloud.storage.blob.Blob` in this bucket matching the arguments. zStorage.Bucket.listBlobsr) max_results page_tokenprefix delimiter start_offset end_offsetinclude_trailing_delimiterversionsrr page_sizerr match_globinclude_folders_as_prefixesrN)rr list_blobs)rOrrrrrrrrrrrrrrrrrr-r-r4rps*y  zBucket.list_blobsc CsRtdd>||}|jd}|j|t||d}||_|W5QRSQRXdS)aList Pub / Sub notifications for this bucket. See: https://cloud.google.com/storage/docs/json_api/v1/notifications/list If :attr:`user_project` is set, bills the API request to that project. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :rtype: list of :class:`.BucketNotification` :returns: notification instances z Storage.Bucket.listNotificationsrz/notificationConfigs)rrN)rrrZ_list_resourcer>r8)rOrrrrr1r-r-r4list_notificationss   zBucket.list_notificationsc CsBtdd.|j|d}|j|||d|W5QRSQRXdS)aGet Pub / Sub notification for this bucket. See [API reference docs](https://cloud.google.com/storage/docs/json_api/v1/notifications/get) and a [code sample](https://cloud.google.com/storage/docs/samples/storage-print-pubsub-bucket-notification#storage_print_pubsub_bucket_notification-python). If :attr:`user_project` is set, bills the API request to that project. :type notification_id: str :param notification_id: The notification id to retrieve the notification configuration. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :rtype: :class:`.BucketNotification` :returns: notification instance. zStorage.Bucket.getNotificationr)r)rrrN)rrr)rOrrrrrr-r-r4get_notification%s!  zBucket.get_notificationc Cstdd||}i}|jdk r.|j|d<t|||d|rt|j|jd|||dd}t||jkrd |jf} t| |j |d d |||dd |j |j |||dd W5QRXdS)aDelete this bucket. The bucket **must** be empty in order to submit a delete request. If ``force=True`` is passed, this will first attempt to delete all the objects / blobs in the bucket (i.e. try to empty the bucket). If the bucket doesn't exist, this will raise :class:`google.cloud.exceptions.NotFound`. If the bucket is not empty (and ``force=False``), will raise :class:`google.cloud.exceptions.Conflict`. If ``force=True`` and the bucket contains more than 256 objects / blobs this will cowardly refuse to delete the objects (or the bucket). This is to prevent accidental bucket deletion and to prevent extremely long runtime of this method. Also note that ``force=True`` is not supported in a ``Batch`` context. If :attr:`user_project` is set, bills the API request to that project. :type force: bool :param force: If True, empties the bucket's objects then deletes it. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type if_metageneration_match: long :param if_metageneration_match: (Optional) Make the operation conditional on whether the blob's current metageneration matches the given value. :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) Make the operation conditional on whether the blob's current metageneration does not match the given value. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :raises: :class:`ValueError` if ``force`` is ``True`` and the bucket contains more than 256 objects / blobs. zStorage.Bucket.deleterNrrT)rrrrrzRefusing to delete bucket with more than %d objects. If you actually want to delete this bucket, please delete the objects yourself before calling Bucket.delete().cSsdS)Nr-)r;r-r-r4zBucket.delete..)on_errorrrrpreserve_generationrrrr) rrrr listr_MAX_OBJECTS_FOR_ITERATIONlenrL delete_blobs_delete_resourcer) rOforcerrrrrrblobsmessager-r-r4deleteKsP7      z Bucket.deletec CsftddR||}t|||d} t| j} t| ||||d|j| j| || ddW5QRXdS)a Deletes a blob from the current bucket. If :attr:`user_project` is set, bills the API request to that project. :type blob_name: str :param blob_name: A blob name to delete. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type generation: long :param generation: (Optional) If present, permanently deletes a specific revision of this object. :type if_generation_match: long :param if_generation_match: (Optional) See :ref:`using-if-generation-match` :type if_generation_not_match: long :param if_generation_not_match: (Optional) See :ref:`using-if-generation-not-match` :type if_metageneration_match: long :param if_metageneration_match: (Optional) See :ref:`using-if-metageneration-match` :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) See :ref:`using-if-metageneration-not-match` :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. A None value will disable retries. A google.api_core.retry.Retry value will enable retries, and the object will define retriable response codes and errors and configure backoff and timeout options. A google.cloud.storage.retry.ConditionalRetryPolicy value wraps a Retry object and activates it only if certain conditions are met. This class exists to provide safe defaults for RPC calls that are not technically safe to retry normally (due to potential data duplication or other side-effects) but become safe to retry if a condition such as if_generation_match is set. See the retry.py source code and docstrings in this package (google.cloud.storage.retry) for information on retry types and how to configure them. :raises: :class:`google.cloud.exceptions.NotFound` Raises a NotFound if the blob isn't found. To suppress the exception, use :meth:`delete_blobs` by passing a no-op ``on_error`` callback. zStorage.Bucket.deleteBlobr)r8rrrrrNr) rrrcopydeepcopyrr rr) rOrrrrrrrrrr;rr-r-r4 delete_blobs$G    zBucket.delete_blobc  Cstddtt||||| dt|p*g}t|p6g}t|pBg}t| pNg} |D]} z^| } d} t| ts| j} |r~| jnd} |j| || t |dt |dt |dt | d|| d WqVt k r|dk r|| nYqVXqVW5QRXdS)aDeletes a list of blobs from the current bucket. Uses :meth:`delete_blob` to delete each individual blob. By default, any generation information in the list of blobs is ignored, and the live versions of all blobs are deleted. Set `preserve_generation` to True if blob generation should instead be propagated from the list of blobs. If :attr:`user_project` is set, bills the API request to that project. :type blobs: list :param blobs: A list of :class:`~google.cloud.storage.blob.Blob`-s or blob names to delete. :type on_error: callable :param on_error: (Optional) Takes single argument: ``blob``. Called once for each blob raising :class:`~google.cloud.exceptions.NotFound`; otherwise, the exception is propagated. Note that ``on_error`` is not supported in a ``Batch`` context. :type client: :class:`~google.cloud.storage.client.Client` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type preserve_generation: bool :param preserve_generation: (Optional) Deletes only the generation specified on the blob object, instead of the live version, if set to True. Only :class:~google.cloud.storage.blob.Blob objects can have their generation set in this way. Default: False. :type if_generation_match: list of long :param if_generation_match: (Optional) See :ref:`using-if-generation-match` Note that the length of the list must match the length of The list must match ``blobs`` item-to-item. :type if_generation_not_match: list of long :param if_generation_not_match: (Optional) See :ref:`using-if-generation-not-match` The list must match ``blobs`` item-to-item. :type if_metageneration_match: list of long :param if_metageneration_match: (Optional) See :ref:`using-if-metageneration-match` The list must match ``blobs`` item-to-item. :type if_metageneration_not_match: list of long :param if_metageneration_not_match: (Optional) See :ref:`using-if-metageneration-not-match` The list must match ``blobs`` item-to-item. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. A None value will disable retries. A google.api_core.retry.Retry value will enable retries, and the object will define retriable response codes and errors and configure backoff and timeout options. A google.cloud.storage.retry.ConditionalRetryPolicy value wraps a Retry object and activates it only if certain conditions are met. This class exists to provide safe defaults for RPC calls that are not technically safe to retry normally (due to potential data duplication or other side-effects) but become safe to retry if a condition such as if_generation_match is set. See the retry.py source code and docstrings in this package (google.cloud.storage.retry) for information on retry types and how to configure them. :raises: :class:`~google.cloud.exceptions.NotFound` (if `on_error` is not passed). zStorage.Bucket.deleteBlobsrrN)rrrrrrrr) r_raise_if_len_differsriter isinstancestrr6rrnextr)rOrr rrrrrrrrr;rrr-r-r4rsJZ        zBucket.delete_blobsTc Cstdd||}i}|jdk r.|j|d<|dk r>||d<t|||| | | | | |d |dkrf|j}t||d}|jd|j}|j|d||||d }|s|jj i||d | ||W5QRSQRXdS) aCopy the given blob to the given bucket, optionally with a new name. If :attr:`user_project` is set, bills the API request to that project. See [API reference docs](https://cloud.google.com/storage/docs/json_api/v1/objects/copy) and a [code sample](https://cloud.google.com/storage/docs/samples/storage-copy-file#storage_copy_file-python). :type blob: :class:`google.cloud.storage.blob.Blob` :param blob: The blob to be copied. :type destination_bucket: :class:`google.cloud.storage.bucket.Bucket` :param destination_bucket: The bucket into which the blob should be copied. :type new_name: str :param new_name: (Optional) The new name for the copied file. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type preserve_acl: bool :param preserve_acl: DEPRECATED. This argument is not functional! (Optional) Copies ACL from old blob to new blob. Default: True. Note that ``preserve_acl`` is not supported in a ``Batch`` context. :type source_generation: long :param source_generation: (Optional) The generation of the blob to be copied. :type if_generation_match: long :param if_generation_match: (Optional) See :ref:`using-if-generation-match` Note that the generation to be matched is that of the ``destination`` blob. :type if_generation_not_match: long :param if_generation_not_match: (Optional) See :ref:`using-if-generation-not-match` Note that the generation to be matched is that of the ``destination`` blob. :type if_metageneration_match: long :param if_metageneration_match: (Optional) See :ref:`using-if-metageneration-match` Note that the metageneration to be matched is that of the ``destination`` blob. :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) See :ref:`using-if-metageneration-not-match` Note that the metageneration to be matched is that of the ``destination`` blob. :type if_source_generation_match: long :param if_source_generation_match: (Optional) Makes the operation conditional on whether the source object's generation matches the given value. :type if_source_generation_not_match: long :param if_source_generation_not_match: (Optional) Makes the operation conditional on whether the source object's generation does not match the given value. :type if_source_metageneration_match: long :param if_source_metageneration_match: (Optional) Makes the operation conditional on whether the source object's current metageneration matches the given value. :type if_source_metageneration_not_match: long :param if_source_metageneration_not_match: (Optional) Makes the operation conditional on whether the source object's current metageneration does not match the given value. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. The default value is ``DEFAULT_RETRY_IF_GENERATION_SPECIFIED``, a conditional retry policy which will only enable retries if ``if_generation_match`` or ``generation`` is set, in order to ensure requests are idempotent before retrying them. Change the value to ``DEFAULT_RETRY`` or another `google.api_core.retry.Retry` object to enable retries regardless of generation precondition setting. See [Configuring Retries](https://cloud.google.com/python/docs/reference/storage/latest/retry_timeout). :rtype: :class:`google.cloud.storage.blob.Blob` :returns: The new Blob. zStorage.Bucket.copyBlobrNrZsourceGenerationrrrrif_source_generation_matchif_source_generation_not_matchif_source_metageneration_match"if_source_metageneration_not_matchr8r6z/copyTor)rrr) rrrr r6rr_post_resourcersaver9)rOr;Zdestination_bucketnew_namerZ preserve_aclZsource_generationrrrrr#r$r%r&rrrnew_blobapi_pathZ copy_resultr-r-r4 copy_blobsDr        zBucket.copy_blobcCsrtdd^|j|k}|j||||| |||||| | | | d}|sX|j|| || | | | d|W5QRSQRXdS)aBRename the given blob using copy and delete operations. If :attr:`user_project` is set, bills the API request to that project. Effectively, copies blob to the same bucket with a new name, then deletes the blob. .. warning:: This method will first duplicate the data and then delete the old blob. This means that with very large objects renaming could be a very (temporarily) costly or a very slow operation. If you need more control over the copy and deletion, instead use ``google.cloud.storage.blob.Blob.copy_to`` and ``google.cloud.storage.blob.Blob.delete`` directly. Also note that this method is not fully supported in a ``Batch`` context. :type blob: :class:`google.cloud.storage.blob.Blob` :param blob: The blob to be renamed. :type new_name: str :param new_name: The new name for this blob. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type if_generation_match: long :param if_generation_match: (Optional) See :ref:`using-if-generation-match` Note that the generation to be matched is that of the ``destination`` blob. :type if_generation_not_match: long :param if_generation_not_match: (Optional) See :ref:`using-if-generation-not-match` Note that the generation to be matched is that of the ``destination`` blob. :type if_metageneration_match: long :param if_metageneration_match: (Optional) See :ref:`using-if-metageneration-match` Note that the metageneration to be matched is that of the ``destination`` blob. :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) See :ref:`using-if-metageneration-not-match` Note that the metageneration to be matched is that of the ``destination`` blob. :type if_source_generation_match: long :param if_source_generation_match: (Optional) Makes the operation conditional on whether the source object's generation matches the given value. Also used in the (implied) delete request. :type if_source_generation_not_match: long :param if_source_generation_not_match: (Optional) Makes the operation conditional on whether the source object's generation does not match the given value. Also used in the (implied) delete request. :type if_source_metageneration_match: long :param if_source_metageneration_match: (Optional) Makes the operation conditional on whether the source object's current metageneration matches the given value. Also used in the (implied) delete request. :type if_source_metageneration_not_match: long :param if_source_metageneration_not_match: (Optional) Makes the operation conditional on whether the source object's current metageneration does not match the given value. Also used in the (implied) delete request. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. The default value is ``DEFAULT_RETRY_IF_GENERATION_SPECIFIED``, a conditional retry policy which will only enable retries if ``if_generation_match`` or ``generation`` is set, in order to ensure requests are idempotent before retrying them. Change the value to ``DEFAULT_RETRY`` or another `google.api_core.retry.Retry` object to enable retries regardless of generation precondition setting. See [Configuring Retries](https://cloud.google.com/python/docs/reference/storage/latest/retry_timeout). :rtype: :class:`Blob` :returns: The newly-renamed blob. zStorage.Bucket.renameBlobr) rrrrrrr#r$r%r&r)rrrrrrrN)rr6r-r)rOr;r*rrrrrr#r$r%r&rrZ same_namer+r-r-r4 rename_blob2s:p   zBucket.rename_blobc Cstdd||}i}|jdk r.|j|d<t||||||| | | d t||d}|jd|j}|j|d|| | |d}|||W5QRSQRXdS) ab Move a blob to a new name within a single HNS bucket. *This feature is currently only supported for HNS (Heirarchical Namespace) buckets.* If :attr:`user_project` is set on the bucket, bills the API request to that project. :type blob: :class:`google.cloud.storage.blob.Blob` :param blob: The blob to be renamed. :type new_name: str :param new_name: The new name for this blob. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type if_generation_match: int :param if_generation_match: (Optional) See :ref:`using-if-generation-match` Note that the generation to be matched is that of the ``destination`` blob. :type if_generation_not_match: int :param if_generation_not_match: (Optional) See :ref:`using-if-generation-not-match` Note that the generation to be matched is that of the ``destination`` blob. :type if_metageneration_match: int :param if_metageneration_match: (Optional) See :ref:`using-if-metageneration-match` Note that the metageneration to be matched is that of the ``destination`` blob. :type if_metageneration_not_match: int :param if_metageneration_not_match: (Optional) See :ref:`using-if-metageneration-not-match` Note that the metageneration to be matched is that of the ``destination`` blob. :type if_source_generation_match: int :param if_source_generation_match: (Optional) Makes the operation conditional on whether the source object's generation matches the given value. :type if_source_generation_not_match: int :param if_source_generation_not_match: (Optional) Makes the operation conditional on whether the source object's generation does not match the given value. :type if_source_metageneration_match: int :param if_source_metageneration_match: (Optional) Makes the operation conditional on whether the source object's current metageneration matches the given value. :type if_source_metageneration_not_match: int :param if_source_metageneration_not_match: (Optional) Makes the operation conditional on whether the source object's current metageneration does not match the given value. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry :param retry: (Optional) How to retry the RPC. See [Configuring Retries](https://cloud.google.com/python/docs/reference/storage/latest/retry_timeout). :rtype: :class:`Blob` :returns: The newly-moved blob. zStorage.Bucket.moveBlobrNrr"r'z /moveTo/o/r) rrrr rrr6r(r9)rOr;r*rrrrrr#r$r%r&rrrr+r,Z move_resultr-r-r4 move_blobs8[      zBucket.move_blobc  Cstdd||}i} |jdk r.|j| d<|dk r>|| d<|dk rN|| d<|dk r^|| d<t| |||| dt||d } |j| jd d| | | d }| || W5QRSQRXdS) a Restores a soft-deleted object. If :attr:`user_project` is set on the bucket, bills the API request to that project. See [API reference docs](https://cloud.google.com/storage/docs/json_api/v1/objects/restore) :type blob_name: str :param blob_name: The name of the blob to be restored. :type client: :class:`~google.cloud.storage.client.Client` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type generation: int :param generation: Selects the specific revision of the object. :type copy_source_acl: bool :param copy_source_acl: (Optional) If true, copy the soft-deleted object's access controls. :type projection: str :param projection: (Optional) Specifies the set of properties to return. If used, must be 'full' or 'noAcl'. :type if_generation_match: long :param if_generation_match: (Optional) See :ref:`using-if-generation-match` :type if_generation_not_match: long :param if_generation_not_match: (Optional) See :ref:`using-if-generation-not-match` :type if_metageneration_match: long :param if_metageneration_match: (Optional) See :ref:`using-if-metageneration-match` :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) See :ref:`using-if-metageneration-not-match` :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. The default value is ``DEFAULT_RETRY_IF_GENERATION_SPECIFIED``, which only restore operations with ``if_generation_match`` or ``generation`` set will be retried. Users can configure non-default retry behavior. A ``None`` value will disable retries. A ``DEFAULT_RETRY`` value will enable retries even if restore operations are not guaranteed to be idempotent. See [Configuring Retries](https://cloud.google.com/python/docs/reference/storage/latest/retry_timeout). :rtype: :class:`google.cloud.storage.blob.Blob` :returns: The restored Blob. zStorage.Bucket.restore_blobrNrrZ copySourceAclrrr'z/restore)rrr)rrrr rr(rr9)rOrrrZcopy_source_aclrrrrrrrrr; api_responser-r-r4 restore_blob> s8I       zBucket.restore_blobcCsdd|jddDS)aRetrieve or set CORS policies configured for this bucket. See http://www.w3.org/TR/cors/ and https://cloud.google.com/storage/docs/json_api/v1/buckets .. note:: The getter for this property returns a list which contains *copies* of the bucket's CORS policy mappings. Mutating the list or one of its dicts has no effect unless you then re-assign the dict via the setter. E.g.: >>> policies = bucket.cors >>> policies.append({'origin': '/foo', ...}) >>> policies[1]['maxAgeSeconds'] = 3600 >>> del policies[0] >>> bucket.cors = policies >>> bucket.update() :setter: Set CORS policies for this bucket. :getter: Gets the CORS policies for this bucket. :rtype: list of dictionaries :returns: A sequence of mappings describing each CORS policy. cSsg|]}t|qSr-)rr).0policyr-r-r4 szBucket.cors..corsr-rrer-r-r4r5 sz Bucket.corscCs|d|dS)a"Set CORS policies configured for this bucket. See http://www.w3.org/TR/cors/ and https://cloud.google.com/storage/docs/json_api/v1/buckets :type entries: list of dictionaries :param entries: A sequence of mappings describing each CORS policy. r5Nr)rOentriesr-r-r4r5 s ZdefaultEventBasedHoldcCs|jdi}|dS)aRetrieve / set default KMS encryption key for objects in the bucket. See https://cloud.google.com/storage/docs/json_api/v1/buckets :setter: Set default KMS encryption key for items in this bucket. :getter: Get default KMS encryption key for items in this bucket. :rtype: str :returns: Default KMS encryption key, or ``None`` if not set. encryptiondefaultKmsKeyNamer)rOencryption_configr-r-r4default_kms_key_name s zBucket.default_kms_key_namecCs&|jdi}||d<|d|dS)zSet default KMS encryption key for objects in the bucket. :type value: str or None :param value: new KMS key name (None to clear any existing key). r7r8Nrr/r)rOrr9r-r-r4r: scCs"|jd}|dkriSt|S)aRetrieve or set labels assigned to this bucket. See https://cloud.google.com/storage/docs/json_api/v1/buckets#labels .. note:: The getter for this property returns a dict which is a *copy* of the bucket's labels. Mutating that dict has no effect unless you then re-assign the dict via the setter. E.g.: >>> labels = bucket.labels >>> labels['new_key'] = 'some-label' >>> del labels['old_key'] >>> bucket.labels = labels >>> bucket.update() :setter: Set labels for this bucket. :getter: Gets the labels for this bucket. :rtype: :class:`dict` :returns: Name-value pairs (string->string) labelling the bucket. rNrr/rr)rOrr-r-r4r s z Bucket.labelscCsjtdd|jD}tdd|D}|j|||_dd|D}|dt |dS)zSet labels assigned to this bucket. See https://cloud.google.com/storage/docs/json_api/v1/buckets#labels :type mapping: :class:`dict` :param mapping: Name-value pairs (string->string) labelling the bucket. cSsg|]}|qSr-r-r2kr-r-r4r4# sz!Bucket.labels..cSsg|]}|qSr-r-r=r-r-r4r4$ scSsi|]\}}|t|qSr-)r )r2r>vr-r-r4 & sz!Bucket.labels..rN) rrkeysrunion differenceitemsrrr)rOmappingexistingincomingr-r-r4r s cCs |jdS)aVRetrieve the ETag for the bucket. See https://tools.ietf.org/html/rfc2616#section-3.11 and https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: str or ``NoneType`` :returns: The bucket etag or ``None`` if the bucket's resource has not been loaded from the server. etagrrer-r-r4rH+ s z Bucket.etagcCs |jdS)aRetrieve the ID for the bucket. See https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: str or ``NoneType`` :returns: The ID of the bucket or ``None`` if the bucket's resource has not been loaded from the server. idrrer-r-r4rI8 s z Bucket.idcCs|jdi}t||S)zRetrieve IAM configuration for this bucket. :rtype: :class:`IAMConfiguration` :returns: an instance for managing the bucket's IAM configuration. r)rr/rr=rOinfor-r-r4iam_configurationD szBucket.iam_configurationcCs|jdi}t||S)zRetrieve the soft delete policy for this bucket. See https://cloud.google.com/storage/docs/soft-delete :rtype: :class:`SoftDeletePolicy` :returns: an instance for managing the bucket's soft delete policy. softDeletePolicy)rr/SoftDeletePolicyr=rOr3r-r-r4soft_delete_policyN s zBucket.soft_delete_policyccs|jdi}|ddD]h}|dd}|dkr@t|Vq|dkrVt|Vq|dkrlt|Vqtjd |t d d qd S) aRetrieve or set lifecycle rules configured for this bucket. See https://cloud.google.com/storage/docs/lifecycle and https://cloud.google.com/storage/docs/json_api/v1/buckets .. note:: The getter for this property returns a generator which yields *copies* of the bucket's lifecycle rules mappings. Mutating the output dicts has no effect unless you then re-assign the dict via the setter. E.g.: >>> rules = list(bucket.lifecycle_rules) >>> rules.append({'origin': '/foo', ...}) >>> rules[1]['rule']['action']['type'] = 'Delete' >>> del rules[0] >>> bucket.lifecycle_rules = rules >>> bucket.update() :setter: Set lifecycle rules for this bucket. :getter: Gets the lifecycle rules for this bucket. :rtype: generator(dict) :returns: A sequence of mappings describing each lifecycle rule. lifecyclerzr-rtrqrrr}rzgUnknown lifecycle rule type received: {}. Please upgrade to the latest version of google-cloud-storage.r rN) rr/rpr=r|rrrformat UserWarning)rOrKrzZ action_typer-r-r4lifecycle_rulesZ s  zBucket.lifecycle_rulescCs"dd|D}|dd|idS)a8Set lifecycle rules configured for this bucket. See https://cloud.google.com/storage/docs/lifecycle and https://cloud.google.com/storage/docs/json_api/v1/buckets :type rules: list of dictionaries :param rules: A sequence of mappings describing each lifecycle rule. cSsg|] }t|qSr-)rw)r2rzr-r-r4r4 sz*Bucket.lifecycle_rules..rQrzNr)rOrulesr-r-r4rT s cCs g|_dS)zClear lifecycle rules configured for this bucket. See https://cloud.google.com/storage/docs/lifecycle and https://cloud.google.com/storage/docs/json_api/v1/buckets N)rTrer-r-r4clear_lifecycle_rules szBucket.clear_lifecycle_rulescCs|S)z+Deprecated alias for clear_lifecycle_rules.)rVrer-r-r4clear_lifecyle_rules szBucket.clear_lifecyle_rulescKs$t|j}|tf|||_dS)aAdd a "delete" rule to lifecycle rules configured for this bucket. This defines a [lifecycle configuration](https://cloud.google.com/storage/docs/lifecycle), which is set on the bucket. For the general format of a lifecycle configuration, see the [bucket resource representation for JSON](https://cloud.google.com/storage/docs/json_api/v1/buckets). See also a [code sample](https://cloud.google.com/storage/docs/samples/storage-enable-bucket-lifecycle-management#storage_enable_bucket_lifecycle_management-python). :type kw: dict :params kw: arguments passed to :class:`LifecycleRuleConditions`. N)rrTappendrprOryrUr-r-r4add_lifecycle_delete_rule s z Bucket.add_lifecycle_delete_rulecKs&t|j}|t|f|||_dS)a`Add a "set storage class" rule to lifecycle rules. This defines a [lifecycle configuration](https://cloud.google.com/storage/docs/lifecycle), which is set on the bucket. For the general format of a lifecycle configuration, see the [bucket resource representation for JSON](https://cloud.google.com/storage/docs/json_api/v1/buckets). :type storage_class: str, one of :attr:`STORAGE_CLASSES`. :param storage_class: new storage class to assign to matching items. :type kw: dict :params kw: arguments passed to :class:`LifecycleRuleConditions`. N)rrTrXr|)rOrryrUr-r-r4$add_lifecycle_set_storage_class_rule s z+Bucket.add_lifecycle_set_storage_class_rulecKs$t|j}|tf|||_dS)aTAdd a "abort incomplete multipart upload" rule to lifecycle rules. .. note:: The "age" lifecycle condition is the only supported condition for this rule. This defines a [lifecycle configuration](https://cloud.google.com/storage/docs/lifecycle), which is set on the bucket. For the general format of a lifecycle configuration, see the [bucket resource representation for JSON](https://cloud.google.com/storage/docs/json_api/v1/buckets). :type kw: dict :params kw: arguments passed to :class:`LifecycleRuleConditions`. N)rrTrXrrYr-r-r44add_lifecycle_abort_incomplete_multipart_upload_rule s z;Bucket.add_lifecycle_abort_incomplete_multipart_upload_rulercCs|jS)arRetrieve location configured for this bucket. See https://cloud.google.com/storage/docs/json_api/v1/buckets and https://cloud.google.com/storage/docs/locations Returns ``None`` if the property has not been set before creation, or if the bucket's resource has not been loaded from the server. :rtype: str or ``NoneType`` ) _locationrer-r-r4r s zBucket.locationcCstjttdd||_dS)a(Deprecated) Set `Bucket.location` This can only be set at bucket **creation** time. See https://cloud.google.com/storage/docs/json_api/v1/buckets and https://cloud.google.com/storage/docs/bucket-locations .. warning:: Assignment to 'Bucket.location' is deprecated, as it is only valid before the bucket is created. Instead, pass the location to `Bucket.create`. rrN)rr_LOCATION_SETTER_MESSAGErr]rr-r-r4r scCs|jdi}|dS)aRetrieve the list of regional locations for custom dual-region buckets. See https://cloud.google.com/storage/docs/json_api/v1/buckets and https://cloud.google.com/storage/docs/locations Returns ``None`` if the property has not been set before creation, if the bucket's resource has not been loaded from the server, or if the bucket is not a dual-regions bucket. :rtype: list of str or ``NoneType`` ZcustomPlacementConfigZ dataLocationsr)rOZcustom_placement_configr-r-r4data_locations s zBucket.data_locationscCs |jdS)a Retrieve the location type for the bucket. See https://cloud.google.com/storage/docs/storage-classes :getter: Gets the the location type for this bucket. :rtype: str or ``NoneType`` :returns: If set, one of :attr:`~google.cloud.storage.constants.MULTI_REGION_LOCATION_TYPE`, :attr:`~google.cloud.storage.constants.REGION_LOCATION_TYPE`, or :attr:`~google.cloud.storage.constants.DUAL_REGION_LOCATION_TYPE`, else ``None``. Z locationTyperrer-r-r4 location_type szBucket.location_typecCs|jd}t|S)a#Return info about access logging for this bucket. See https://cloud.google.com/storage/docs/access-logs#status :rtype: dict or None :returns: a dict w/ keys, ``logBucket`` and ``logObjectPrefix`` (if logging is enabled), or None (if not). loggingr<rJr-r-r4 get_logging s zBucket.get_loggingcCs||d}|d|dS)a7Enable access logging for this bucket. See https://cloud.google.com/storage/docs/access-logs :type bucket_name: str :param bucket_name: name of bucket in which to store access logs :type object_prefix: str :param object_prefix: prefix for access log filenames )Z logBucketZlogObjectPrefixraNr)rOrZ object_prefixrKr-r-r4enable_logging s zBucket.enable_loggingcCs|dddS)zyDisable access logging for this bucket. See https://cloud.google.com/storage/docs/access-logs#disabling raNrrer-r-r4disable_logging. szBucket.disable_loggingcCs |jd}|dk rt|SdS)a/Retrieve the metageneration for the bucket. See https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: int or ``NoneType`` :returns: The metageneration of the bucket or ``None`` if the bucket's resource has not been loaded from the server. metagenerationNr)rOrfr-r-r4rf5 s zBucket.metagenerationcCst|jdS)a1Retrieve info about the owner of the bucket. See https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: dict or ``NoneType`` :returns: Mapping of owner's role/ID. Returns ``None`` if the bucket's resource has not been loaded from the server. owner)rrrr/rer-r-r4rgC s z Bucket.ownercCs |jd}|dk rt|SdS)aNRetrieve the number of the project to which the bucket is assigned. See https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: int or ``NoneType`` :returns: The project number that owns the bucket or ``None`` if the bucket's resource has not been loaded from the server. Z projectNumberNr)rOproject_numberr-r-r4rhO s zBucket.project_numbercCs2|jd}|dk r.|d}|dk r.t|SdS)a"Retrieve the effective time of the bucket's retention policy. :rtype: datetime.datetime or ``NoneType`` :returns: point-in time at which the bucket's retention policy is effective, or ``None`` if the property is not set locally. retentionPolicyN effectiveTimer)rOr3 timestampr-r-r4retention_policy_effective_time] s  z&Bucket.retention_policy_effective_timecCs"|jd}|dk r|dSdS)aRetrieve whthere the bucket's retention policy is locked. :rtype: bool :returns: True if the bucket's policy is locked, or else False if the policy is not locked, or the property is not set locally. riNisLockedrrOr-r-r4retention_policy_lockedl s zBucket.retention_policy_lockedcCs2|jd}|dk r.|d}|dk r.t|SdS)a"Retrieve or set the retention period for items in the bucket. :rtype: int or ``NoneType`` :returns: number of seconds to retain items after upload or release from event-based lock, or ``None`` if the property is not set locally. riNretentionPeriodr)rOr3Zperiodr-r-r4retention_periody s  zBucket.retention_periodcCs8|jdi}|dk r$t||d<nd}|d|dS)aSet the retention period for items in the bucket. :type value: int :param value: number of seconds to retain items after upload or release from event-based lock. :raises ValueError: if the bucket's retention policy is locked. riNro)rrr r)rOrr3r-r-r4rp s cCs |jdS)a Retrieve the URI for the bucket. See https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: str or ``NoneType`` :returns: The self link for the bucket or ``None`` if the bucket's resource has not been loaded from the server. ZselfLinkrrer-r-r4 self_link s zBucket.self_linkcCs |jdS)aRetrieve or set the storage class for the bucket. See https://cloud.google.com/storage/docs/storage-classes :setter: Set the storage class for this bucket. :getter: Gets the the storage class for this bucket. :rtype: str or ``NoneType`` :returns: If set, one of :attr:`~google.cloud.storage.constants.NEARLINE_STORAGE_CLASS`, :attr:`~google.cloud.storage.constants.COLDLINE_STORAGE_CLASS`, :attr:`~google.cloud.storage.constants.ARCHIVE_STORAGE_CLASS`, :attr:`~google.cloud.storage.constants.STANDARD_STORAGE_CLASS`, :attr:`~google.cloud.storage.constants.MULTI_REGIONAL_LEGACY_STORAGE_CLASS`, :attr:`~google.cloud.storage.constants.REGIONAL_LEGACY_STORAGE_CLASS`, or :attr:`~google.cloud.storage.constants.DURABLE_REDUCED_AVAILABILITY_LEGACY_STORAGE_CLASS`, else ``None``. r~rrer-r-r4r szBucket.storage_classcCs|d|dS)aSet the storage class for the bucket. See https://cloud.google.com/storage/docs/storage-classes :type value: str :param value: One of :attr:`~google.cloud.storage.constants.NEARLINE_STORAGE_CLASS`, :attr:`~google.cloud.storage.constants.COLDLINE_STORAGE_CLASS`, :attr:`~google.cloud.storage.constants.ARCHIVE_STORAGE_CLASS`, :attr:`~google.cloud.storage.constants.STANDARD_STORAGE_CLASS`, :attr:`~google.cloud.storage.constants.MULTI_REGIONAL_LEGACY_STORAGE_CLASS`, :attr:`~google.cloud.storage.constants.REGIONAL_LEGACY_STORAGE_CLASS`, or :attr:`~google.cloud.storage.constants.DURABLE_REDUCED_AVAILABILITY_LEGACY_STORAGE_CLASS`, r~Nrrr-r-r4r scCs |jd}|dk rt|SdS)axRetrieve the timestamp at which the bucket was created. See https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: Datetime object parsed from RFC3339 valid timestamp, or ``None`` if the bucket's resource has not been loaded from the server. Z timeCreatedNrrr-r-r4 time_created s zBucket.time_createdcCs |jd}|dk rt|SdS)a}Retrieve the timestamp at which the bucket was last updated. See https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: Datetime object parsed from RFC3339 valid timestamp, or ``None`` if the bucket's resource has not been loaded from the server. updatedNrrr-r-r4rs s zBucket.updatedcCs|jdi}|ddS)a]Is versioning enabled for this bucket? See https://cloud.google.com/storage/docs/object-versioning for details. :setter: Update whether versioning is enabled for this bucket. :getter: Query whether versioning is enabled for this bucket. :rtype: bool :returns: True if enabled, else False. versioningrFrrOrtr-r-r4versioning_enabled s zBucket.versioning_enabledcCs|ddt|idS)zEnable versioning for this bucket. See https://cloud.google.com/storage/docs/object-versioning for details. :type value: convertible to boolean :param value: should versioning be enabled for the bucket? rtrNrrrr-r-r4rv s cCs|jdi}|ddS)aDoes the requester pay for API requests for this bucket? See https://cloud.google.com/storage/docs/requester-pays for details. :setter: Update whether requester pays for this bucket. :getter: Query whether requester pays for this bucket. :rtype: bool :returns: True if requester pays for API requests for the bucket, else False. billing requesterPaysFrrur-r-r4requester_pays szBucket.requester_payscCs|ddt|idS)aUpdate whether requester pays for API requests for this bucket. See https://cloud.google.com/storage/docs/using-requester-pays for details. :type value: convertible to boolean :param value: should requester pay for API requests for the bucket? rxryNrwrr-r-r4rz s cCs|jdi}|ddS)aWWhether Autoclass is enabled for this bucket. See https://cloud.google.com/storage/docs/using-autoclass for details. :setter: Update whether autoclass is enabled for this bucket. :getter: Query whether autoclass is enabled for this bucket. :rtype: bool :returns: True if enabled, else False. autoclassrFrrOr{r-r-r4autoclass_enabled) s zBucket.autoclass_enabledcCs*|jdi}t||d<|d|dS)a:Enable or disable Autoclass at the bucket-level. See https://cloud.google.com/storage/docs/using-autoclass for details. :type value: convertible to boolean :param value: If true, enable Autoclass for this bucket. If false, disable Autoclass for this bucket. r{rNrr/rrrOrr{r-r-r4r}8 s  cCs2|jd}|dk r.|d}|dk r.t|SdS)a Retrieve the toggle time when Autoclaass was last enabled or disabled for the bucket. :rtype: datetime.datetime or ``NoneType`` :returns: point-in time at which the bucket's autoclass is toggled, or ``None`` if the property is not set locally. r{NZ toggleTimerrOr{rkr-r-r4autoclass_toggle_timeF s   zBucket.autoclass_toggle_timecCs|jdi}|ddS)aThe storage class that objects in an Autoclass bucket eventually transition to if they are not read for a certain length of time. Valid values are NEARLINE and ARCHIVE. See https://cloud.google.com/storage/docs/using-autoclass for details. :setter: Set the terminal storage class for Autoclass configuration. :getter: Get the terminal storage class for Autoclass configuration. :rtype: str :returns: The terminal storage class if Autoclass is enabled, else ``None``. r{terminalStorageClassNrr|r-r-r4 autoclass_terminal_storage_classR s z'Bucket.autoclass_terminal_storage_classcCs&|jdi}||d<|d|dS)aqThe storage class that objects in an Autoclass bucket eventually transition to if they are not read for a certain length of time. Valid values are NEARLINE and ARCHIVE. See https://cloud.google.com/storage/docs/using-autoclass for details. :type value: str :param value: The only valid values are `"NEARLINE"` and `"ARCHIVE"`. r{rNr;rr-r-r4rb s cCs2|jd}|dk r.|d}|dk r.t|SdS)a&The time at which the Autoclass terminal_storage_class field was last updated for this bucket :rtype: datetime.datetime or ``NoneType`` :returns: point-in time at which the bucket's terminal_storage_class is last updated, or ``None`` if the property is not set locally. r{NZterminalStorageClassUpdateTimerrr-r-r4,autoclass_terminal_storage_class_update_timep s   z3Bucket.autoclass_terminal_storage_class_update_timecCs"|jd}|dk r|dSdS)zRetrieve the object retention mode set on the bucket. :rtype: str :returns: When set to Enabled, retention configurations can be set on objects in the bucket. ZobjectRetentionNmoder)rOZobject_retentionr-r-r4object_retention_mode| s zBucket.object_retention_modecCs|jdi}|dS)a.Whether hierarchical namespace is enabled for this bucket. :setter: Update whether hierarchical namespace is enabled for this bucket. :getter: Query whether hierarchical namespace is enabled for this bucket. :rtype: bool :returns: True if enabled, else False. hierarchicalNamespacerr)rOhnsr-r-r4hierarchical_namespace_enabled s z%Bucket.hierarchical_namespace_enabledcCs*|jdi}t||d<|d|dS)aEnable or disable hierarchical namespace at the bucket-level. :type value: convertible to boolean :param value: If true, enable hierarchical namespace for this bucket. If false, disable hierarchical namespace for this bucket. .. note:: To enable hierarchical namespace, you must set it at bucket creation time. Currently, hierarchical namespace configuration cannot be changed after bucket creation. rrNr~)rOrrr-r-r4r s  cCs||d}|d|dS)aConfigure website-related properties. See https://cloud.google.com/storage/docs/static-website .. note:: This configures the bucket's website-related properties,controlling how the service behaves when accessing bucket contents as a web site. See [tutorials](https://cloud.google.com/storage/docs/hosting-static-website) and [code samples](https://cloud.google.com/storage/docs/samples/storage-define-bucket-website-configuration#storage_define_bucket_website_configuration-python) for more information. :type main_page_suffix: str :param main_page_suffix: The page to use as the main page of a directory. Typically something like index.html. :type not_found_page: str :param not_found_page: The file to use when a page isn't found. )ZmainPageSuffixZ notFoundPageZwebsiteNr)rOZmain_page_suffixZnot_found_pagerr-r-r4configure_website s zBucket.configure_websitecCs |ddS)zDisable the website configuration for this bucket. This is really just a shortcut for setting the website-related attributes to ``None``. N)rrer-r-r4disable_website szBucket.disable_websitec Csztddf||}i}|jdk r.|j|d<|dk r>||d<|j|jd|||dd}t|W5QRSQRXdS)a~Retrieve the IAM policy for the bucket. See [API reference docs](https://cloud.google.com/storage/docs/json_api/v1/buckets/getIamPolicy) and a [code sample](https://cloud.google.com/storage/docs/samples/storage-view-bucket-iam-members#storage_view_bucket_iam_members-python). If :attr:`user_project` is set, bills the API request to that project. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type requested_policy_version: int or ``NoneType`` :param requested_policy_version: (Optional) The version of IAM policies to request. If a policy with a condition is requested without setting this, the server will return an error. This must be set to a value of 3 to retrieve IAM policies containing conditions. This is to prevent client code that isn't aware of IAM conditions from interpreting and modifying policies incorrectly. The service might return a policy with version lower than the one that was requested, based on the feature syntax in the policy fetched. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :rtype: :class:`google.api_core.iam.Policy` :returns: the policy instance, based on the resource returned from the ``getIamPolicy`` API request. zStorage.Bucket.getIamPolicyrNrZoptionsRequestedPolicyVersion/iamr)rrrrrrr=)rOrZrequested_policy_versionrrrrKr-r-r4get_iam_policy s,     zBucket.get_iam_policyc Cstddn||}i}|jdk r.|j|d<|jd}|}|j|d<|j|||||dd}t|W5QRSQRXdS)aUpdate the IAM policy for the bucket. See https://cloud.google.com/storage/docs/json_api/v1/buckets/setIamPolicy If :attr:`user_project` is set, bills the API request to that project. :type policy: :class:`google.api_core.iam.Policy` :param policy: policy instance used to update bucket's IAM policy. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :rtype: :class:`google.api_core.iam.Policy` :returns: the policy instance, based on the resource returned from the ``setIamPolicy`` API request. zStorage.Bucket.setIamPolicyrNrrZ resourceIdr)rrrrZ to_api_reprZ _put_resourcerr=) rOr3rrrrrrbrKr-r-r4set_iam_policy s"#       zBucket.set_iam_policyc Csttdd`||}d|i}|jdk r2|j|d<|jd}|j||||dd}|dgW5QRSQRXdS)aNAPI call: test permissions See https://cloud.google.com/storage/docs/json_api/v1/buckets/testIamPermissions If :attr:`user_project` is set, bills the API request to that project. :type permissions: list of string :param permissions: the permissions to check :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :rtype: list of string :returns: the permissions returned by the ``testIamPermissions`` API request. z!Storage.Bucket.testIamPermissionsr permissionsNrz/iam/testPermissionsr)rrrrrr/)rOrrrrrrrespr-r-r4test_iam_permissions< s     zBucket.test_iam_permissionsc Cstdd|j|jj|||||d|rn|j}|jsN|j||d||j|||||d|rt|j d|j d||d} t | |j krd|j f} t | | D]"} | j| jj||dqW5QRXd S) aiUpdate bucket's ACL, granting read access to anonymous users. :type recursive: bool :param recursive: If True, this will make all blobs inside the bucket public as well. :type future: bool :param future: If True, this will make all objects created in the future public as well. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type if_metageneration_match: long :param if_metageneration_match: (Optional) Make the operation conditional on whether the blob's current metageneration matches the given value. :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) Make the operation conditional on whether the blob's current metageneration does not match the given value. :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :raises ValueError: If ``recursive`` is True, and the bucket contains more than 256 blobs. This is to prevent extremely long runtime of this method. For such buckets, iterate over the blobs returned by :meth:`list_blobs` and call :meth:`~google.cloud.storage.blob.Blob.make_public` for each blob. zStorage.Bucket.makePublicrrrrfullr rrrrzRefusing to make public recursively with more than %d objects. If you actually want to make every object in this bucket public, iterate through the blobs returned by 'Bucket.list_blobs()' and call 'make_public' on each one.N) rrallZ grant_readr)rloadedrrrrrrL rO recursivefuturerrrrrZdoarrr;r-r-r4 make_publicl sR1  zBucket.make_publicc Cstdd|j|jj|||||d|rn|j}|jsN|j||d||j|||||d|rt|j d|j d||d} t | |j krd|j f} t | | D]"} | j| jj||dqW5QRXd S) alUpdate bucket's ACL, revoking read access for anonymous users. :type recursive: bool :param recursive: If True, this will make all blobs inside the bucket private as well. :type future: bool :param future: If True, this will make all objects created in the future private as well. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type if_metageneration_match: long :param if_metageneration_match: (Optional) Make the operation conditional on whether the blob's current metageneration matches the given value. :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) Make the operation conditional on whether the blob's current metageneration does not match the given value. :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :raises ValueError: If ``recursive`` is True, and the bucket contains more than 256 blobs. This is to prevent extremely long runtime of this method. For such buckets, iterate over the blobs returned by :meth:`list_blobs` and call :meth:`~google.cloud.storage.blob.Blob.make_private` for each blob. zStorage.Bucket.makePrivaterrrrr rzRefusing to make private recursively with more than %d objects. If you actually want to make every object in this bucket private, iterate through the blobs returned by 'Bucket.list_blobs()' and call 'make_private' on each one.N) rrrZ revoke_readr)rrrrrrrrLrr-r-r4 make_private sL0  zBucket.make_privatec Cs||}|j}t||dkr>ttjddtjdd}|d|j ig}t ||d}t t |d}t ||}|j |j|d|dd}|S) aCreate a signed upload policy for uploading objects. This method generates and signs a policy document. You can use [`policy documents`](https://cloud.google.com/storage/docs/xml-api/post-object-forms) to allow visitors to a website to upload files to Google Cloud Storage without giving them direct write access. See a [code sample](https://cloud.google.com/storage/docs/xml-api/post-object-forms#python). :type expiration: datetime :param expiration: (Optional) Expiration in UTC. If not specified, the policy will expire in 1 hour. :type conditions: list :param conditions: A list of conditions as described in the `policy documents` documentation. :type client: :class:`~google.cloud.storage.client.Client` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :rtype: dict :returns: A dictionary of (form field name, form field value) of form fields that should be added to your HTML upload form in order to attach the signature. N)tzinfor )hoursr8) expirationr[zutf-8)r8ZGoogleAccessIdr3 signature)r _credentialsrZensure_signed_credentialsr r replacedatetime timedeltar6rbase64 b64encodejsondumpsencodeZ sign_bytesZ signer_emaildecode) rOr[rr credentialsZpolicy_documentZencoded_policy_documentrrr-r-r4generate_upload_policy,s&  zBucket.generate_upload_policyc Cstddd|jkrtd|jd}|dkr:td|drLtd||}d |ji}|jdk rt|j|d <d |jd }|j|d||||d }| |W5QRXdS)aLock the bucket's retention policy. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the blob's bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :raises ValueError: if the bucket has no metageneration (i.e., new or never reloaded); if the bucket has no retention policy assigned; if the bucket's retention policy is already locked. z"Storage.Bucket.lockRetentionPolicyrrfz6Bucket has no retention policy assigned: try 'reload'?riNrmz,Bucket's retention policy is already locked.ZifMetagenerationMatchrrz/lockRetentionPolicyr) rrrLr/rrfrr6r(r9)rOrrrr3rrr0r-r-r4lock_retention_policybs4        zBucket.lock_retention_policyGEThttpc  Cs|dkrd}n|dkrtd|dk s*| r6| r6td|dkrN||}|j}| rdt||j}d} n | rxt| | }d} n d|j} |dkr||}|j}|dkrt} nt} | || ||| ||dS)aGenerates a signed URL for this bucket. .. note:: If you are on Google Compute Engine, you can't generate a signed URL using GCE service account. If you'd like to be able to generate a signed URL from GCE, you can use a standard service account from a JSON file rather than a GCE service account. If you have a bucket that you want to allow access to for a set amount of time, you can use this method to generate a URL that is only valid within a certain time period. If ``bucket_bound_hostname`` is set as an argument of :attr:`api_access_endpoint`, ``https`` works only if using a ``CDN``. :type expiration: Union[Integer, datetime.datetime, datetime.timedelta] :param expiration: Point in time when the signed URL should expire. If a ``datetime`` instance is passed without an explicit ``tzinfo`` set, it will be assumed to be ``UTC``. :type api_access_endpoint: str :param api_access_endpoint: (Optional) URI base, for instance "https://storage.googleapis.com". If not specified, the client's api_endpoint will be used. Incompatible with bucket_bound_hostname. :type method: str :param method: The HTTP verb that will be used when requesting the URL. :type headers: dict :param headers: (Optional) Additional HTTP headers to be included as part of the signed URLs. See: https://cloud.google.com/storage/docs/xml-api/reference-headers Requests using the signed URL *must* pass the specified header (name and value) with each request for the URL. :type query_parameters: dict :param query_parameters: (Optional) Additional query parameters to be included as part of the signed URLs. See: https://cloud.google.com/storage/docs/xml-api/reference-headers#query :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the blob's bucket. :type credentials: :class:`google.auth.credentials.Credentials` or :class:`NoneType` :param credentials: The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. :type version: str :param version: (Optional) The version of signed credential to create. Must be one of 'v2' | 'v4'. :type virtual_hosted_style: bool :param virtual_hosted_style: (Optional) If true, then construct the URL relative the bucket's virtual hostname, e.g., '.storage.googleapis.com'. Incompatible with bucket_bound_hostname. :type bucket_bound_hostname: str :param bucket_bound_hostname: (Optional) If passed, then construct the URL relative to the bucket-bound hostname. Value can be a bare or with scheme, e.g., 'example.com' or 'http://example.com'. Incompatible with api_access_endpoint and virtual_hosted_style. See: https://cloud.google.com/storage/docs/request-endpoints#cname :type scheme: str :param scheme: (Optional) If ``bucket_bound_hostname`` is passed as a bare hostname, use this value as the scheme. ``https`` will work only when using a CDN. Defaults to ``"http"``. :raises: :exc:`ValueError` when version is invalid or mutually exclusive arguments are used. :raises: :exc:`TypeError` when expiration is not a valid type. :raises: :exc:`AttributeError` if credentials is not an instance of :class:`google.auth.credentials.Signing`. :rtype: str :returns: A signed URL you can use to access the resource until expiration. Nv2)rZv4z%'version' must be either 'v2' or 'v4'zmThe bucket_bound_hostname argument is not compatible with either api_access_endpoint or virtual_hosted_style./)rbrapi_access_endpointmethodrquery_parameters) rLrZ api_endpointrr6rrrrupper)rOrrrrrrrversionZvirtual_hosted_styleZbucket_bound_hostnamerrbhelperr-r-r4generate_signed_urlsXe   zBucket.generate_signed_url)NNN)N)N)NNNN)rc)NN)NN) NNrNNNNNFNr)prirjrkrlrr$r rrrr"rZSTORAGE_CLASSESrr#rZ_LOCATION_TYPESrNrrnrr9rrrrrrrrmrrr;r'rrr(rrr+r0rrrr staticmethodrrrrrr rrrr)r-r.r/r1r5rZdefault_event_based_holdr:rrHrIrLrPrTrVrWrZr[r\r]rr_r`rbrdrerfrgrhrlrnrprqrrrrsrvrzr}rrrrrrrrr*rrrrrrrror-r-r\r4rjs           0  Y M/I6     w  ) ( n a  !   i           ,                                  B : 2 d ^ 7 <rcs^eZdZdZfddZeddZeddZedd Z e j d d Z ed d Z Z S) rNaMap a bucket's soft delete policy. See https://cloud.google.com/storage/docs/soft-delete :type bucket: :class:`Bucket` :param bucket: Bucket for which this instance is the policy. :type retention_duration_seconds: int :param retention_duration_seconds: (Optional) The period of time in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. :type effective_time: :class:`datetime.datetime` :param effective_time: (Optional) When the bucket's soft delete policy is effective. This value should normally only be set by the back-end API. c sNi}|d}||d<|d}|dk r0t|}||d<t|||_dS)Nretention_duration_secondsretentionDurationSecondseffective_timerj)r/rrMrNr)rOr8ryrrrr\r-r4rNIs   zSoftDeletePolicy.__init__cCs||}|||S)aXFactory: construct instance from resource. :type resource: dict :param resource: mapping as returned from API call. :type bucket: :class:`Bucket` :params bucket: Bucket for which this instance is the policy. :rtype: :class:`SoftDeletePolicy` :returns: Instance created from resource. r_rr-r-r4r=Vs  zSoftDeletePolicy.from_api_reprcCs|jSrrrer-r-r4r8gszSoftDeletePolicy.bucketcCs|d}|dk rt|SdS)aDGet the retention duration of the bucket's soft delete policy. :rtype: int or ``NoneType`` :returns: The period of time in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted; Or ``None`` if the property is not set. rN)r/r)rOdurationr-r-r4rps z+SoftDeletePolicy.retention_duration_secondscCs||d<|jd|dS)a Set the retention duration of the bucket's soft delete policy. :type value: int :param value: The period of time in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. rrMNrrr-r-r4r}s cCs|d}|dk rt|SdS)aGet the effective time of the bucket's soft delete policy. :rtype: datetime.datetime or ``NoneType`` :returns: point-in time at which the bucket's soft delte policy is effective, or ``None`` if the property is not set. rjNr)rOrkr-r-r4rs zSoftDeletePolicy.effective_time) rirjrkrlrNrmr=rnr8rrrror-r-r\r4rN6s     rNcKs:|D],\}}|dk rt||krtd|dqdS)a Raise an error if any generation match argument is set and its len differs from the given value. :type expected_len: int :param expected_len: Expected argument length in case it's set. :type generation_match_args: dict :param generation_match_args: Lists, which length must be checked. :raises: :exc:`ValueError` if any argument set, but has an unexpected length. N'z+' length must be the same as 'blobs' length)rDrrL) expected_lenZgeneration_match_argsr6rr-r-r4rs r)Prlrrrr urllib.parserrZgoogle.api_corerZgoogle.cloud._helpersrrZgoogle.cloud.exceptionsrZgoogle.api_core.iamrZgoogle.cloud.storagerZgoogle.cloud.storage._helpersr r r r r rrZgoogle.cloud.storage._signingrrrrZ+google.cloud.storage._opentelemetry_tracingrZgoogle.cloud.storage.aclrrZgoogle.cloud.storage.blobrZgoogle.cloud.storage.constantsrrrrrrrr r!r"r#r$Z!google.cloud.storage.notificationr&r'Zgoogle.cloud.storage.retryr(r)r*r+rrrrr^rr5r<r>rwr?rpr|robjectrrrrNrr-r-r-r4s                                        D" 0e`