(ph 6SrSSKrSSKrSSKrSSKrSSKrSSKrSSKrSSKr SSK J r SSK J r SSKJr SSKJr SSKJr SSKJr SS KJr SS KJr SS KJr SS KJr SS KJr SSKJr SSKJr SSKJr SSKJr SSKJr SSKJ r SSK!J"r" SSK#J$r$ SSK%J&r&J'r'J(r(J)r) SSK*J+r+ SSK,J-r-J.r.J/r/ SSK0J1r1 SSK2J3r3 SSK4J5r5 SSK4J6r6 SSK7J8r8 SSK9J:r: \;"5r<"SS \5r=S!r>S"r?g)#z9Client for interacting with the Google Cloud Storage API.N)AnonymousCredentials) page_iterator) _LocalStack)ClientWithProject)NotFound) _add_generation_match_parameters)_bucket_bound_hostname_url)_get_api_endpoint_override)_get_environ_project)_get_storage_emulator_override)_use_client_cert)_virtual_hosted_style_base_url)_DEFAULT_UNIVERSE_DOMAIN)_DEFAULT_SCHEME)_STORAGE_HOST_TEMPLATE)_NOW)_UTC)create_trace_span) Connection)get_expiration_seconds_v4get_v4_now_dtstampsensure_signed_credentials _sign_messageBatch)Bucket _item_to_blob_blobs_page_start)Blob)HMACKeyMetadata) BucketACL)DefaultObjectACL)_DEFAULT_TIMEOUT) DEFAULT_RETRYc^\rSrSrSrSr\SSSSS04SS.U4Sjjjr\S5r \ S 5r \ S 5r \ S 5r \ RS 5r S rSr\ S5rS\\4SjrS+SjrS,SjrSS\\S4SjrSSS\R2S\\4SjrSS\SS4SjrSS\SS4SjrSS\SS4SjrSS\\S4SjrS-Sjr\SS\4SSS.Sjjr \SS\4Sjr!SSSSSSSS\\4 Sjr"SSSSSSSSS\S\4 S jr#SSSSSSSSS!SS\\SSS4S"jr$SSSS!SSS\\4 SS#.S$jjr%S!SS\\4S%jr&SS\S4S&jr'SSSSS\\4S'jr(SS\4S(jr)S.S)jr*S*r+U=r,$)/ClientCas Client to bundle configuration needed for API requests. :type project: str or None :param project: the project which the client acts on behalf of. Will be passed when creating a topic. If not passed, falls back to the default inferred from the environment. :type credentials: :class:`~google.auth.credentials.Credentials` :param credentials: (Optional) The OAuth2 Credentials to use for this client. If not passed (and if no ``_http`` object is passed), falls back to the default inferred from the environment. :type _http: :class:`~requests.Session` :param _http: (Optional) HTTP object to make requests. Can be any object that defines ``request()`` with the same interface as :meth:`requests.Session.request`. If not passed, an ``_http`` object is created that is bound to the ``credentials`` for the current object. This parameter should be considered private, and could change in the future. :type client_info: :class:`~google.api_core.client_info.ClientInfo` :param client_info: The client info used to send a user-agent string along with API requests. If ``None``, then default info will be used. Generally, you only need to set this if you're developing your own library or partner tool. :type client_options: :class:`~google.api_core.client_options.ClientOptions` or :class:`dict` :param client_options: (Optional) Client options used to set user options on the client. A non-default universe domain or api endpoint should be set through client_options. :type use_auth_w_custom_endpoint: bool :param use_auth_w_custom_endpoint: (Optional) Whether authentication is required under custom endpoints. If false, uses AnonymousCredentials and bypasses authentication. Defaults to True. Note this is only used when a custom endpoint is set in conjunction. :type extra_headers: dict :param extra_headers: (Optional) Custom headers to be sent with the requests attached to the client. For example, you can add custom audit logging headers. :type api_key: string :param api_key: (Optional) An API key. Mutually exclusive with any other credentials. This parameter is an alias for setting `client_options.api_key` and will supercede any api key set in the `client_options` parameter. )z7https://www.googleapis.com/auth/devstorage.full_controlz4https://www.googleapis.com/auth/devstorage.read_onlyz5https://www.googleapis.com/auth/devstorage.read_writeNT)api_keyc>SUlUcSn SnOSn U[LaSnX@lXPlXplSU0n U(a0U(a[ U[ 5(dXlO U(d0nXS'U(a>[ U[ 5(a)[RRRU5nU(a#UR(aURUl OSUl [5n [5n U(aUR (a UR n OgU (aU n O]U (aU n OSUR(a@[#5(a [%S5e[&[(R*"URS9-n OSn XS'U (aSOSUlU Sb9UR,(dU(d!Uc [/5nUc [15nUcSn Sn[2[4U]oUUUUS 9 UR8RUR:wa7[%S R+URUR8RS 95eU (aSUl[=U40U D6nX~lXl [C5Ul"g) NTF client_infor(zThe "GOOGLE_API_USE_CLIENT_CERTIFICATE" env variable is set to "true" and a non-default universe domain is configured. mTLS is not supported in any universe other thangoogleapis.com.)universe_domain api_endpoint)project credentialsclient_options_httpzThe configured universe domain ({client_ud}) does not match the universe domain found in the credentials ({cred_ud}). If you haven't configured the universe domain explicitly, `googleapis.com` is the default.) client_udcred_ud)#_base_connection_marker_initial_client_info_initial_client_options_extra_headers isinstancedictr(googleapi_corer0 from_dictr,_universe_domainr r r-r ValueErrorrrformat_is_emulator_setrr superr&__init__ _credentialsr.r extra_headers _connectionr _batch_stack)selfr.r/r1r+r0use_auth_w_custom_endpointrEr( no_projectconnection_kw_argsstorage_emulator_overrideapi_endpoint_overrider- connection __class__s N/var/www/html/venv/lib/python3.13/site-packages/google/cloud/storage/client.pyrCClient.__init__~sY!% ?JGJ g G%0!'5$++[9 j&F&F)0&%%'N,3y) .$//!'!?!?!I!I"" n<<$2$B$BD !$(D !$B$D! : < n99)66L'4L#0L " " !! & +-C-J-J $ 5 5.L L-9>*(Au n - 9$$,F&"6"8K?24G?!%J&G fd$#) %     , ,0D0D D34:6"22 --==4:4   DL ;(:; #0 %'Mc2U"S[5S9nSUlU$)a%Factory: return client with anonymous credentials. .. note:: Such a client has only limited access to "public" buckets: listing their contents and downloading their blobs. :rtype: :class:`google.cloud.storage.client.Client` :returns: Instance w/ anonymous credentials and no project. r*)r.r/N)rr.)clsclients rPcreate_anonymous_clientClient.create_anonymous_clients X3G3IJ rRc4UR=(d [$N)r>rrHs rPr,Client.universe_domain$s$$@(@@rRc.URR$rY)rF API_BASE_URLrZs rPr-Client.api_endpoint(s,,,rRcLURb UR$UR$)zGet connection or batch on the client. :rtype: :class:`google.cloud.storage._http.Connection` :returns: The connection set on the client, or the batch if one is set. ) current_batchr4rZs rPrFClient._connection,s(    )%% %(( (rRc@URb [S5eXlg)adSet connection on the client. Intended to be used by constructor (since the base class calls) self._connection = connection Will raise if the connection is set more than once. :type value: :class:`google.cloud.storage._http.Connection` :param value: The connection set on the client. :raises: :class:`ValueError` if connection has already been set. Nz Connection already set on client)r4r?)rHvalues rPrFra9s"  ,?@ @ %rRc:URRU5 g)zPush a batch onto our stack. "Protected", intended for use by batch context mgrs. :type batch: :class:`google.cloud.storage.batch.Batch` :param batch: newly-active batch N)rGpush)rHbatchs rP _push_batchClient._push_batchJs u%rRc6URR5$)zPop a batch from our stack. "Protected", intended for use by batch context mgrs. :raises: IndexError if the stack is empty. :rtype: :class:`google.cloud.storage.batch.Batch` :returns: the top-most batch/transaction, after removing it. )rGpoprZs rP _pop_batchClient._pop_batchTs  $$&&rRc.URR$)zCurrently-active batch. :rtype: :class:`google.cloud.storage.batch.Batch` or ``NoneType`` (if no batch is active). :returns: The batch at the top of the batch stack. )rGtoprZs rPr`Client.current_batch_s  $$$rRc[SS9 Uc URnSUS3nURXBUS9nUSsSSS5 $!,(df  g=f)adGet the email address of the project's GCS service account :type project: str :param project: (Optional) Project ID to use for retreiving GCS service account email address. Defaults to the client's project. :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: str :returns: service account email address z%Storage.Client.getServiceAccountEmailnameN /projects/z/serviceAccounttimeoutretry email_address)rr. _get_resource)rHr.rurvpath api_responses rPget_service_account_email Client.get_service_account_emailisS*$K L,,y8D--d5-QL0 M L Ls *> A c[UUUUS9$)aXFactory constructor for bucket object. .. note:: This will not make an HTTP request; it simply instantiates a bucket object owned by this client. :type bucket_name: str :param bucket_name: The name of the bucket to be instantiated. :type user_project: str :param user_project: (Optional) The project ID to be billed for API requests made via the bucket. :type generation: int :param generation: (Optional) If present, selects a specific revision of this bucket. :rtype: :class:`google.cloud.storage.bucket.Bucket` :returns: The bucket object created. )rUrr user_project generation)r)rH bucket_namer~rs rPbucket Client.buckets*%!   rRc[XS9$)a<Factory constructor for batch object. .. note:: This will not make an HTTP request; it simply instantiates a batch object owned by this client. :type raise_exception: bool :param raise_exception: (Optional) Defaults to True. If True, instead of adding exceptions to the list of return responses, the final exception will be raised. Note that exceptions are unwrapped after all operations are complete in success or failure, and only the last exception is raised. :rtype: :class:`google.cloud.storage.batch.Batch` :returns: The batch object created. )rUraise_exceptionr)rHrs rPrf Client.batchs"DBBrRc @URRSUUUUUUS9$)aVHelper for bucket / blob methods making API 'GET' calls. Args: path str: The path of the resource to fetch. query_params Optional[dict]: HTTP query parameters to be passed headers Optional[dict]: HTTP headers to be passed timeout (Optional[Union[float, Tuple[float, float]]]): The amount of time, in seconds, to wait for the server response. Can also be passed as a tuple (connect_timeout, read_timeout). See :meth:`requests.Session.request` documentation for details. retry (Optional[Union[google.api_core.retry.Retry, google.cloud.storage.retry.ConditionalRetryPolicy]]): 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_metageneration_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. _target_object (Union[ :class:`~google.cloud.storage.bucket.Bucket`, :class:`~google.cloud.storage.bucket.blob`, ]): Object to which future data is to be applied -- only relevant in the context of a batch. Returns: dict The JSON resource fetched Raises: google.cloud.exceptions.NotFound If the bucket is not found. GETmethodry query_paramsheadersrurv_target_objectrF api_requestrHryrrrurvrs rPrxClient._get_resources8p++%),  rRc SUUS.n [SUU U S9 [R"URRXS9n SSS5 [ R "UW UUUUUUUS9 $!,(df  N*=f)Nr)rryruz.Storage.Client._list_resource_returns_iterator)rrrUrrvrt) rUrry item_to_value page_token max_results extra_params page_start page_size)r functoolspartialrFrr HTTPIterator) rHryrrrrrrrurvkwargsrs rP_list_resourceClient._list_resources  A  $++  ,,gK  ))#'!#%!    s *A!! A/c BURRSUUUUUUUS9$)aHelper for bucket / blob methods making API 'PATCH' calls. Args: path str: The path of the resource to fetch. data dict: The data to be patched. query_params Optional[dict]: HTTP query parameters to be passed headers Optional[dict]: HTTP headers to be passed timeout (Optional[Union[float, Tuple[float, float]]]): The amount of time, in seconds, to wait for the server response. Can also be passed as a tuple (connect_timeout, read_timeout). See :meth:`requests.Session.request` documentation for details. retry (Optional[Union[google.api_core.retry.Retry, google.cloud.storage.retry.ConditionalRetryPolicy]]): 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_metageneration_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. _target_object (Union[ :class:`~google.cloud.storage.bucket.Bucket`, :class:`~google.cloud.storage.bucket.blob`, ]): Object to which future data is to be applied -- only relevant in the context of a batch. Returns: dict The JSON resource fetched Raises: google.cloud.exceptions.NotFound If the bucket is not found. PATCHrrydatarrrurvrrrHryrrrrurvrs rP_patch_resourceClient._patch_resources;x++%),  rRc BURRSUUUUUUUS9$)aHelper for bucket / blob methods making API 'PUT' calls. Args: path str: The path of the resource to fetch. data dict: The data to be patched. query_params Optional[dict]: HTTP query parameters to be passed headers Optional[dict]: HTTP headers to be passed timeout (Optional[Union[float, Tuple[float, float]]]): The amount of time, in seconds, to wait for the server response. Can also be passed as a tuple (connect_timeout, read_timeout). See :meth:`requests.Session.request` documentation for details. retry (Optional[Union[google.api_core.retry.Retry, google.cloud.storage.retry.ConditionalRetryPolicy]]): 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_metageneration_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. _target_object (Union[ :class:`~google.cloud.storage.bucket.Bucket`, :class:`~google.cloud.storage.bucket.blob`, ]): Object to which future data is to be applied -- only relevant in the context of a batch. Returns: dict The JSON resource fetched Raises: google.cloud.exceptions.NotFound If the bucket is not found. PUTrrrs rP _put_resourceClient._put_resourceds;x++%),  rRc BURRSUUUUUUUS9$)aHelper for bucket / blob methods making API 'POST' calls. Args: path str: The path of the resource to which to post. data dict: The data to be posted. query_params Optional[dict]: HTTP query parameters to be passed headers Optional[dict]: HTTP headers to be passed timeout (Optional[Union[float, Tuple[float, float]]]): The amount of time, in seconds, to wait for the server response. Can also be passed as a tuple (connect_timeout, read_timeout). See :meth:`requests.Session.request` documentation for details. retry (Optional[Union[google.api_core.retry.Retry, google.cloud.storage.retry.ConditionalRetryPolicy]]): 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_metageneration_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. _target_object (Union[ :class:`~google.cloud.storage.bucket.Bucket`, :class:`~google.cloud.storage.bucket.blob`, ]): Object to which future data is to be applied -- only relevant in the context of a batch. Returns: dict The JSON resource returned from the post. Raises: google.cloud.exceptions.NotFound If the bucket is not found. POSTrrrs rP_post_resourceClient._post_resources;z++%),  rRc @URRSUUUUUUS9$)aZHelper for bucket / blob methods making API 'DELETE' calls. Args: path str: The path of the resource to delete. query_params Optional[dict]: HTTP query parameters to be passed headers Optional[dict]: HTTP headers to be passed timeout (Optional[Union[float, Tuple[float, float]]]): The amount of time, in seconds, to wait for the server response. Can also be passed as a tuple (connect_timeout, read_timeout). See :meth:`requests.Session.request` documentation for details. retry (Optional[Union[google.api_core.retry.Retry, google.cloud.storage.retry.ConditionalRetryPolicy]]): 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_metageneration_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. _target_object (Union[ :class:`~google.cloud.storage.bucket.Bucket`, :class:`~google.cloud.storage.bucket.blob`, ]): Object to which future data is to be applied -- only relevant in the context of a batch. Returns: dict The JSON resource fetched Raises: google.cloud.exceptions.NotFound If the bucket is not found. DELETErrrs rP_delete_resourceClient._delete_resources8p++%),  rRc[U[5(a)U(a [S5eUnURcXlU$[XUS9nU$)aHelper to return given bucket or create new by name. Args: bucket_or_name (Union[ :class:`~google.cloud.storage.bucket.Bucket`, str, ]): The bucket resource to pass or name to create. generation (Optional[int]): The bucket generation. If generation is specified, bucket_or_name must be a name (str). Returns: google.cloud.storage.bucket.Bucket The newly created bucket or the given one. zThe generation can only be specified if a name is used to specify a bucket, not a Bucket object. Create a new Bucket object with the correct generation instead.)rrr)r9rr?rU_client)rHbucket_or_namerrs rP_bucket_arg_to_bucketClient._bucket_arg_to_bucket5sV" nf - -  $F}}$!% D*MF rR)r soft_deletedc [SS9 URXS9nURUUUUUUS9 UsSSS5 $!,(df  g=f)a Retrieve a bucket via a GET request. See [API reference docs](https://cloud.google.com/storage/docs/json_api/v1/buckets/get) and a [code sample](https://cloud.google.com/storage/docs/samples/storage-get-bucket-metadata#storage_get_bucket_metadata-python). Args: bucket_or_name (Union[ :class:`~google.cloud.storage.bucket.Bucket`, str, ]): The bucket resource to pass or name to create. timeout (Optional[Union[float, Tuple[float, float]]]): The amount of time, in seconds, to wait for the server response. Can also be passed as a tuple (connect_timeout, read_timeout). See :meth:`requests.Session.request` documentation for details. if_metageneration_match (Optional[int]): Make the operation conditional on whether the bucket's current metageneration matches the given value. if_metageneration_not_match (Optional[int]): Make the operation conditional on whether the bucket's current metageneration does not match the given value. retry (Optional[Union[google.api_core.retry.Retry, google.cloud.storage.retry.ConditionalRetryPolicy]]): 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_metageneration_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. generation (Optional[int]): The generation of the bucket. The generation can be used to specify a specific soft-deleted version of the bucket, in conjunction with the ``soft_deleted`` argument below. If ``soft_deleted`` is not True, the generation is unused. soft_deleted (Optional[bool]): 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`` is required if ``soft_deleted`` is set to True. See: https://cloud.google.com/storage/docs/soft-delete Returns: google.cloud.storage.bucket.Bucket The bucket matching the name provided. Raises: google.cloud.exceptions.NotFound If the bucket is not found. zStorage.Client.getBucketrq)r)rUruif_metageneration_matchif_metageneration_not_matchrvrN)rrreload) rHrrurrrvrrrs rP get_bucketClient.get_bucketUsVN$> ?///VF MM(?,G)  @ ? ?s %9 Ac [SS9 URUUUUUS9sSSS5 $![a SSS5 gf=f!,(df  g=f)a~Get a bucket by name, returning None if not found. You can use this if you would rather check for a None value than catching a NotFound exception. :type bucket_name: str :param bucket_name: The name of the bucket to get. :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` :rtype: :class:`google.cloud.storage.bucket.Bucket` or ``NoneType`` :returns: The bucket matching the name provided or None if not found. zStorage.Client.lookupBucketrq)rurrrvN)rrr)rHrrurrrvs rP lookup_bucketClient.lookup_bucketscH$A B #,C0K 'C B C B C Bs!A( =A=A AFc [SS9 URU5n 0n Uc URnUR(aUc [ 5nUcSnUbSU0n Ub [ R "S[SS9 X,lUb[R"U5nX}S 'Ub[R"U5nUU S 'UbXMS 'U (aXS 'U RVs0sHoU RU_M nnU RUS 'UbX_S'UbSU0US'URSUU U U U S9nU R!U5 U sSSS5 $s snf!,(df  g=f)a Create a new bucket via a POST request. See [API reference docs](https://cloud.google.com/storage/docs/json_api/v1/buckets/insert) and a [code sample](https://cloud.google.com/storage/docs/samples/storage-create-bucket#storage_create_bucket-python). Args: bucket_or_name (Union[ :class:`~google.cloud.storage.bucket.Bucket`, str, ]): The bucket resource to pass or name to create. requester_pays (bool): DEPRECATED. Use Bucket().requester_pays instead. (Optional) Whether requester pays for API requests for this bucket and its blobs. project (str): (Optional) The project under which the bucket is to be created. If not passed, uses the project set on the client. user_project (str): (Optional) The project ID to be billed for API requests made via created bucket. location (str): (Optional) The location of the bucket. If not passed, the default location, US, will be used. If specifying a dual-region, `data_locations` should be set in conjunction. See: https://cloud.google.com/storage/docs/locations data_locations (list of str): (Optional) The list of regional locations of a custom dual-region bucket. Dual-regions require exactly 2 regional locations. See: https://cloud.google.com/storage/docs/locations predefined_acl (str): (Optional) Name of predefined ACL to apply to bucket. See: https://cloud.google.com/storage/docs/access-control/lists#predefined-acl predefined_default_object_acl (str): (Optional) Name of predefined ACL to apply to bucket's objects. See: https://cloud.google.com/storage/docs/access-control/lists#predefined-acl enable_object_retention (bool): (Optional) Whether object retention should be enabled on this bucket. See: https://cloud.google.com/storage/docs/object-lock timeout (Optional[Union[float, Tuple[float, float]]]): The amount of time, in seconds, to wait for the server response. Can also be passed as a tuple (connect_timeout, read_timeout). See :meth:`requests.Session.request` documentation for details. retry (Optional[Union[google.api_core.retry.Retry, google.cloud.storage.retry.ConditionalRetryPolicy]]): 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_metageneration_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. Returns: google.cloud.storage.bucket.Bucket The newly created bucket. Raises: google.cloud.exceptions.Conflict If the bucket already exists. zStorage.Client.createBucketrqNr*r.zFrequester_pays arg is deprecated. Use Bucket().requester_pays instead.) stacklevel predefinedAclpredefinedDefaultObjectAcl userProjectenableObjectRetentionrrlocation dataLocationscustomPlacementConfig/b)rrurvr)rrr.rAr warningswarnPendingDeprecationWarningrequester_paysr!validate_predefinedr"_changes _propertiesrrr_set_properties)rHrrr.r~rdata_locationspredefined_aclpredefined_default_object_aclenable_object_retentionrurvrrkey propertiesrzs rP create_bucketClient.create_buckets`$A B//?FL,,$$?24G?&G" )73 ) \-  )7%)!*!>!>~!N0>_-,80@0T0T11- 20'.:]+&8O45BH//R/3v11#66/JR!'Jv #)1:&)7F6W 23..)% /L  " "< 0AC BZS[C BsC EE.AEE Eautoc[SS9 [U[5(d[R"U5nUR UUUUUUUUU U U U U US9 SSS5 g!,(df  g=f)a Download the contents of a blob object or blob URI into a file-like object. See https://cloud.google.com/storage/docs/downloading-objects Args: blob_or_uri (Union[ :class:`~google.cloud.storage.blob.Blob`, str, ]): The blob resource to pass or URI to download. file_obj (file): A file handle to which to write the blob's data. start (int): (Optional) The first byte in a range to be downloaded. end (int): (Optional) The last byte in a range to be downloaded. raw_download (bool): (Optional) If true, download the object without any expansion. if_etag_match (Union[str, Set[str]]): (Optional) See :ref:`using-if-etag-match` if_etag_not_match (Union[str, Set[str]]): (Optional) See :ref:`using-if-etag-not-match` if_generation_match (long): (Optional) See :ref:`using-if-generation-match` if_generation_not_match (long): (Optional) See :ref:`using-if-generation-not-match` if_metageneration_match (long): (Optional) See :ref:`using-if-metageneration-match` if_metageneration_not_match (long): (Optional) See :ref:`using-if-metageneration-not-match` timeout ([Union[float, Tuple[float, float]]]): (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` checksum (str): (Optional) The type of checksum to compute to verify the integrity of the object. The response headers must contain a checksum of the requested type. If the headers lack an appropriate checksum (for instance in the case of transcoded or ranged downloads where the remote service does not know the correct checksum, including downloads where chunk_size is set) an INFO-level log will be emitted. Supported values are "md5", "crc32c", "auto" and None. The default is "auto", which will try to detect if the C extension for crc32c is installed and fall back to md5 otherwise. retry (google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy) (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_metageneration_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. z!Storage.Client.downloadBlobToFilerq) rUstartend raw_download if_etag_matchif_etag_not_matchif_generation_matchif_generation_not_matchrrruchecksumrvN)rr9rfrom_uri_prep_and_do_download)rH blob_or_urifile_objrrrrrrrrrrurrvs rPdownload_blob_to_fileClient.download_blob_to_filejsst$G Hk400"mmK8  - -)+"3$7(?(?,G! .  I H Hs AA A)noAclc [SS9 URU5nSU 0nUbUUS'UbUUS'UbUUS'UbUUS'UbUUS 'UbUUS 'U bU US 'U bU US 'UbUUS 'UbUUS'URbURUS'URS-nUR U[ UUU[ U U US9 nUUl[5Ul UsSSS5 $!,(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. .. note:: List prefixes (directories) in a bucket using a prefix and delimiter. See a [code sample](https://cloud.google.com/storage/docs/samples/storage-list-files-with-prefix#storage_list_files_with_prefix-python) listing objects using a prefix filter. Args: bucket_or_name (Union[ :class:`~google.cloud.storage.bucket.Bucket`, str, ]): The bucket resource to pass or name to create. max_results (int): (Optional) The maximum number of blobs to return. page_token (str): (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. prefix (str): (Optional) Prefix used to filter blobs. delimiter (str): (Optional) Delimiter, used with ``prefix`` to emulate hierarchy. start_offset (str): (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). end_offset (str): (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). include_trailing_delimiter (boolean): (Optional) If true, objects that end in exactly one instance of ``delimiter`` will have their metadata included in ``items`` in addition to ``prefixes``. versions (bool): (Optional) Whether object versions should be returned as separate blobs. projection (str): (Optional) If used, must be 'full' or 'noAcl'. Defaults to ``'noAcl'``. Specifies the set of properties to return. fields (str): (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 page_size (int): (Optional) Maximum number of blobs to return in each page. Defaults to a value set by the API. timeout (Optional[Union[float, Tuple[float, float]]]): The amount of time, in seconds, to wait for the server response. Can also be passed as a tuple (connect_timeout, read_timeout). See :meth:`requests.Session.request` documentation for details. retry (Optional[Union[google.api_core.retry.Retry, google.cloud.storage.retry.ConditionalRetryPolicy]]): 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_metageneration_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. match_glob (str): (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 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 soft_deleted (bool): (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 Returns: Iterator of all :class:`~google.cloud.storage.blob.Blob` in this bucket matching the arguments. The RPC call returns a response when the iterator is consumed. As part of the response, you'll also get back an iterator.prefixes entity that lists object names up to and including the requested delimiter. Duplicate entries are omitted from this list. zStorage.Client.listBlobsrq projectionNprefix delimiter matchGlob startOffset endOffsetincludeTrailingDelimiterversionsfieldsincludeFoldersAsPrefixes softDeletedrz/o)rrrrrrurv) rrr~ryrrrrsetprefixes)rHrrrrr start_offset end_offsetinclude_trailing_delimiterrrrrrurv match_globinclude_folders_as_prefixesrrrryiterators rP list_blobsClient.list_blobssHP$> ?//?F(*5L!)/ X&$,5 [)%,6 [)'.: ]+%,6 [))5;U 78#+3 Z(!)/ X&*6;V 78'.: ]+""..4.A.A ]+;;%D**%'),#+ H%HO #H i@ ? ?s CC C))rc  &[SS9 0n Uc URnUR(aUc [5nUcSnUbSU0n UbX;S'XKS'UbX[S'U bXS 'UR S [ UUU UUU S 9sSSS5 $!,(df  g=f) a Get all buckets in the project associated to the client. This will not populate the list of blobs available in each bucket. See [API reference docs](https://cloud.google.com/storage/docs/json_api/v1/buckets/list) and a [code sample](https://cloud.google.com/storage/docs/samples/storage-list-buckets#storage_list_buckets-python). :type max_results: int :param max_results: (Optional) The maximum number of buckets to return. :type page_token: str :param page_token: (Optional) If present, return the next batch of buckets, 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) Filter results to buckets whose names begin with this prefix. :type projection: str :param projection: (Optional) Specifies the set of properties to return. If used, must be 'full' or 'noAcl'. Defaults to 'noAcl'. :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 language of each bucket returned: 'items/id,nextPageToken' :type project: str :param project: (Optional) The project whose buckets are to be listed. If not passed, uses the project set on the client. :type page_size: int :param page_size: (Optional) Maximum number of buckets to return in each page. Defaults to a value set by the API. :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, only soft-deleted buckets 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. See: https://cloud.google.com/storage/docs/soft-delete :rtype: :class:`~google.api_core.page_iterator.Iterator` :raises ValueError: if both ``project`` is ``None`` and the client's project is also ``None``. :returns: Iterator of all :class:`~google.cloud.storage.bucket.Bucket` belonging to this project. zStorage.Client.listBucketsrqNr*r.rrrrr)rrrrrurv)rr.rAr r_item_to_bucket) rHrrrrrr.rrurvrrs rP list_bucketsClient.list_bucketssZ$@ AL,,$$?24G?&G" )73 !)/X&)3 &!)/X&'.:]+&&%')#' ;B A As A.B BcX#S.n[UUUS9 URU5n URU RS3SUUUS9n U R U 5 U $)aRestores a soft-deleted bucket. :type bucket_name: str :param bucket_name: The name of the bucket to be restored. :type generation: int :param generation: Selects the specific revision of the bucket. :type projection: str :param projection: (Optional) Specifies the set of properties to return. If used, must be 'full' or 'noAcl'. Defaults to 'noAcl'. if_metageneration_match (Optional[int]): Make the operation conditional on whether the blob's current metageneration matches the given value. if_metageneration_not_match (Optional[int]): 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. Users can configure non-default retry behavior. A ``None`` value will disable retries. See [Configuring Retries](https://cloud.google.com/python/docs/reference/storage/latest/retry_timeout). :rtype: :class:`google.cloud.storage.bucket.Bucket` :returns: The restored Bucket. )rr)rrz/restoreNrrurv)rrrryr) rHrrrrrrurvrrrzs rPrestore_bucketClient.restore_bucket sr\'1K ( $;(C [)**{{m8 $ % +  |, rRc [SS9 Uc URnSUS3nSU0nUbX7S'URUSUUUS9n[U5n US U lUS n X4sSSS5 $!,(df  g=f) a`Create an HMAC key for a service account. :type service_account_email: str :param service_account_email: e-mail address of the service account :type project_id: str :param project_id: (Optional) Explicit project ID for the key. Defaults to the client's project. :type user_project: str :param user_project: (Optional) This parameter is currently ignored. :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_metageneration_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. :rtype: Tuple[:class:`~google.cloud.storage.hmac_key.HMACKeyMetadata`, str] :returns: metadata for the created key, plus the bytes of the key's secret, which is an 40-character base64-encoded string. zStorage.Client.createHmacKeyrqNrs /hmacKeysserviceAccountEmailrrmetadatasecret)rr.rr r) rHservice_account_email project_idr~rurvry qs_paramsrzr rs rPcreate_hmac_keyClient.create_hmac_keyMsV$B C!!\\  |95D.0EFI'+7-(..& /L't,H#/ #;H !(+F#)D C Cs AA$$ A2c [SS9 Uc URnSUS3n0n UbX)S'UbX9S'UbXYS'URU[UU UUS 9sSSS5 $!,(df  g=f) aList HMAC keys for a project. :type max_results: int :param max_results: (Optional) Max number of keys to return in a given page. :type service_account_email: str :param service_account_email: (Optional) Limit keys to those created by the given service account. :type show_deleted_keys: bool :param show_deleted_keys: (Optional) Included deleted keys in the list. Default is to exclude them. :type project_id: str :param project_id: (Optional) Explicit project ID for the key. Defaults to the client's project. :type user_project: str :param user_project: (Optional) This parameter is currently ignored. :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: Tuple[:class:`~google.cloud.storage.hmac_key.HMACKeyMetadata`, str] :returns: metadata for the created key, plus the bytes of the key's secret, which is an 40-character base64-encoded string. zStorage.Client.listHmacKeysrqNrsr r showDeletedKeysr)rrrurv)rr.r_item_to_hmac_key_metadata) rHrrshow_deleted_keysrr~rurvryrs rPlist_hmac_keysClient.list_hmac_keyssZ$A B!!\\  |95DL$06K23 ,2C./'.:]+&&*') '!C B Bs AA A&c[SS9 [XX#5nURUS9 UsSSS5 $!,(df  g=f)aReturn a metadata instance for the given HMAC key. :type access_id: str :param access_id: Unique ID of an existing key. :type project_id: str :param project_id: (Optional) Project ID of an existing key. Defaults to client's project. :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 user_project: str :param user_project: (Optional) This parameter is currently ignored. z!Storage.Client.getHmacKeyMetadatarq)ruN)rr r)rH access_idrr~rur s rPget_hmac_key_metadataClient.get_hmac_key_metadatas7($G H&t QH OOGO ,I H Hs1 ?c &U(aU(a [S5eUc UROUnU n U (aU (d[U5 URn [ 5upSR XS9nSU0SU0SU 0SU0S S 0/nU=(d /n0n[ U=(d 0R55H6unnURS 5(aMUUU'URUU05 M8 UU- n[[5RSS 9nUcU[R"S S9-nU[R"[U5S9-n[ R""[$R&"[ UUR)5S-S.R555SS9n[*R,"UR/S55nU (a*U (a#[1UX5n[*R2"U5nOUR5U5n[6R8"U5R;S5nUR=US UU UUR;S5S.5 U(a[?UR@USS9nO(U(a[CX5S3nOUR@SUS3nUUS.$)a\ Generate a V4 signed policy object. Generated policy object allows user to upload objects with a POST request. .. note:: Assumes ``credentials`` implements the :class:`google.auth.credentials.Signing` interface. Also assumes ``credentials`` has a ``service_account_email`` property which identifies the credentials. See a [code sample](https://github.com/googleapis/python-storage/blob/main/samples/snippets/storage_generate_signed_post_policy_v4.py). :type bucket_name: str :param bucket_name: Bucket name. :type blob_name: str :param blob_name: Object name. :type expiration: Union[Integer, datetime.datetime, datetime.timedelta] :param expiration: Policy expiration time. If a ``datetime`` instance is passed without an explicit ``tzinfo`` set, it will be assumed to be ``UTC``. :type conditions: list :param conditions: (Optional) List of POST policy conditions, which are used to restrict what is allowed in the request. :type fields: dict :param fields: (Optional) Additional elements to include into request. :type credentials: :class:`google.auth.credentials.Signing` :param credentials: (Optional) Credentials object with an associated private key to sign text. :type virtual_hosted_style: bool :param virtual_hosted_style: (Optional) If True, construct the URL relative to the bucket virtual hostname, e.g., '.storage.googleapis.com'. Incompatible with bucket_bound_hostname. :type bucket_bound_hostname: str :param bucket_bound_hostname: (Optional) If passed, construct the URL relative to the bucket-bound hostname. Value can be bare or with a scheme, e.g., 'example.com' or 'http://example.com'. Incompatible with 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 a scheme. ``https`` will work only when using a CDN. Defaults to ``"http"``. :type service_account_email: str :param service_account_email: (Optional) E-mail address of the service account. :type access_token: str :param access_token: (Optional) Access token for a service account. :raises: :exc:`ValueError` when mutually exclusive arguments are used. :rtype: dict :returns: Signed POST policy. zLOnly one of virtual_hosted_style and bucket_bound_hostname can be specified.Nz.{email}/{datestamp}/auto/storage/goog4_request)email datestamprr x-goog-datex-goog-credentialx-goog-algorithmzGOOG4-RSA-SHA256z x-ignore-)tzinfor)hours)secondsZ) conditions expiration),:) separatorszutf-8)rr#r"r!zx-goog-signaturepolicyT)trailing_slash/)urlr)"r?rDr signer_emailrr@sorteditems startswithappendrrreplacedatetime timedeltarjsondumps collections OrderedDict isoformatbase64 b64encodeencoder b64decode sign_bytesbinasciihexlifydecodeupdaterr-r )rHr blob_namer)r(rr/virtual_hosted_stylebucket_bound_hostnameschemer access_token client_email timestampr x_goog_credentialrequired_conditions policy_fieldsrrcnowpolicy_expiresr- str_to_sign signaturesignature_bytesr0s rPgenerate_signed_post_policy_v4%Client.generate_signed_post_policy_v4sZ $9$  ,7+>d''K , #8 %k 2&33L 34 LSST { # I  I & "3 4 !3 4   %2   &,B!5!5!78JC>>+..%* c"!!3,/9 )) 4j   -  x11::Jx11-j9     # #&0&4&>&>&@3&Feg  "  &&v}}W'=>  1%k<WI$..y9O)44[AO$$_5<r.)NN)TrY)NNNFNhttpNN)-__name__ __module__ __qualname____firstlineno____doc__SCOPEr5rC classmethodrVpropertyr,r-rFsetterrgrkr`r#r$r{rrfrxr_do_nothing_page_startrrrrrrrrrrrrrrrrrV__static_attributes__ __classcell__)rOs@rPr&r&Cs1f E N#'T*T*T*l  AA-- ) )&& & '%%$4M1: 8C, @ L 77 $ T E V E V F V @ DF! $$( QQl! $$( .f&* % Pl  $ $$( md#' $(%|@ ssr $$( ?H  ?$F" DN%)tEU<"""e5e5rRr&cvURS5n[URU5nURU5 U$)a.Convert a JSON bucket to the native object. :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 bucket. :rtype: :class:`.Bucket` :returns: The next bucket in the page. rr)getrrUr)ritemrrrs rPrrs5 88F D HOOT *F 4 MrRc<[UR5nXlU$)aConvert a JSON key metadata resource to the native object. :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 key metadata instance. :rtype: :class:`~google.cloud.storage.hmac_key.HMACKeyMetadata` :returns: The next key metadata instance in the page. )r rUr)rrgr s rPrrsx/H OrR)@r]r>rCr;r7rr9rgoogle.api_core.client_optionsr;google.auth.credentialsrgoogle.api_corergoogle.cloud._helpersrgoogle.cloud.clientrgoogle.cloud.exceptionsrgoogle.cloud.storage._helpersrr r r r r rrrrrr+google.cloud.storage._opentelemetry_tracingrgoogle.cloud.storage._httprgoogle.cloud.storage._signingrrrrgoogle.cloud.storage.batchrgoogle.cloud.storage.bucketrrrgoogle.cloud.storage.blobrgoogle.cloud.storage.hmac_keyr google.cloud.storage.aclr!r"google.cloud.storage.constantsr#google.cloud.storage.retryr$objectr5r&rrrRrPr|s@  %8)-1,JDD>H:HB9@..I1 -PP*9.5;4 (O5 O5d:$rR