(phqSrSSKrSSKrSSKrSSKrSSKJr SSKrSSKJ r SSK J r SSK J r SSK Jr SSKJr SS KJr SS KJr SS KJr SS KJr SS KJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJr SSK J!r! SSK"J#r# SSK"J$r$ SSK%J&r& SSK'J(r( SSK'J)r) SSK'J*r* SSK'J+r+ SSK'J,r, SSK'J-r- SSK'J.r. SS K'J/r/ SS!K'J0r0 SS"K'J1r1 SS#K'J2r2 SS$K'J3r3 SS%K4J5r5 SS&K4J6r6 SS'K7J8r8 SS(K7J9r9 SS)K7J:r: SS*K7J;r; S+rS.r?S/r@S0rAS1rBS2rCS3rD"S4S5\E5rF"S6S7\E5rG"S8S9\E5rH"S:S;\E5rI\J"5rK"S<S=\E5rL"S>S?\5rM"S@SA\E5rNSBrOg)Cz4Create / 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.c[URSS55UlURRUR5 g)a}Grab 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)iteratorpageresponses N/var/www/html/venv/lib/python3.13/site-packages/google/cloud/storage/bucket.py_blobs_page_startr7]s3(,,z267DM T]]+cpURS5n[X RS9nURU5 U$)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)r1rr<_set_properties)r3itemr:blobs r6 _item_to_blobr@ms3" 88F D __ -D Kr8c>[R"XRS9$)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. r;)r' from_api_reprr<)r3r>s r6_item_to_notificationrCs"  + +D IIr8c^\rSrSrSrSU4Sjjr\S5r\S5r \S5r \S5r \S5r \S 5r \S 5r\S 5r\S 5r\S 5r\S5r\S5rSrU=r$)LifecycleRuleConditionsa 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. c V>0n UbXS'UbUR5U S'UbX=S'UbXMS'UbX]S'UbXmS'UbUR5U S'UbXS'U bU R5U S 'U bXS 'U bXS 'U (dU (d [S 5e[[U]U 5 g) Nage createdBeforeisLivematchesStorageClassnumNewerVersionsdaysSinceCustomTimecustomTimeBeforedaysSinceNoncurrentTimenoncurrentTimeBefore matchesPrefix matchesSuffixzSupply at least one condition) isoformat ValueErrorsuperrE__init__)selfrHcreated_beforeis_livematches_storage_classnumber_of_newer_versionsdays_since_custom_timecustom_time_beforedays_since_noncurrent_timenoncurrent_time_beforematches_prefixmatches_suffix_factory conditions __class__s r6rV LifecycleRuleConditions.__init__s ? #u   %*8*B*B*DJ '  #*x ,0E, - # /-E) * ! -0F, -  )-?-I-I-KJ) * % 14N0 1 ! -1G1Q1Q1SJ- .  %*8 '  %*8 ' <= = %t5jAr8c4U"SS9nURU5 U$)zFactory: construct instance from resource. :type resource: dict :param resource: mapping as returned from API call. :rtype: :class:`LifecycleRuleConditions` :returns: Instance created from resource. Trbr2clsresourceinstances r6rB%LifecycleRuleConditions.from_api_repr%!r8c$URS5$)zConditon's age value.rHr1rWs r6rHLifecycleRuleConditions.agesxxr8cXURS5nUb[R"U5$g)z Conditon's created_before value.rINr1rfrom_iso8601_daterWbefores r6rX&LifecycleRuleConditions.created_before"s./*  #55f= = r8c$URS5$)zConditon's 'is_live' value.rJrprqs r6rYLifecycleRuleConditions.is_live)sxx!!r8c$URS5$)z"Conditon's 'matches_prefix' value.rQrprqs r6r`&LifecycleRuleConditions.matches_prefix.xx((r8c$URS5$)z)Conditon's 'matches_storage_class' value.rKrprqs r6rZ-LifecycleRuleConditions.matches_storage_class3xx-..r8c$URS5$)z"Conditon's 'matches_suffix' value.rRrprqs r6ra&LifecycleRuleConditions.matches_suffix8r}r8c$URS5$)z,Conditon's 'number_of_newer_versions' value.rLrprqs r6r[0LifecycleRuleConditions.number_of_newer_versions=sxx*++r8c$URS5$)z*Conditon's 'days_since_custom_time' value.rMrprqs r6r\.LifecycleRuleConditions.days_since_custom_timeBrr8cXURS5nUb[R"U5$g)z&Conditon's 'custom_time_before' value.rNNrtrvs r6r]*LifecycleRuleConditions.custom_time_beforeGs/,-  #55f= = r8c$URS5$)z.Conditon's 'days_since_noncurrent_time' value.rOrprqs r6r^2LifecycleRuleConditions.days_since_noncurrent_timeNsxx122r8cXURS5nUb[R"U5$g)z*Conditon's 'noncurrent_time_before' value.rPNrtrvs r6r_.LifecycleRuleConditions.noncurrent_time_beforeSs/01  #55f= = r8r/) NNNNNNNNNNNF)__name__ __module__ __qualname____firstlineno____doc__rV classmethodrBpropertyrHrXrYr`rZrar[r\r]r^r___static_attributes__ __classcell__rds@r6rErEs&=B "!%##'#5Bn  >> ""))//)),,//>> 33>>r8rEc<^\rSrSrSrU4Sjr\S5rSrU=r $)LifecycleRuleDeletei[zMap a lifecycle rule deleting matching items. :type kw: dict :params kw: arguments passed to :class:`LifecycleRuleConditions`. c Z>[S0UD6nSS0[U5S.n[TU] U5 g)NtypeDeleteaction conditionr/rEdictrUrVrWkwrcrulerds r6rVLifecycleRuleDelete.__init__bs1,2r2 !8,4 ;KL r8c4U"SS9nURU5 U$)zFactory: construct instance from resource. :type resource: dict :param resource: mapping as returned from API call. :rtype: :class:`LifecycleRuleDelete` :returns: Instance created from resource. Trgrhris r6rB!LifecycleRuleDelete.from_api_reprgrnr8r/ rrrrrrVrrBrrrs@r6rr[s!    r8rc<^\rSrSrSrU4Sjr\S5rSrU=r $)LifecycleRuleSetStorageClassivaMap 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 \>[S0UD6nSUS.[U5S.n[TU] U5 g)NSetStorageClass)r storageClassrr/r)rW storage_classrrcrrds r6rV%LifecycleRuleSetStorageClass.__init__s6,2r2 0-Pj)  r8cFUSnU"USSS9nURU5 U$)zFactory: construct instance from resource. :type resource: dict :param resource: mapping as returned from API call. :rtype: :class:`LifecycleRuleSetStorageClass` :returns: Instance created from resource. rrTrgrh)rjrkrrls r6rB*LifecycleRuleSetStorageClass.from_api_reprs0(#vn-=!r8r/rrs@r6rrvs!  r8rc<^\rSrSrSrU4Sjr\S5rSrU=r $)+LifecycleRuleAbortIncompleteMultipartUploadizMap 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 Z>[S0UD6nSS0[U5S.n[TU] U5 g)NrAbortIncompleteMultipartUploadrr/rrs r6rV4LifecycleRuleAbortIncompleteMultipartUpload.__init__s7,2r2 ?@j)  r8c4U"SS9nURU5 U$)zFactory: construct instance from resource. :type resource: dict :param resource: mapping as returned from API call. :rtype: :class:`LifecycleRuleAbortIncompleteMultipartUpload` :returns: Instance created from resource. Trgrhris r6rB9LifecycleRuleAbortIncompleteMultipartUpload.from_api_reprrnr8r/rrs@r6rrs!  r8rc^\rSrSrSr\\\\\4U4Sjjr\S5r\ S5r \ S5r \ RS5r \ S5r \ RS 5r \ S 5r\ S 5r\RS 5r\ S 5rSrU=r$)IAMConfigurationiaDMap 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`. c>U[La8U[La[[5e[R"[ [ SS9 UnU[La8U[La[[5e[R"[[ SS9 UnU[LaSnU[La[nSU0US.nU[La[U5USS'[[U]7U5 Xlg)N stacklevelFenabled)uniformBucketLevelAccesspublicAccessPreventionr lockedTime)_defaultrT_UBLA_BPO_ENABLED_MESSAGEwarningswarn_BPO_ENABLED_MESSAGEDeprecationWarning_UBLA_BPO_LOCK_TIME_MESSAGE_BPO_LOCK_TIME_MESSAGEr"rrUrrV_bucket) rWr<public_access_prevention#uniform_bucket_level_access_enabled'uniform_bucket_level_access_locked_timebucket_policy_only_enabledbucket_policy_only_locked_timedatards r6rVIAMConfiguration.__init__s &X 52(B !:;; MM.0Bq Q2L / ) 96hF !<== MM02DQR S6T 3 .( :27 / #x /'I $>)'?   3( B=Q7>D+ ,\ : .t4 r8c8U"U5nURU5 U$)a Factory: 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. rhrjrkr<rls r6rBIAMConfiguration.from_api_reprv;!r8cUR$zhBucket for which this instance is the policy. :rtype: :class:`Bucket` :returns: the instance's bucket. rrqs r6r<IAMConfiguration.bucket||r8c US$)aSetting 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/rqs r6r)IAMConfiguration.public_access_preventions,--r8cDXS'URRSU5 g)NriamConfigurationr<_patch_propertyrWvalues r6rr's ). %& ##$6=r8cJURS05nURSS5$)zIf set, access checks only use bucket-level IAM policies or above. :rtype: bool :returns: whether the bucket is configured to allow only IAM. rrFrp)rWublas r6r4IAMConfiguration.uniform_bucket_level_access_enabled,s&xx2B7xx 5))r8c|URS05n[U5US'URRSU5 g)Nrrr) setdefaultboolr<r)rWrrs r6rr6s592>u+Y ##$6=r8chURS05nURS5nUb [U5nU$)aDeadline 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. rrr1r)rWrstamps r6r8IAMConfiguration.uniform_bucket_level_access_locked_time<s8xx2B7&  .u5E r8cUR$)zDeprecated alias for :attr:`uniform_bucket_level_access_enabled`. :rtype: bool :returns: whether the bucket is configured to allow only IAM. )rrqs r6r+IAMConfiguration.bucket_policy_only_enabledPs777r8cL[R"[[SS9 Xlg)Nrr)rrrrrrs r6rrYs *,>1M380r8cUR$)zDeprecated 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. )rrqs r6r/IAMConfiguration.bucket_policy_only_locked_time^s;;;r8)rr)rrrrrrrVrrBrr<rsetterrrrrrrrs@r6rrs>"*,408#+'/(T ..$$>%>**)//>0> &88 &&9'9<"S-5r?\S.5r@\@R0S/5r@\S05rA\AR0S15rA\S25rB\S35rC\S45rD\S55rE\S65rF\FR0S75rFS8rGS9rHS:rIS;rJS<rK\>"S=5rL\S>5rM\MR0S?5rM\S@5rN\SA5rOSBrPSlSCjrQSDrR\SE5rS\SF5rT\SG5rU\SH5rV\SI5rW\SJ5rX\XR0SK5rX\SL5rY\SM5rZ\ZR0SN5rZ\SO5r[\SP5r\\SQ5r]\]R0SR5r]\SS5r^\^R0ST5r^\SU5r_\_R0SV5r_\SW5r`\SX5ra\aR0SY5ra\SZ5rb\S[5rc\S\5rd\dR0S]5rdSmS^jreS_rfSS\$\%4S`jrgS\$\h4SajriS\$\%4SbjrjSSS\$SS\(4ScjrkSSS\$SS\(4SdjrlSmSejrmS\$\%4SfjrnSnSgjroShrpU=rq$)oBucketija~A 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. Nc>[U5n[[U]US9 Xl[ U5Ul[U5Ul[5Ul X0l UbX@RS'gg)z2 property :attr:`name` Get the bucket's name. r:N generation) rrUrrV_clientr_aclr_default_object_aclset_label_removals _user_project _properties)rWclientr: user_projectrrds r6rVBucket.__init__sg d# fd$$$/ dO #3D#9 "u)  !-7  \ * "r8c"SURS3$)Nz rrqs r6__repr__Bucket.__repr__s499+Q''r8cUR$)z The client bound to this bucket.)rrqs r6r Bucket.clients||r8c^>URR5 [[U]U5$)zSet the properties for the current object. :type value: dict or :class:`google.cloud.storage.batch._FutureDict` :param value: The properties to be set. )rclearrUrr=)rWrrds r6r=Bucket._set_propertiess) ""$VT2599r8c8URRS5$)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 rporr1rqs r6r  Bucket.rpos##E**r8c(URSU5 g)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" r Nrrs r6r rs UE*r8cUR$)a"Project 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 )rrqs r6rBucket.user_projects!!!r8cVURRS5nUb [U5$g)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. rNrr1int)rWrs r6rBucket.generations/%%)),7  !z? " "r8cVURRS5nUb [U5$g)aIf 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. softDeleteTimeNrr1r)rWsoft_delete_times r6rBucket.soft_delete_time3 ++//0@A  '-.>? ? (r8cVURRS5nUb [U5$g)a If 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. hardDeleteTimeNr)rWhard_delete_times r6r Bucket.hard_delete_timerr8c>[TU]nU$)zDefault query parameters.)rU _query_params)rWparamsrds r6r#Bucket._query_params s& r8cN[U5up4pVnUS:wa [S5eU"X$S9$)aTGet 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)rrT)rjurirschemenetlocpathqueryfrags r6from_uriBucket.from_uris2,-5SM)T T>45 56''r8cd[R"[[SS9 [R XS9$)aGet 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)r(r)rr_FROM_STRING_MESSAGEPendingDeprecationWarningrr.)rjr(rs r6 from_stringBucket.from_string,s(2  *,ERST366r8c [UUUUUUS9$)asFactory 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. )r:r< chunk_sizeencryption_key kms_key_namerr)rW blob_namer6r7r8rs r6r? Bucket.blobHs$J!)%!   r8c "[UUUUUUUUS9$)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&)rWr<r=r>r?r@rArBs r6 notificationBucket.notificationvs) " !'/#-)+  r8c L[SS9 URU5nSS0nURbURUS'[UUUS9 0n [ U UUS9 UR UR UU UUSS 9 SSS5 g ![a SSS5 g f=f!,(df  g=f) aDDetermines 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.existsrfieldsr:N userProjectif_metageneration_matchif_metageneration_not_match) if_etag_matchif_etag_not_match) query_paramsheaderstimeoutretry_target_objectFT)r_require_clientrr r _get_resourcer+r) rWrrOrKrLrIrJrPrMrNs r6exists Bucket.existss^$; <))&1F%f-L  ,.2.?.? ]+ ,(?,G  G #+"3   $$II!-###' %M= [SS9 [[U]UUUUUS9 SSS5 g!,(df  g=f)aSends 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.updaterrrOrIrJrPN)rrUrr2)rWrrOrIrJrPrds r6r2 Bucket.update3s>H$; < &$ &(?,G ' = < [SS9 [[U]UUUUUUUUU S9 SSS5 g!,(df  g=f)aReload 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 projectionrOrKrLrIrJrP soft_deletedN)rrUrreload) rWrrerOrKrLrIrJrPrfrds r6rg Bucket.reload`sJt$; < &$ &%+"3(?,G) ' = < [SS9 UR(a\URRS5 URR S05 URHnSURSU'M [ [U]#UUUUUS9 SSS5 g!,(df  g=f)aSends 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)rrIrJrOrP) rr_changesaddrrrUrpatch)rWrrOrIrJrP removed_labelrds r6rm Bucket.patchsH$: ;## !!(+  ++Hb9%)%9%9M@DD$$X.}=&: &$ %(?,G & < ; ;s BB B%cUR$)zCreate our ACL on demand.)rrqs r6acl Bucket.aclsyyr8cUR$)z&Create our defaultObjectACL on demand.)rrqs r6default_object_aclBucket.default_object_acls'''r8c SU-$)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_names r6 path_helperBucket.path_helpers{""r8cpUR(d [S5eURUR5$)zThe URL path to this bucket.z*Cannot determine path without bucket name.)r:rTryrqs r6r+ Bucket.paths,yyIJ J **r8c [SS9 [SUUUUS.UD6nURUU UUUUU U U U S9 UsSSS5 $![a SSS5 gf=f!,(df  g=f)a 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)r<r:r7r) rrOrKrLif_generation_matchif_generation_not_matchrIrJrPrfNr/)rrrgr)rWr9rr7rrKrLr~rrIrJrOrPrfkwargsr?s r6get_blobBucket.get_blobsp$< =-%   D  !#"/&7(;,C,C0K!- 7> =0 3> =0 1> =s+A?A A AAA A%c[SS9 URU 5n U RUUUUUUUUUU U UU U UUUS9sSSS5 $!,(df  g=f)aReturn 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_delimiterversionsrerF page_sizerOrP match_globinclude_folders_as_prefixesrfN)rrR list_blobs)rWrrrrrrrrrerFrrOrPrrrfrs r6rBucket.list_blobspsqr$> ?))&1F$$'%#)%+E!%#%,G)#%@ ? ?s 0A Ac[SS9 URU5nURS-nURU[UUS9nXlUsSSS5 $!,(df  g=f)aGList 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)rOrPN)rrRr+_list_resourcerCr<)rWrrOrPr+r3s r6list_notificationsBucket.list_notificationssd4$F G))&1F9955D,,% -H #OH G Gs >A A c[SS9 URUS9nURX#US9 UsSSS5 $!,(df  g=f)abGet 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)rB)rrOrPN)rrCrg)rWrBrrOrPrCs r6get_notificationBucket.get_notification%sDB$D E,,_,ML   ve  LF E Es !5 Ac [SS9 URU5n0nURbURUS'[UUUS9 U(ar[ UR UR S-UUUSS95n[U5UR :aS UR 4-n [U 5eURUS UUUSS 9 URURUUUSS 9 SSS5 g!,(df  g=f) 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.deleterNrGrHT)rrrOrPrzRefusing 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().cgNr/)r?s r6Bucket.delete..s$r8)on_errorrrOrPpreserve_generationrMrOrPrQ) rrRrr listr_MAX_OBJECTS_FOR_ITERATIONlenrT delete_blobs_delete_resourcer+) rWforcerrIrJrOrPrMblobsmessages r6delete Bucket.deleteKs"n$; <))&1FL  ,.2.?.? ]+ ,(?,G  OO$($C$Ca$G% '#!% $u: ? ??C88: ;G %W--!!.!#(, "  # # )# $ Y= < ))&1FL  ,.2.?.? ]+ ,3D /0 ,$7(?(?,G+E/M/M3U 99#5EHyy9,x}} >s CC C&c[SS9 URU:HnURUUUUU UUUUUU U U U S9nU(dURUU UU U U U S9 UsSSS5 $!,(df  g=f)aRename 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) rrOr~rrIrJrrrrrP)rrOr~rrIrJrPN)rr:rr)rWr?rrr~rrIrJrrrrrOrP same_namers r6 rename_blobBucket.rename_blob2s`$? @ X-I~~$7(?(?,G+E/M/M3U&H" !#(B,J,J0R=A @ @s A A A+c b[SS9 URU5n0nURbURUS'[UUUUUUU U U S9 [ XS9nUR S-UR -nURUSUU U US9nURU5 UsSSS5 $!,(df  g=f) a 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.moveBlobrNrGrrz /moveTo/o/r) rrRrr rr+r:rr=)rWr?rrr~rrIrJrrrrrOrPrMrr move_results r6 move_blobBucket.move_blobsv$= >))&1FL  ,.2.?.? ]+ ,$7(?(?,G+E/M/M3U 47Hyy</(--?H //)' 0K  $ $[ 1?? > >s B B  B.c d[SS9 URU5n0n URbURU S'UbX sR$A B))&1FL  ,.2.?.? ]+%-7\**0?_-%-7\* ,$7(?(?,G  t4D!0099+X&) 1L   .=C B Bs B B!! B/cURRSS5Vs/sHn[R"U5PM sn$s snf)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. corsr/rr1rrrWpolicys r6r Bucket.cors s;6594D4D4H4HQS4TU4T& f%4TUUUs Ac(URSU5 g)zSet 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. rNr)rWentriess r6rr s VW-r8defaultEventBasedHoldc\URRS05nURS5$)aTRetrieve / 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)rWencryption_configs r6default_kms_key_nameBucket.default_kms_key_name s/!,,00rB $$%899r8chURRS05nXS'URSU5 g)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). rrNrr1r)rWrrs r6rr s7!,,00rB16-. \+<=r8cnURRS5nUc0$[R"U5$)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. rjr)rWrjs r6rj Bucket.labels s32!!%%h/ >I}}V$$r8c[URR5Vs/sHo"PM sn5n[UR5Vs/sHo"PM sn5nURR UR U55UlUR 5VVs0sHup%U[U5_M nnnURS[R"U55 gs snfs snfs snnf)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. rjN) rrjkeysrunion differenceitemsrrrr)rWmappingkexistingincomingvs r6rjr s4;;#3#3#56#5a#5677<<>2>a>23#3399(:M:Mh:WX)091c!f99 Xt}}W'=> 729s C! C&C+c8URRS5$)a&Retrieve 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. etagrrqs r6r Bucket.etag+ s##F++r8c8URRS5$)zRetrieve 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. idrrqs r6r Bucket.id8 s##D))r8cdURRS05n[RX5$)zRetrieve IAM configuration for this bucket. :rtype: :class:`IAMConfiguration` :returns: an instance for managing the bucket's IAM configuration. r)rr1rrBrWinfos r6iam_configurationBucket.iam_configurationD s.##$6;--d99r8cdURRS05n[RX5$)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)rr1SoftDeletePolicyrBrs r6soft_delete_policyBucket.soft_delete_policyN s.!!%%&8"=--f;;r8c## URRS05nURSS5HnUSSnUS:Xa[RU5v M*US:Xa[RU5v MIUS:Xa[ RU5v Mh[ R"S RU5[S S 9 M g 7f) a<Retrieve 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. lifecyclerr/rrrrrzgUnknown lifecycle rule type received: {}. Please upgrade to the latest version of google-cloud-storage.rrN) rr1rrBrrrrformat UserWarning)rWrr action_types r6lifecycle_rulesBucket.lifecycle_rulesZ s6##K4HHVR(Dx.0Kh&)77== 112@@FF @@AOOPTUU }EE  )sCCclUVs/sHn[U5PM nnURSSU05 gs snf)aSet 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. rrN)rr)rWrulesrs r6r r  s5)..d. [65/:/s1c/Ulg)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)r rqs r6clear_lifecycle_rulesBucket.clear_lifecycle_rules s "r8c"UR5$)z+Deprecated alias for clear_lifecycle_rules.)rrqs r6clear_lifecyle_rulesBucket.clear_lifecyle_rules s))++r8c n[UR5nUR[S0UD65 X lg)aVAdd 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`. Nr/)rr appendrrWrrs r6add_lifecycle_delete_rule Bucket.add_lifecycle_delete_rule s/T))* (.2./$r8c p[UR5nUR[U40UD65 X0lg)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)rr rr)rWrrrs r6$add_lifecycle_set_storage_class_rule+Bucket.add_lifecycle_set_storage_class_rule s1T))* 1-F2FG$r8c n[UR5nUR[S0UD65 X lg)a Add 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`. Nr/)rr rrrs r64add_lifecycle_abort_incomplete_multipart_upload_rule;Bucket.add_lifecycle_abort_incomplete_multipart_upload_rule s/T))* @F2FG$r8rYcUR$)aBRetrieve 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`` ) _locationrqs r6rYBucket.location s~~r8cL[R"[[SS9 Xlg)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!rs r6rYr" s  .0BqQr8c\URRS05nURS5$)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`` customPlacementConfig dataLocationsr)rWcustom_placement_configs r6data_locationsBucket.data_locations s0#'"2"2"6"67NPR"S&**?;;r8c8URRS5$)aRetrieve 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``. locationTyperrqs r6 location_typeBucket.location_type s ##N33r8cdURRS5n[R"U5$)zReturn 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). loggingrrs r6 get_loggingBucket.get_logging s)##I.}}T""r8c0XS.nURSU5 g)aEnable 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 ) logBucketlogObjectPrefixr0Nr)rWrx object_prefixrs r6enable_loggingBucket.enable_logging s)K Y-r8c(URSS5 g)ziDisable access logging for this bucket. See https://cloud.google.com/storage/docs/access-logs#disabling r0Nrrqs r6disable_loggingBucket.disable_logging. s Y-r8cVURRS5nUb [U5$g)aRetrieve 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)rWr=s r6r=Bucket.metageneration5 s1))--.>?  %~& & &r8c`[R"URRS55$)a Retrieve 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)rrrr1rqs r6r@ Bucket.ownerC s$}}T--11':;;r8cVURRS5nUb [U5$g)a&Retrieve 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. projectNumberNr)rWproject_numbers r6rDBucket.project_numberO s0))--o>  %~& & &r8cURRS5nUb URS5nUb [U5$gg)zRetrieve 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)rWr timestamps r6retention_policy_effective_time&Bucket.retention_policy_effective_time] sJ!!%%&78   ?3I$1)<<% r8cbURRS5nUbURS5$g)zRetrieve 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. rGNisLockedrrs r6retention_policy_lockedBucket.retention_policy_lockedl s5!!%%&78  ::j) ) r8cURRS5nUb URS5nUb [U5$gg)zRetrieve 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. rGNretentionPeriodr)rWrperiods r6retention_periodBucket.retention_periody sJ!!%%&78  ZZ 12F!6{"" r8cURRS05nUb[U5US'OSnURSU5 g)zSet 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. rGNrQ)rrrr)rWrrs r6rSrT sH!!,,->C  (+E F$ %F .7r8c8URRS5$)zRetrieve 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. selfLinkrrqs r6 self_linkBucket.self_link s##J//r8c8URRS5$)a1Retrieve 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``. rrrqs r6rBucket.storage_class s,##N33r8c(URSU5 g)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`, rNrrs r6rr[ s$ ^U3r8cVURRS5nUb [U5$g)aHRetrieve 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. timeCreatedNrrs r6 time_createdBucket.time_created s0  $$]3  -e4 4 r8cVURRS5nUb [U5$g)aMRetrieve 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. updatedNrrs r6rbBucket.updated s0  $$Y/  -e4 4 r8c^URRS05nURSS5$)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. versioningrFrrWres r6versioning_enabledBucket.versioning_enabled s-%%)),; ~~i//r8c>URSS[U505 g)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? rerNrrrs r6rgrh s \ItE{+CDr8c^URRS05nURSS5$)aVDoes 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 requesterPaysFrrfs r6requester_paysBucket.requester_pays s-%%)))R8 ~~ou55r8c>URSS[U505 g)zUpdate 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? rlrmNrjrs r6rnro s Y$u+(FGr8c^URRS05nURSS5$)a'Whether 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. autoclassrFrrWrrs r6autoclass_enabledBucket.autoclass_enabled) s-$$((b9 }}Y..r8c|URRS05n[U5US'URSU5 g)aEnable 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. rrrNrr1rrrWrrrs r6rtru8 s:$$((b9 #E{ ) [)4r8cURRS5nUb URS5nUb [U5$gg)zRetrieve 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. rrN toggleTimerrWrrrIs r6autoclass_toggle_timeBucket.autoclass_toggle_timeF sI $$((5  ! l3I$1)<<% !r8c^URRS05nURSS5$)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``. rrterminalStorageClassNrrss r6 autoclass_terminal_storage_class'Bucket.autoclass_terminal_storage_classR s.$$((b9 }}3T::r8chURRS05nXS'URSU5 g)aIThe 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"`. rrrNrrxs r6rrb s5$$((b9 ,1() [)4r8cURRS5nUb URS5nUb [U5$gg)aThe 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. rrNterminalStorageClassUpdateTimerr{s r6,autoclass_terminal_storage_class_update_time3Bucket.autoclass_terminal_storage_class_update_timep sJ $$((5  ! &FGI$1)<<% !r8cbURRS5nUbURS5$g)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. objectRetentionNmoder)rWobject_retentions r6object_retention_modeBucket.object_retention_mode| s8 ++//0AB  '#''/ / (r8c\URRS05nURS5$)aWhether 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)rWhnss r6hierarchical_namespace_enabled%Bucket.hierarchical_namespace_enabled s,""#:B?wwy!!r8c|URRS05n[U5US'URSU5 g)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. rrNrw)rWrrs r6rr s;""#:B?eI 4c:r8c0XS.nURSU5 g)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. )mainPageSuffix notFoundPagewebsiteNr)rWmain_page_suffixnot_found_pagers r6configure_websiteBucket.configure_website s(#3S Y-r8c&URSS5$)zDisable the website configuration for this bucket. This is really just a shortcut for setting the website-related attributes to ``None``. N)rrqs r6disable_websiteBucket.disable_website s %%dD11r8c "[SS9 URU5n0nURbURUS'UbX%S'URURS3UUUSS9n[ R "U5sSSS5 $!,(df  g=f)aRetrieve 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.getIamPolicyrNrGoptionsRequestedPolicyVersion/iamr)rrRrrSr+rrB)rWrrequested_policy_versionrOrPrMrs r6get_iam_policyBucket.get_iam_policy sX$A B))&1FL  ,.2.?.? ]+'3@X<=''99+T")# (D''-#C B Bs A,B Bc X[SS9 URU5n0nURbURUS'URS3nUR 5nURUS'UR UUUUUSS9n[ R"U5sSSS5 $!,(df  g=f)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.setIamPolicyrNrGr resourceIdr)rrRrr+ to_api_repr _put_resourcerrB) rWrrrOrPrMr+rkrs r6set_iam_policyBucket.set_iam_policy sF$A B))&1FL  ,.2.?.? ]+ii[%D))+H%)YYH\ "'')# (D''-)C B Bs BB B)c [SS9 URU5nSU0nURbURUS'URS3nUR UUUUSS9nUR S/5sSSS5 $!,(df  g=f)aAPI 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 permissionsNrGz/iam/testPermissionsr)rrRrr+rSr1)rWrrrOrPrMr+resps r6test_iam_permissionsBucket.test_iam_permissions< s>$G H))&1F);7L  ,.2.?.? ]+ii[ 45D'')# (D88M2.I H Hs A%A99 Bc [SS9 URR5R5 URR UUUUUS9 U(a]UR nUR (dURX4S9 UR5R5 UR UUUUUS9 U(a[URSURS-UUS95n [U 5UR:aSUR4-n [U 5eU HEn U RR5R5 U RR UUS9 MG S S S 5 g !,(df  g =f) aqUpdate 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.makePublicrrarrOfullrrerrrOzRefusing 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) rrqall grant_readrrtloadedrgrrrrrT rW recursivefuturerrOrIrJrPdoarrr?s r6 make_publicBucket.make_publicl sZb$? @ HHLLN % % ' HHMM(?,G  --zzJJfJ> $$&!#,C0K OO#)$($C$Ca$G% ' $u: ? ??5 88: ;G%W--!DHHLLN--/HHMM% '""UA @ @s EE++ E9c [SS9 URR5R5 URR UUUUUS9 U(a]UR nUR (dURX4S9 UR5R5 UR UUUUUS9 U(a[URSURS-UUS95n [U 5UR:aSUR4-n [U 5eU HDn U RR5R5 U RR X4S9 MF S S S 5 g !,(df  g =f) atUpdate 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.makePrivaterrarrrrzRefusing 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) rrqr revoke_readrrtrrgrrrrrTrs r6 make_privateBucket.make_private sQ`$@ A HHLLN & & ( HHMM(?,G  --zzJJfJ> %%'!#,C0K OO#)$($C$Ca$G% ' $u: ? ??6 88: ;G%W--!DHHLLN..0HHMMMA"UB A As EE** E8cBURU5nURn[R"U5 Uc1[ [ 5R SS9[R"SS9-nUSUR0/-n[U5US.n[R"[R"U5RS55n[R"UR!U55nURUR"UR%S5UR%S5S.nU$) a6Create 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)hoursr<) expirationrczutf-8)r<GoogleAccessIdr signature)rR _credentialsr ensure_signed_credentialsr rreplacedatetime timedeltar:rbase64 b64encodejsondumpsencode sign_bytes signer_emaildecode) rWrcrr credentialspolicy_documentencoded_policy_documentrrFs r6generate_upload_policyBucket.generate_upload_policy,s 4%%f-)) **;7  d++4+88;M;MTU;VVJHdii#8"99 /z:$  #)"2"2 JJ ' . .w 7# $$[%;%;.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. v2)rv4z%'version' must be either 'v2' or 'v4'zmThe bucket_bound_hostname argument is not compatible with either api_access_endpoint or virtual_hosted_style./)rkrapi_access_endpointmethodrNquery_parameters) rTrR api_endpointrr:rrrrupper)rWrrrrNrrrversionvirtual_hosted_stylebucket_bound_hostnamer)rkhelpers r6generate_signed_urlBucket.generate_signed_urlsJ ?G L (DE E +/C#F   &))&1F"("5"5  "@#YY# H ""<%# H499+H  ))&1F --K d?+F+F ! 3<<>-  r8)rrrrr!rr )NNNr)NNNN))NN) NNGETNNNNNFNhttp)rrrrrrrr%r!rrrr#rSTORAGE_CLASSESr r$r_LOCATION_TYPESrVrrrr=r rrrrr r#rr.r3r?r(rCrr)rTr^r,r2rgrmrqrt staticmethodryr+rrrrrrrr*rrrrrrdefault_event_based_holdrrjrrrrr rrrrrr!rYr)r-r1r7r:r=r@rDrJrNrSrXrr_rbrgrnrtr|rrrrrrrr+rrrrrrrrrrs@r6rrjsZ&"% +%9O #!O 48 (:++ ZZ + + " " # # @ @ @ @ ((877< , `* :  $$(Ur&* % IZ $$(7 +^  $$(ER $$(7 4l(( # #++ $ $$( sn#' $(%M`#3=$R  $ P $$( i\ $ $$( \B!  $ $$(@L $ $$(#''+'++/ 3#Z@ $ $$(#''+'++/ 3Nh $ $$(#''+'++/ 3z~ $ $$( 3gRVV8 [[ . . 00GH  : :  >!>%%: ]]??& , , * *:: < <**X ; ;", %%"%$!,I   __" < <44" # .. ' ' < < ' ' = = * * # #88" 0 044.44& 5 5 5 5 0 0 E E66  H H / / 5 5 = = ; ;&,, 5- 5 = = 0 0 " "$** ;+ ;..2!%  =.D + 7.t#'0@ ./d $$(7`H $$(7\B|4n#3=8/x ""W W r8rc^\rSrSrSrU4Sjr\S5r\S5r \S5r \ RS5r \S5r S r U=r$) ri6aXMap 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 >0nURS5nXCS'URS5nUb [U5nXSS'[TU] U5 Xlg)Nretention_duration_secondsretentionDurationSecondseffective_timerH)r1rrUrVr)rWr<rrrrrds r6rVSoftDeletePolicy.__init__IsZ%'VV,H%I"+E '( 01  %1.AN ._  r8c8U"U5nURU5 U$)a Factory: 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. rhrs r6rBSoftDeletePolicy.from_api_reprVrr8cUR$rrrqs r6r<SoftDeletePolicy.bucketgrr8cBURS5nUb [U5$g)aGet 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)r1r)rWdurations r6r+SoftDeletePolicy.retention_duration_secondsps(8867  x=  r8cDXS'URRSU5 g)zSet 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. rrNrrs r6rr}s",1 '( ##$6=r8cBURS5nUb [U5$g)zGet 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. rHNr)rWrIs r6rSoftDeletePolicy.effective_times(HH_-  -i8 8 !r8r)rrrrrrVrrBrr<rrrrrrs@r6rr6sw$   ! ! && >' > 9 9r8rc |UR5H(up#UcM [U5U:wdM[SUS35e g)ap 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)rrrT) expected_lengeneration_match_argsr:rs r6rrs?-224   U|!;q&QRS S5r8)Prrrrr urllib.parserrgoogle.api_corergoogle.cloud._helpersrrgoogle.cloud.exceptionsrgoogle.api_core.iamrgoogle.cloud.storager google.cloud.storage._helpersr r r r rrrgoogle.cloud.storage._signingrrrr+google.cloud.storage._opentelemetry_tracingrgoogle.cloud.storage.aclrrgoogle.cloud.storage.blobrgoogle.cloud.storage.constantsrrrrrrr r!r"r#r$r%!google.cloud.storage.notificationr'r(google.cloud.storage.retryr)r*r+r,rrrrr$r1r7r@rCrrErrrobjectrrrrrr/r8r6rsW;  !,6<,&)AJ.8.:8@@DHI.5*;@ADOEAMH?A@A4LDP: K < M  L , .J(@>d@>F$64D$@ 8l