Package Methods (3.3.1)

Summary of entries of Methods for storage.

google.cloud.storage.retry.is_etag_in_data

  is_etag_in_data 
 ( 
 data 
 ) 
 

Return True if an etag is contained in the request body.

See more: google.cloud.storage.retry.is_etag_in_data

google.cloud.storage.retry.is_etag_in_json

  is_etag_in_json 
 ( 
 data 
 ) 
 

is_etag_in_json is supported for backwards-compatibility reasons only; please use is_etag_in_data instead.

See more: google.cloud.storage.retry.is_etag_in_json

google.cloud.storage.retry.is_generation_specified

  is_generation_specified 
 ( 
 query_params 
 ) 
 

Return True if generation or if_generation_match is specified.

See more: google.cloud.storage.retry.is_generation_specified

google.cloud.storage.retry.is_metageneration_specified

  is_metageneration_specified 
 ( 
 query_params 
 ) 
 

Return True if if_metageneration_match is specified.

See more: google.cloud.storage.retry.is_metageneration_specified

google.cloud.storage.transfer_manager.download_chunks_concurrently

  download_chunks_concurrently 
 ( 
 blob 
 , 
 filename 
 , 
 chunk_size 
 = 
 33554432 
 , 
 download_kwargs 
 = 
 None 
 , 
 deadline 
 = 
 None 
 , 
 worker_type 
 = 
 "process" 
 , 
 max_workers 
 = 
 8 
 , 
 * 
 , 
 crc32c_checksum 
 = 
 True 
 ) 
 

Download a single file in chunks, concurrently.

See more: google.cloud.storage.transfer_manager.download_chunks_concurrently

google.cloud.storage.transfer_manager.download_many

  download_many 
 ( 
 blob_file_pairs 
 , 
 download_kwargs 
 = 
 None 
 , 
 threads 
 = 
 None 
 , 
 deadline 
 = 
 None 
 , 
 raise_exception 
 = 
 False 
 , 
 worker_type 
 = 
 "process" 
 , 
 max_workers 
 = 
 8 
 , 
 * 
 , 
 skip_if_exists 
 = 
 False 
 ) 
 

Download many blobs concurrently via a worker pool.

See more: google.cloud.storage.transfer_manager.download_many

google.cloud.storage.transfer_manager.download_many_to_path

  download_many_to_path 
 ( 
 bucket 
 , 
 blob_names 
 , 
 destination_directory 
 = 
 "" 
 , 
 blob_name_prefix 
 = 
 "" 
 , 
 download_kwargs 
 = 
 None 
 , 
 threads 
 = 
 None 
 , 
 deadline 
 = 
 None 
 , 
 create_directories 
 = 
 True 
 , 
 raise_exception 
 = 
 False 
 , 
 worker_type 
 = 
 "process" 
 , 
 max_workers 
 = 
 8 
 , 
 * 
 , 
 skip_if_exists 
 = 
 False 
 ) 
 

Download many files concurrently by their blob names.

See more: google.cloud.storage.transfer_manager.download_many_to_path

google.cloud.storage.transfer_manager.upload_chunks_concurrently

  upload_chunks_concurrently 
 ( 
 filename 
 , 
 blob 
 , 
 content_type 
 = 
 None 
 , 
 chunk_size 
 = 
 33554432 
 , 
 deadline 
 = 
 None 
 , 
 worker_type 
 = 
 'process' 
 , 
 max_workers 
 = 
 8 
 , 
 * 
 , 
 checksum 
 = 
 'auto' 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Upload a single file in chunks, concurrently.

See more: google.cloud.storage.transfer_manager.upload_chunks_concurrently

google.cloud.storage.transfer_manager.upload_many

  upload_many 
 ( 
 file_blob_pairs 
 , 
 skip_if_exists 
 = 
 False 
 , 
 upload_kwargs 
 = 
 None 
 , 
 threads 
 = 
 None 
 , 
 deadline 
 = 
 None 
 , 
 raise_exception 
 = 
 False 
 , 
 worker_type 
 = 
 "process" 
 , 
 max_workers 
 = 
 8 
 , 
 ) 
 

Upload many files concurrently via a worker pool.

See more: google.cloud.storage.transfer_manager.upload_many

google.cloud.storage.transfer_manager.upload_many_from_filenames

  upload_many_from_filenames 
 ( 
 bucket 
 , 
 filenames 
 , 
 source_directory 
 = 
 "" 
 , 
 blob_name_prefix 
 = 
 "" 
 , 
 skip_if_exists 
 = 
 False 
 , 
 blob_constructor_kwargs 
 = 
 None 
 , 
 upload_kwargs 
 = 
 None 
 , 
 threads 
 = 
 None 
 , 
 deadline 
 = 
 None 
 , 
 raise_exception 
 = 
 False 
 , 
 worker_type 
 = 
 "process" 
 , 
 max_workers 
 = 
 8 
 , 
 * 
 , 
 additional_blob_attributes 
 = 
 None 
 ) 
 

Upload many files concurrently by their filenames.

See more: google.cloud.storage.transfer_manager.upload_many_from_filenames

google.cloud.storage.acl.ACL.add_entity

  add_entity 
 ( 
 entity 
 ) 
 

Add an entity to the ACL.

See more: google.cloud.storage.acl.ACL.add_entity

google.cloud.storage.acl.ACL.all

  all 
 () 
 

Factory method for an Entity representing all users.

See more: google.cloud.storage.acl.ACL.all

google.cloud.storage.acl.ACL.all_authenticated

  all_authenticated 
 () 
 

Factory method for an Entity representing all authenticated users.

See more: google.cloud.storage.acl.ACL.all_authenticated

google.cloud.storage.acl.ACL.clear

  clear 
 ( 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Remove all ACL entries.

See more: google.cloud.storage.acl.ACL.clear

google.cloud.storage.acl.ACL.domain

  domain 
 ( 
 domain 
 ) 
 

Factory method for a domain Entity.

See more: google.cloud.storage.acl.ACL.domain

google.cloud.storage.acl.ACL.entity

  entity 
 ( 
 entity_type 
 , 
 identifier 
 = 
 None 
 ) 
 

Factory method for creating an Entity.

See more: google.cloud.storage.acl.ACL.entity

google.cloud.storage.acl.ACL.entity_from_dict

  entity_from_dict 
 ( 
 entity_dict 
 ) 
 

Build an _ACLEntity object from a dictionary of data.

See more: google.cloud.storage.acl.ACL.entity_from_dict

google.cloud.storage.acl.ACL.get_entities

  get_entities 
 () 
 

Get a list of all Entity objects.

See more: google.cloud.storage.acl.ACL.get_entities

google.cloud.storage.acl.ACL.get_entity

  get_entity 
 ( 
 entity 
 , 
 default 
 = 
 None 
 ) 
 

Gets an entity object from the ACL.

See more: google.cloud.storage.acl.ACL.get_entity

google.cloud.storage.acl.ACL.group

  group 
 ( 
 identifier 
 ) 
 

Factory method for a group Entity.

See more: google.cloud.storage.acl.ACL.group

google.cloud.storage.acl.ACL.has_entity

  has_entity 
 ( 
 entity 
 ) 
 

Returns whether or not this ACL has any entries for an entity.

See more: google.cloud.storage.acl.ACL.has_entity

google.cloud.storage.acl.ACL.reload

  reload 
 ( 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Reload the ACL data from Cloud Storage.

See more: google.cloud.storage.acl.ACL.reload

google.cloud.storage.acl.ACL.reset

  reset 
 () 
 

Remove all entities from the ACL, and clear the loaded flag.

See more: google.cloud.storage.acl.ACL.reset

google.cloud.storage.acl.ACL.save

  save 
 ( 
 acl 
 = 
 None 
 , 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Save this ACL for the current bucket.

See more: google.cloud.storage.acl.ACL.save

google.cloud.storage.acl.ACL.save_predefined

  save_predefined 
 ( 
 predefined 
 , 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Save this ACL for the current bucket using a predefined ACL.

See more: google.cloud.storage.acl.ACL.save_predefined

google.cloud.storage.acl.ACL.user

  user 
 ( 
 identifier 
 ) 
 

Factory method for a user Entity.

See more: google.cloud.storage.acl.ACL.user

google.cloud.storage.acl.ACL.validate_predefined

  validate_predefined 
 ( 
 predefined 
 ) 
 

Ensures predefined is in list of predefined json values .

See more: google.cloud.storage.acl.ACL.validate_predefined

google.cloud.storage.acl.ObjectACL.clear

  clear 
 ( 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Remove all ACL entries.

See more: google.cloud.storage.acl.ObjectACL.clear

google.cloud.storage.acl.ObjectACL.save

  save 
 ( 
 acl 
 = 
 None 
 , 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Save this ACL for the current object.

See more: google.cloud.storage.acl.ObjectACL.save

google.cloud.storage.acl.ObjectACL.save_predefined

  save_predefined 
 ( 
 predefined 
 , 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Save this ACL for the current object using a predefined ACL.

See more: google.cloud.storage.acl.ObjectACL.save_predefined

google.cloud.storage.batch.Batch.current

  current 
 () 
 

Return the topmost batch, or None.

See more: google.cloud.storage.batch.Batch.current

google.cloud.storage.batch.Batch.finish

  finish 
 ( 
 raise_exception 
 = 
 True 
 ) 
 

Submit a single multipart/mixed request with deferred requests.

See more: google.cloud.storage.batch.Batch.finish

google.cloud.storage.batch.MIMEApplicationHTTP

  MIMEApplicationHTTP 
 ( 
 method 
 , 
 uri 
 , 
 headers 
 , 
 body 
 ) 
 

Create an application/* type MIME document.

See more: google.cloud.storage.batch.MIMEApplicationHTTP

google.cloud.storage.blob.Blob

  Blob 
 ( 
 name 
 , 
 bucket 
 , 
 chunk_size 
 = 
 None 
 , 
 encryption_key 
 = 
 None 
 , 
 kms_key_name 
 = 
 None 
 , 
 generation 
 = 
 None 
 , 
 crc32c_checksum 
 = 
 None 
 , 
 ) 
 

property name Get the blob's name.

See more: google.cloud.storage.blob.Blob

google.cloud.storage.blob.Blob.compose

  compose 
 ( 
 sources 
 , 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_source_generation_match 
 = 
 None 
 , 
 retry 
 = 
 

Concatenate source blobs into this one.

See more: google.cloud.storage.blob.Blob.compose

google.cloud.storage.blob.Blob.create_resumable_upload_session

  create_resumable_upload_session 
 ( 
 content_type 
 = 
 None 
 , 
 size 
 = 
 None 
 , 
 origin 
 = 
 None 
 , 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 checksum 
 = 
 'auto' 
 , 
 predefined_acl 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 retry 
 = 
 

Create a resumable upload session.

See more: google.cloud.storage.blob.Blob.create_resumable_upload_session

google.cloud.storage.blob.Blob.delete

  delete 
 ( 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Deletes a blob from Cloud Storage.

See more: google.cloud.storage.blob.Blob.delete

google.cloud.storage.blob.Blob.download_as_bytes

  download_as_bytes 
 ( 
 client 
 = 
 None 
 , 
 start 
 = 
 None 
 , 
 end 
 = 
 None 
 , 
 raw_download 
 = 
 False 
 , 
 if_etag_match 
 = 
 None 
 , 
 if_etag_not_match 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 checksum 
 = 
 'auto' 
 , 
 retry 
 = 
 

Download the contents of this blob as a bytes object.

See more: google.cloud.storage.blob.Blob.download_as_bytes

google.cloud.storage.blob.Blob.download_as_string

  download_as_string 
 ( 
 client 
 = 
 None 
 , 
 start 
 = 
 None 
 , 
 end 
 = 
 None 
 , 
 raw_download 
 = 
 False 
 , 
 if_etag_match 
 = 
 None 
 , 
 if_etag_not_match 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

(Deprecated) Download the contents of this blob as a bytes object.

See more: google.cloud.storage.blob.Blob.download_as_string

google.cloud.storage.blob.Blob.download_as_text

  download_as_text 
 ( 
 client 
 = 
 None 
 , 
 start 
 = 
 None 
 , 
 end 
 = 
 None 
 , 
 raw_download 
 = 
 False 
 , 
 encoding 
 = 
 None 
 , 
 if_etag_match 
 = 
 None 
 , 
 if_etag_not_match 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Download the contents of this blob as text ( not bytes).

See more: google.cloud.storage.blob.Blob.download_as_text

google.cloud.storage.blob.Blob.download_to_file

  download_to_file 
 ( 
 file_obj 
 , 
 client 
 = 
 None 
 , 
 start 
 = 
 None 
 , 
 end 
 = 
 None 
 , 
 raw_download 
 = 
 False 
 , 
 if_etag_match 
 = 
 None 
 , 
 if_etag_not_match 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 checksum 
 = 
 'auto' 
 , 
 retry 
 = 
 

Download the contents of this blob into a file-like object.

See more: google.cloud.storage.blob.Blob.download_to_file

google.cloud.storage.blob.Blob.download_to_filename

  download_to_filename 
 ( 
 filename 
 , 
 client 
 = 
 None 
 , 
 start 
 = 
 None 
 , 
 end 
 = 
 None 
 , 
 raw_download 
 = 
 False 
 , 
 if_etag_match 
 = 
 None 
 , 
 if_etag_not_match 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 checksum 
 = 
 'auto' 
 , 
 retry 
 = 
 

Download the contents of this blob into a named file.

See more: google.cloud.storage.blob.Blob.download_to_filename

google.cloud.storage.blob.Blob.exists

  exists 
 ( 
 client 
 = 
 None 
 , 
 if_etag_match 
 = 
 None 
 , 
 if_etag_not_match 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Determines whether or not this blob exists.

See more: google.cloud.storage.blob.Blob.exists

google.cloud.storage.blob.Blob.from_string

  from_string 
 ( 
 uri 
 , 
 client 
 = 
 None 
 ) 
 

(Deprecated) Get a constructor for blob object by URI.

See more: google.cloud.storage.blob.Blob.from_string

google.cloud.storage.blob.Blob.from_uri

  from_uri 
 ( 
 uri 
 , 
 client 
 = 
 None 
 ) 
 

Get a constructor for blob object by URI.

See more: google.cloud.storage.blob.Blob.from_uri

google.cloud.storage.blob.Blob.generate_signed_url

  generate_signed_url 
 ( 
 expiration 
 = 
 None 
 , 
 api_access_endpoint 
 = 
 None 
 , 
 method 
 = 
 "GET" 
 , 
 content_md5 
 = 
 None 
 , 
 content_type 
 = 
 None 
 , 
 response_disposition 
 = 
 None 
 , 
 response_type 
 = 
 None 
 , 
 generation 
 = 
 None 
 , 
 headers 
 = 
 None 
 , 
 query_parameters 
 = 
 None 
 , 
 client 
 = 
 None 
 , 
 credentials 
 = 
 None 
 , 
 version 
 = 
 None 
 , 
 service_account_email 
 = 
 None 
 , 
 access_token 
 = 
 None 
 , 
 virtual_hosted_style 
 = 
 False 
 , 
 bucket_bound_hostname 
 = 
 None 
 , 
 scheme 
 = 
 "http" 
 , 
 ) 
 

Generates a signed URL for this blob.

See more: google.cloud.storage.blob.Blob.generate_signed_url

google.cloud.storage.blob.Blob.get_iam_policy

  get_iam_policy 
 ( 
 client 
 = 
 None 
 , 
 requested_policy_version 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Retrieve the IAM policy for the object.

See more: google.cloud.storage.blob.Blob.get_iam_policy

google.cloud.storage.blob.Blob.make_private

  make_private 
 ( 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 retry 
 = 
 

Update blob's ACL, revoking read access for anonymous users.

See more: google.cloud.storage.blob.Blob.make_private

google.cloud.storage.blob.Blob.make_public

  make_public 
 ( 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 retry 
 = 
 

Update blob's ACL, granting read access to anonymous users.

See more: google.cloud.storage.blob.Blob.make_public

google.cloud.storage.blob.Blob.open

  open 
 ( 
 mode 
 = 
 "r" 
 , 
 chunk_size 
 = 
 None 
 , 
 ignore_flush 
 = 
 None 
 , 
 encoding 
 = 
 None 
 , 
 errors 
 = 
 None 
 , 
 newline 
 = 
 None 
 , 
 ** 
 kwargs 
 ) 
 

Create a file handler for file-like I/O to or from this blob.

See more: google.cloud.storage.blob.Blob.open

google.cloud.storage.blob.Blob.patch

  patch 
 ( 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Sends all changed properties in a PATCH request.

See more: google.cloud.storage.blob.Blob.patch

google.cloud.storage.blob.Blob.path_helper

  path_helper 
 ( 
 bucket_path 
 , 
 blob_name 
 ) 
 

Relative URL path for a blob.

See more: google.cloud.storage.blob.Blob.path_helper

google.cloud.storage.blob.Blob.reload

  reload 
 ( 
 client 
 = 
 None 
 , 
 projection 
 = 
 'noAcl' 
 , 
 if_etag_match 
 = 
 None 
 , 
 if_etag_not_match 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Reload properties from Cloud Storage.

See more: google.cloud.storage.blob.Blob.reload

google.cloud.storage.blob.Blob.rewrite

  rewrite 
 ( 
 source 
 , 
 token 
 = 
 None 
 , 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 if_source_generation_match 
 = 
 None 
 , 
 if_source_generation_not_match 
 = 
 None 
 , 
 if_source_metageneration_match 
 = 
 None 
 , 
 if_source_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Rewrite source blob into this one.

See more: google.cloud.storage.blob.Blob.rewrite

google.cloud.storage.blob.Blob.set_iam_policy

  set_iam_policy 
 ( 
 policy 
 , 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Update the IAM policy for the bucket.

See more: google.cloud.storage.blob.Blob.set_iam_policy

google.cloud.storage.blob.Blob.test_iam_permissions

  test_iam_permissions 
 ( 
 permissions 
 , 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

API call: test permissions.

See more: google.cloud.storage.blob.Blob.test_iam_permissions

google.cloud.storage.blob.Blob.update

  update 
 ( 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Sends all properties in a PUT request.

See more: google.cloud.storage.blob.Blob.update

google.cloud.storage.blob.Blob.update_storage_class

  update_storage_class 
 ( 
 new_class 
 , 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 if_source_generation_match 
 = 
 None 
 , 
 if_source_generation_not_match 
 = 
 None 
 , 
 if_source_metageneration_match 
 = 
 None 
 , 
 if_source_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Update blob's storage class via a rewrite-in-place.

See more: google.cloud.storage.blob.Blob.update_storage_class

google.cloud.storage.blob.Blob.upload_from_file

  upload_from_file 
 ( 
 file_obj 
 , 
 rewind 
 = 
 False 
 , 
 size 
 = 
 None 
 , 
 content_type 
 = 
 None 
 , 
 client 
 = 
 None 
 , 
 predefined_acl 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 checksum 
 = 
 'auto' 
 , 
 retry 
 = 
 

Upload the contents of this blob from a file-like object.

See more: google.cloud.storage.blob.Blob.upload_from_file

google.cloud.storage.blob.Blob.upload_from_filename

  upload_from_filename 
 ( 
 filename 
 , 
 content_type 
 = 
 None 
 , 
 client 
 = 
 None 
 , 
 predefined_acl 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 checksum 
 = 
 'auto' 
 , 
 retry 
 = 
 

Upload this blob's contents from the content of a named file.

See more: google.cloud.storage.blob.Blob.upload_from_filename

google.cloud.storage.blob.Blob.upload_from_string

  upload_from_string 
 ( 
 data 
 , 
 content_type 
 = 
 'text/plain' 
 , 
 client 
 = 
 None 
 , 
 predefined_acl 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 checksum 
 = 
 'auto' 
 , 
 retry 
 = 
 

Upload contents of this blob from the provided string.

See more: google.cloud.storage.blob.Blob.upload_from_string

google.cloud.storage.blob.Retention.clear

  clear 
 () 
 

API documentation for storage.blob.Retention.clear method.

See more: google.cloud.storage.blob.Retention.clear

google.cloud.storage.blob.Retention.copy

  copy 
 () 
 

API documentation for storage.blob.Retention.copy method.

See more: google.cloud.storage.blob.Retention.copy

google.cloud.storage.blob.Retention.from_api_repr

  from_api_repr 
 ( 
 resource 
 , 
 blob 
 ) 
 

Factory: construct instance from resource.

See more: google.cloud.storage.blob.Retention.from_api_repr

google.cloud.storage.blob.Retention.fromkeys

  fromkeys 
 ( 
 value 
 = 
 None 
 , 
 / 
 ) 
 

Create a new dictionary with keys from iterable and values set to value.

See more: google.cloud.storage.blob.Retention.fromkeys

google.cloud.storage.blob.Retention.get

  get 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Return the value for key if key is in the dictionary, else default.

See more: google.cloud.storage.blob.Retention.get

google.cloud.storage.blob.Retention.items

  items 
 () 
 

API documentation for storage.blob.Retention.items method.

See more: google.cloud.storage.blob.Retention.items

google.cloud.storage.blob.Retention.keys

  keys 
 () 
 

API documentation for storage.blob.Retention.keys method.

See more: google.cloud.storage.blob.Retention.keys

google.cloud.storage.blob.Retention.pop

  pop 
 ( 
 k 
 [, 
 d 
 ]) 
 

If the key is not found, return the default if given; otherwise, raise a KeyError.

See more: google.cloud.storage.blob.Retention.pop

google.cloud.storage.blob.Retention.popitem

  popitem 
 () 
 

Remove and return a (key, value) pair as a 2-tuple.

See more: google.cloud.storage.blob.Retention.popitem

google.cloud.storage.blob.Retention.setdefault

  setdefault 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Insert key with a value of default if key is not in the dictionary.

See more: google.cloud.storage.blob.Retention.setdefault

google.cloud.storage.blob.Retention.update

  update 
 ([ 
 E 
 , 
 ] 
 ** 
 F 
 ) 
 

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k].

See more: google.cloud.storage.blob.Retention.update

google.cloud.storage.blob.Retention.values

  values 
 () 
 

API documentation for storage.blob.Retention.values method.

See more: google.cloud.storage.blob.Retention.values

google.cloud.storage.bucket.Bucket

  Bucket 
 ( 
 client 
 , 
 name 
 = 
 None 
 , 
 user_project 
 = 
 None 
 , 
 generation 
 = 
 None 
 ) 
 

property name Get the bucket's name.

See more: google.cloud.storage.bucket.Bucket

google.cloud.storage.bucket.Bucket.add_lifecycle_abort_incomplete_multipart_upload_rule

  add_lifecycle_abort_incomplete_multipart_upload_rule 
 ( 
 ** 
 kw 
 ) 
 

Add a "abort incomplete multipart upload" rule to lifecycle rules.

See more: google.cloud.storage.bucket.Bucket.add_lifecycle_abort_incomplete_multipart_upload_rule

google.cloud.storage.bucket.Bucket.add_lifecycle_delete_rule

  add_lifecycle_delete_rule 
 ( 
 ** 
 kw 
 ) 
 

Add a "delete" rule to lifecycle rules configured for this bucket.

See more: google.cloud.storage.bucket.Bucket.add_lifecycle_delete_rule

google.cloud.storage.bucket.Bucket.add_lifecycle_set_storage_class_rule

  add_lifecycle_set_storage_class_rule 
 ( 
 storage_class 
 , 
 ** 
 kw 
 ) 
 

Add a "set storage class" rule to lifecycle rules.

See more: google.cloud.storage.bucket.Bucket.add_lifecycle_set_storage_class_rule

google.cloud.storage.bucket.Bucket.blob

  blob 
 ( 
 blob_name 
 , 
 chunk_size 
 = 
 None 
 , 
 encryption_key 
 = 
 None 
 , 
 kms_key_name 
 = 
 None 
 , 
 generation 
 = 
 None 
 , 
 crc32c_checksum 
 = 
 None 
 , 
 ) 
 

Factory constructor for blob object.

See more: google.cloud.storage.bucket.Bucket.blob

google.cloud.storage.bucket.Bucket.clear_lifecycle_rules

  clear_lifecycle_rules 
 () 
 

Clear lifecycle rules configured for this bucket.

See more: google.cloud.storage.bucket.Bucket.clear_lifecycle_rules

google.cloud.storage.bucket.Bucket.clear_lifecyle_rules

  clear_lifecyle_rules 
 () 
 

Deprecated alias for clear_lifecycle_rules.

See more: google.cloud.storage.bucket.Bucket.clear_lifecyle_rules

google.cloud.storage.bucket.Bucket.configure_website

  configure_website 
 ( 
 main_page_suffix 
 = 
 None 
 , 
 not_found_page 
 = 
 None 
 ) 
 

Configure website-related properties.

See more: google.cloud.storage.bucket.Bucket.configure_website

google.cloud.storage.bucket.Bucket.copy_blob

  copy_blob 
 ( 
 blob 
 , 
 destination_bucket 
 , 
 new_name 
 = 
 None 
 , 
 client 
 = 
 None 
 , 
 preserve_acl 
 = 
 True 
 , 
 source_generation 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 if_source_generation_match 
 = 
 None 
 , 
 if_source_generation_not_match 
 = 
 None 
 , 
 if_source_metageneration_match 
 = 
 None 
 , 
 if_source_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Copy the given blob to the given bucket, optionally with a new name.

See more: google.cloud.storage.bucket.Bucket.copy_blob

google.cloud.storage.bucket.Bucket.create

  create 
 ( 
 client 
 = 
 None 
 , 
 project 
 = 
 None 
 , 
 location 
 = 
 None 
 , 
 predefined_acl 
 = 
 None 
 , 
 predefined_default_object_acl 
 = 
 None 
 , 
 enable_object_retention 
 = 
 False 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Creates current bucket.

See more: google.cloud.storage.bucket.Bucket.create

google.cloud.storage.bucket.Bucket.delete

  delete 
 ( 
 force 
 = 
 False 
 , 
 client 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Delete this bucket.

See more: google.cloud.storage.bucket.Bucket.delete

google.cloud.storage.bucket.Bucket.delete_blob

  delete_blob 
 ( 
 blob_name 
 , 
 client 
 = 
 None 
 , 
 generation 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Deletes a blob from the current bucket.

See more: google.cloud.storage.bucket.Bucket.delete_blob

google.cloud.storage.bucket.Bucket.delete_blobs

  delete_blobs 
 ( 
 blobs 
 , 
 on_error 
 = 
 None 
 , 
 client 
 = 
 None 
 , 
 preserve_generation 
 = 
 False 
 , 
 timeout 
 = 
 60 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 retry 
 = 
 

Deletes a list of blobs from the current bucket.

See more: google.cloud.storage.bucket.Bucket.delete_blobs

google.cloud.storage.bucket.Bucket.disable_logging

  disable_logging 
 () 
 

Disable access logging for this bucket.

See more: google.cloud.storage.bucket.Bucket.disable_logging

google.cloud.storage.bucket.Bucket.disable_website

  disable_website 
 () 
 

Disable the website configuration for this bucket.

See more: google.cloud.storage.bucket.Bucket.disable_website

google.cloud.storage.bucket.Bucket.enable_logging

  enable_logging 
 ( 
 bucket_name 
 , 
 object_prefix 
 = 
 "" 
 ) 
 

Enable access logging for this bucket.

See more: google.cloud.storage.bucket.Bucket.enable_logging

google.cloud.storage.bucket.Bucket.exists

  exists 
 ( 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 if_etag_match 
 = 
 None 
 , 
 if_etag_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 retry 
 = 
 

Determines whether or not this bucket exists.

See more: google.cloud.storage.bucket.Bucket.exists

google.cloud.storage.bucket.Bucket.from_string

  from_string 
 ( 
 uri 
 , 
 client 
 = 
 None 
 ) 
 

Get a constructor for bucket object by URI.

See more: google.cloud.storage.bucket.Bucket.from_string

google.cloud.storage.bucket.Bucket.from_uri

  from_uri 
 ( 
 uri 
 , 
 client 
 = 
 None 
 ) 
 

Get a constructor for bucket object by URI.

See more: google.cloud.storage.bucket.Bucket.from_uri

google.cloud.storage.bucket.Bucket.generate_signed_url

  generate_signed_url 
 ( 
 expiration 
 = 
 None 
 , 
 api_access_endpoint 
 = 
 None 
 , 
 method 
 = 
 "GET" 
 , 
 headers 
 = 
 None 
 , 
 query_parameters 
 = 
 None 
 , 
 client 
 = 
 None 
 , 
 credentials 
 = 
 None 
 , 
 version 
 = 
 None 
 , 
 virtual_hosted_style 
 = 
 False 
 , 
 bucket_bound_hostname 
 = 
 None 
 , 
 scheme 
 = 
 "http" 
 , 
 ) 
 

Generates a signed URL for this bucket.

See more: google.cloud.storage.bucket.Bucket.generate_signed_url

google.cloud.storage.bucket.Bucket.generate_upload_policy

  generate_upload_policy 
 ( 
 conditions 
 , 
 expiration 
 = 
 None 
 , 
 client 
 = 
 None 
 ) 
 

Create a signed upload policy for uploading objects.

See more: google.cloud.storage.bucket.Bucket.generate_upload_policy

google.cloud.storage.bucket.Bucket.get_blob

  get_blob 
 ( 
 blob_name 
 , 
 client 
 = 
 None 
 , 
 encryption_key 
 = 
 None 
 , 
 generation 
 = 
 None 
 , 
 if_etag_match 
 = 
 None 
 , 
 if_etag_not_match 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Get a blob object by name.

See more: google.cloud.storage.bucket.Bucket.get_blob

google.cloud.storage.bucket.Bucket.get_iam_policy

  get_iam_policy 
 ( 
 client 
 = 
 None 
 , 
 requested_policy_version 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Retrieve the IAM policy for the bucket.

See more: google.cloud.storage.bucket.Bucket.get_iam_policy

google.cloud.storage.bucket.Bucket.get_logging

  get_logging 
 () 
 

Return info about access logging for this bucket.

See more: google.cloud.storage.bucket.Bucket.get_logging

google.cloud.storage.bucket.Bucket.get_notification

  get_notification 
 ( 
 notification_id 
 , 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Get Pub / Sub notification for this bucket.

See more: google.cloud.storage.bucket.Bucket.get_notification

google.cloud.storage.bucket.Bucket.list_blobs

  list_blobs 
 ( 
 max_results 
 = 
 None 
 , 
 page_token 
 = 
 None 
 , 
 prefix 
 = 
 None 
 , 
 delimiter 
 = 
 None 
 , 
 start_offset 
 = 
 None 
 , 
 end_offset 
 = 
 None 
 , 
 include_trailing_delimiter 
 = 
 None 
 , 
 versions 
 = 
 None 
 , 
 projection 
 = 
 'noAcl' 
 , 
 fields 
 = 
 None 
 , 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Return an iterator used to find blobs in the bucket.

See more: google.cloud.storage.bucket.Bucket.list_blobs

google.cloud.storage.bucket.Bucket.list_notifications

  list_notifications 
 ( 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

List Pub / Sub notifications for this bucket.

See more: google.cloud.storage.bucket.Bucket.list_notifications

google.cloud.storage.bucket.Bucket.lock_retention_policy

  lock_retention_policy 
 ( 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Lock the bucket's retention policy.

See more: google.cloud.storage.bucket.Bucket.lock_retention_policy

google.cloud.storage.bucket.Bucket.make_private

  make_private 
 ( 
 recursive 
 = 
 False 
 , 
 future 
 = 
 False 
 , 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 retry 
 = 
 

Update bucket's ACL, revoking read access for anonymous users.

See more: google.cloud.storage.bucket.Bucket.make_private

google.cloud.storage.bucket.Bucket.make_public

  make_public 
 ( 
 recursive 
 = 
 False 
 , 
 future 
 = 
 False 
 , 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 retry 
 = 
 

Update bucket's ACL, granting read access to anonymous users.

See more: google.cloud.storage.bucket.Bucket.make_public

google.cloud.storage.bucket.Bucket.move_blob

  move_blob 
 ( 
 blob 
 , 
 new_name 
 , 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 if_source_generation_match 
 = 
 None 
 , 
 if_source_generation_not_match 
 = 
 None 
 , 
 if_source_metageneration_match 
 = 
 None 
 , 
 if_source_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Move a blob to a new name atomically.

See more: google.cloud.storage.bucket.Bucket.move_blob

google.cloud.storage.bucket.Bucket.notification

  notification 
 ( 
 topic_name 
 = 
 None 
 , 
 topic_project 
 = 
 None 
 , 
 custom_attributes 
 = 
 None 
 , 
 event_types 
 = 
 None 
 , 
 blob_name_prefix 
 = 
 None 
 , 
 payload_format 
 = 
 "NONE" 
 , 
 notification_id 
 = 
 None 
 , 
 ) 
 

Factory: create a notification resource for the bucket.

See more: google.cloud.storage.bucket.Bucket.notification

google.cloud.storage.bucket.Bucket.patch

  patch 
 ( 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 retry 
 = 
 

Sends all changed properties in a PATCH request.

See more: google.cloud.storage.bucket.Bucket.patch

google.cloud.storage.bucket.Bucket.path_helper

  path_helper 
 ( 
 bucket_name 
 ) 
 

Relative URL path for a bucket.

See more: google.cloud.storage.bucket.Bucket.path_helper

google.cloud.storage.bucket.Bucket.reload

  reload 
 ( 
 client 
 = 
 None 
 , 
 projection 
 = 
 'noAcl' 
 , 
 timeout 
 = 
 60 
 , 
 if_etag_match 
 = 
 None 
 , 
 if_etag_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 retry 
 = 
 

Reload properties from Cloud Storage.

See more: google.cloud.storage.bucket.Bucket.reload

google.cloud.storage.bucket.Bucket.rename_blob

  rename_blob 
 ( 
 blob 
 , 
 new_name 
 , 
 client 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 if_source_generation_match 
 = 
 None 
 , 
 if_source_generation_not_match 
 = 
 None 
 , 
 if_source_metageneration_match 
 = 
 None 
 , 
 if_source_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Rename the given blob using copy and delete operations.

See more: google.cloud.storage.bucket.Bucket.rename_blob

google.cloud.storage.bucket.Bucket.restore_blob

  restore_blob 
 ( 
 blob_name 
 , 
 client 
 = 
 None 
 , 
 generation 
 = 
 None 
 , 
 copy_source_acl 
 = 
 None 
 , 
 projection 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Restores a soft-deleted object.

See more: google.cloud.storage.bucket.Bucket.restore_blob

google.cloud.storage.bucket.Bucket.set_iam_policy

  set_iam_policy 
 ( 
 policy 
 , 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Update the IAM policy for the bucket.

See more: google.cloud.storage.bucket.Bucket.set_iam_policy

google.cloud.storage.bucket.Bucket.test_iam_permissions

  test_iam_permissions 
 ( 
 permissions 
 , 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

API call: test permissions.

See more: google.cloud.storage.bucket.Bucket.test_iam_permissions

google.cloud.storage.bucket.Bucket.update

  update 
 ( 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 retry 
 = 
 

Sends all properties in a PUT request.

See more: google.cloud.storage.bucket.Bucket.update

google.cloud.storage.bucket.IAMConfiguration.clear

  clear 
 () 
 

API documentation for storage.bucket.IAMConfiguration.clear method.

See more: google.cloud.storage.bucket.IAMConfiguration.clear

google.cloud.storage.bucket.IAMConfiguration.copy

  copy 
 () 
 

API documentation for storage.bucket.IAMConfiguration.copy method.

See more: google.cloud.storage.bucket.IAMConfiguration.copy

google.cloud.storage.bucket.IAMConfiguration.from_api_repr

  from_api_repr 
 ( 
 resource 
 , 
 bucket 
 ) 
 

Factory: construct instance from resource.

See more: google.cloud.storage.bucket.IAMConfiguration.from_api_repr

google.cloud.storage.bucket.IAMConfiguration.fromkeys

  fromkeys 
 ( 
 value 
 = 
 None 
 , 
 / 
 ) 
 

Create a new dictionary with keys from iterable and values set to value.

See more: google.cloud.storage.bucket.IAMConfiguration.fromkeys

google.cloud.storage.bucket.IAMConfiguration.get

  get 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Return the value for key if key is in the dictionary, else default.

See more: google.cloud.storage.bucket.IAMConfiguration.get

google.cloud.storage.bucket.IAMConfiguration.items

  items 
 () 
 

API documentation for storage.bucket.IAMConfiguration.items method.

See more: google.cloud.storage.bucket.IAMConfiguration.items

google.cloud.storage.bucket.IAMConfiguration.keys

  keys 
 () 
 

API documentation for storage.bucket.IAMConfiguration.keys method.

See more: google.cloud.storage.bucket.IAMConfiguration.keys

google.cloud.storage.bucket.IAMConfiguration.pop

  pop 
 ( 
 k 
 [, 
 d 
 ]) 
 

If the key is not found, return the default if given; otherwise, raise a KeyError.

See more: google.cloud.storage.bucket.IAMConfiguration.pop

google.cloud.storage.bucket.IAMConfiguration.popitem

  popitem 
 () 
 

Remove and return a (key, value) pair as a 2-tuple.

See more: google.cloud.storage.bucket.IAMConfiguration.popitem

google.cloud.storage.bucket.IAMConfiguration.setdefault

  setdefault 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Insert key with a value of default if key is not in the dictionary.

See more: google.cloud.storage.bucket.IAMConfiguration.setdefault

google.cloud.storage.bucket.IAMConfiguration.update

  update 
 ([ 
 E 
 , 
 ] 
 ** 
 F 
 ) 
 

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k].

See more: google.cloud.storage.bucket.IAMConfiguration.update

google.cloud.storage.bucket.IAMConfiguration.values

  values 
 () 
 

API documentation for storage.bucket.IAMConfiguration.values method.

See more: google.cloud.storage.bucket.IAMConfiguration.values

google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.clear

  clear 
 () 
 

API documentation for storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.clear method.

See more: google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.clear

google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.copy

  copy 
 () 
 

API documentation for storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.copy method.

See more: google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.copy

google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.from_api_repr

  from_api_repr 
 ( 
 resource 
 ) 
 

google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.fromkeys

  fromkeys 
 ( 
 value 
 = 
 None 
 , 
 / 
 ) 
 

Create a new dictionary with keys from iterable and values set to value.

See more: google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.fromkeys

google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.get

  get 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Return the value for key if key is in the dictionary, else default.

See more: google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.get

google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.items

  items 
 () 
 

API documentation for storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.items method.

See more: google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.items

google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.keys

  keys 
 () 
 

API documentation for storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.keys method.

See more: google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.keys

google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.pop

  pop 
 ( 
 k 
 [, 
 d 
 ]) 
 

If the key is not found, return the default if given; otherwise, raise a KeyError.

See more: google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.pop

google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.popitem

  popitem 
 () 
 

Remove and return a (key, value) pair as a 2-tuple.

See more: google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.popitem

google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.setdefault

  setdefault 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Insert key with a value of default if key is not in the dictionary.

See more: google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.setdefault

google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.update

  update 
 ([ 
 E 
 , 
 ] 
 ** 
 F 
 ) 
 

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k].

See more: google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.update

google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.values

  values 
 () 
 

API documentation for storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.values method.

See more: google.cloud.storage.bucket.LifecycleRuleAbortIncompleteMultipartUpload.values

google.cloud.storage.bucket.LifecycleRuleConditions.clear

  clear 
 () 
 

API documentation for storage.bucket.LifecycleRuleConditions.clear method.

See more: google.cloud.storage.bucket.LifecycleRuleConditions.clear

google.cloud.storage.bucket.LifecycleRuleConditions.copy

  copy 
 () 
 

API documentation for storage.bucket.LifecycleRuleConditions.copy method.

See more: google.cloud.storage.bucket.LifecycleRuleConditions.copy

google.cloud.storage.bucket.LifecycleRuleConditions.from_api_repr

  from_api_repr 
 ( 
 resource 
 ) 
 

Factory: construct instance from resource.

See more: google.cloud.storage.bucket.LifecycleRuleConditions.from_api_repr

google.cloud.storage.bucket.LifecycleRuleConditions.fromkeys

  fromkeys 
 ( 
 value 
 = 
 None 
 , 
 / 
 ) 
 

Create a new dictionary with keys from iterable and values set to value.

See more: google.cloud.storage.bucket.LifecycleRuleConditions.fromkeys

google.cloud.storage.bucket.LifecycleRuleConditions.get

  get 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Return the value for key if key is in the dictionary, else default.

See more: google.cloud.storage.bucket.LifecycleRuleConditions.get

google.cloud.storage.bucket.LifecycleRuleConditions.items

  items 
 () 
 

API documentation for storage.bucket.LifecycleRuleConditions.items method.

See more: google.cloud.storage.bucket.LifecycleRuleConditions.items

google.cloud.storage.bucket.LifecycleRuleConditions.keys

  keys 
 () 
 

API documentation for storage.bucket.LifecycleRuleConditions.keys method.

See more: google.cloud.storage.bucket.LifecycleRuleConditions.keys

google.cloud.storage.bucket.LifecycleRuleConditions.pop

  pop 
 ( 
 k 
 [, 
 d 
 ]) 
 

If the key is not found, return the default if given; otherwise, raise a KeyError.

See more: google.cloud.storage.bucket.LifecycleRuleConditions.pop

google.cloud.storage.bucket.LifecycleRuleConditions.popitem

  popitem 
 () 
 

Remove and return a (key, value) pair as a 2-tuple.

See more: google.cloud.storage.bucket.LifecycleRuleConditions.popitem

google.cloud.storage.bucket.LifecycleRuleConditions.setdefault

  setdefault 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Insert key with a value of default if key is not in the dictionary.

See more: google.cloud.storage.bucket.LifecycleRuleConditions.setdefault

google.cloud.storage.bucket.LifecycleRuleConditions.update

  update 
 ([ 
 E 
 , 
 ] 
 ** 
 F 
 ) 
 

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k].

See more: google.cloud.storage.bucket.LifecycleRuleConditions.update

google.cloud.storage.bucket.LifecycleRuleConditions.values

  values 
 () 
 

API documentation for storage.bucket.LifecycleRuleConditions.values method.

See more: google.cloud.storage.bucket.LifecycleRuleConditions.values

google.cloud.storage.bucket.LifecycleRuleDelete.clear

  clear 
 () 
 

API documentation for storage.bucket.LifecycleRuleDelete.clear method.

See more: google.cloud.storage.bucket.LifecycleRuleDelete.clear

google.cloud.storage.bucket.LifecycleRuleDelete.copy

  copy 
 () 
 

API documentation for storage.bucket.LifecycleRuleDelete.copy method.

See more: google.cloud.storage.bucket.LifecycleRuleDelete.copy

google.cloud.storage.bucket.LifecycleRuleDelete.from_api_repr

  from_api_repr 
 ( 
 resource 
 ) 
 

Factory: construct instance from resource.

See more: google.cloud.storage.bucket.LifecycleRuleDelete.from_api_repr

google.cloud.storage.bucket.LifecycleRuleDelete.fromkeys

  fromkeys 
 ( 
 value 
 = 
 None 
 , 
 / 
 ) 
 

Create a new dictionary with keys from iterable and values set to value.

See more: google.cloud.storage.bucket.LifecycleRuleDelete.fromkeys

google.cloud.storage.bucket.LifecycleRuleDelete.get

  get 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Return the value for key if key is in the dictionary, else default.

See more: google.cloud.storage.bucket.LifecycleRuleDelete.get

google.cloud.storage.bucket.LifecycleRuleDelete.items

  items 
 () 
 

API documentation for storage.bucket.LifecycleRuleDelete.items method.

See more: google.cloud.storage.bucket.LifecycleRuleDelete.items

google.cloud.storage.bucket.LifecycleRuleDelete.keys

  keys 
 () 
 

API documentation for storage.bucket.LifecycleRuleDelete.keys method.

See more: google.cloud.storage.bucket.LifecycleRuleDelete.keys

google.cloud.storage.bucket.LifecycleRuleDelete.pop

  pop 
 ( 
 k 
 [, 
 d 
 ]) 
 

If the key is not found, return the default if given; otherwise, raise a KeyError.

See more: google.cloud.storage.bucket.LifecycleRuleDelete.pop

google.cloud.storage.bucket.LifecycleRuleDelete.popitem

  popitem 
 () 
 

Remove and return a (key, value) pair as a 2-tuple.

See more: google.cloud.storage.bucket.LifecycleRuleDelete.popitem

google.cloud.storage.bucket.LifecycleRuleDelete.setdefault

  setdefault 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Insert key with a value of default if key is not in the dictionary.

See more: google.cloud.storage.bucket.LifecycleRuleDelete.setdefault

google.cloud.storage.bucket.LifecycleRuleDelete.update

  update 
 ([ 
 E 
 , 
 ] 
 ** 
 F 
 ) 
 

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k].

See more: google.cloud.storage.bucket.LifecycleRuleDelete.update

google.cloud.storage.bucket.LifecycleRuleDelete.values

  values 
 () 
 

API documentation for storage.bucket.LifecycleRuleDelete.values method.

See more: google.cloud.storage.bucket.LifecycleRuleDelete.values

google.cloud.storage.bucket.LifecycleRuleSetStorageClass.clear

  clear 
 () 
 

API documentation for storage.bucket.LifecycleRuleSetStorageClass.clear method.

See more: google.cloud.storage.bucket.LifecycleRuleSetStorageClass.clear

google.cloud.storage.bucket.LifecycleRuleSetStorageClass.copy

  copy 
 () 
 

API documentation for storage.bucket.LifecycleRuleSetStorageClass.copy method.

See more: google.cloud.storage.bucket.LifecycleRuleSetStorageClass.copy

google.cloud.storage.bucket.LifecycleRuleSetStorageClass.from_api_repr

  from_api_repr 
 ( 
 resource 
 ) 
 

Factory: construct instance from resource.

See more: google.cloud.storage.bucket.LifecycleRuleSetStorageClass.from_api_repr

google.cloud.storage.bucket.LifecycleRuleSetStorageClass.fromkeys

  fromkeys 
 ( 
 value 
 = 
 None 
 , 
 / 
 ) 
 

Create a new dictionary with keys from iterable and values set to value.

See more: google.cloud.storage.bucket.LifecycleRuleSetStorageClass.fromkeys

google.cloud.storage.bucket.LifecycleRuleSetStorageClass.get

  get 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Return the value for key if key is in the dictionary, else default.

See more: google.cloud.storage.bucket.LifecycleRuleSetStorageClass.get

google.cloud.storage.bucket.LifecycleRuleSetStorageClass.items

  items 
 () 
 

API documentation for storage.bucket.LifecycleRuleSetStorageClass.items method.

See more: google.cloud.storage.bucket.LifecycleRuleSetStorageClass.items

google.cloud.storage.bucket.LifecycleRuleSetStorageClass.keys

  keys 
 () 
 

API documentation for storage.bucket.LifecycleRuleSetStorageClass.keys method.

See more: google.cloud.storage.bucket.LifecycleRuleSetStorageClass.keys

google.cloud.storage.bucket.LifecycleRuleSetStorageClass.pop

  pop 
 ( 
 k 
 [, 
 d 
 ]) 
 

If the key is not found, return the default if given; otherwise, raise a KeyError.

See more: google.cloud.storage.bucket.LifecycleRuleSetStorageClass.pop

google.cloud.storage.bucket.LifecycleRuleSetStorageClass.popitem

  popitem 
 () 
 

Remove and return a (key, value) pair as a 2-tuple.

See more: google.cloud.storage.bucket.LifecycleRuleSetStorageClass.popitem

google.cloud.storage.bucket.LifecycleRuleSetStorageClass.setdefault

  setdefault 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Insert key with a value of default if key is not in the dictionary.

See more: google.cloud.storage.bucket.LifecycleRuleSetStorageClass.setdefault

google.cloud.storage.bucket.LifecycleRuleSetStorageClass.update

  update 
 ([ 
 E 
 , 
 ] 
 ** 
 F 
 ) 
 

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k].

See more: google.cloud.storage.bucket.LifecycleRuleSetStorageClass.update

google.cloud.storage.bucket.LifecycleRuleSetStorageClass.values

  values 
 () 
 

API documentation for storage.bucket.LifecycleRuleSetStorageClass.values method.

See more: google.cloud.storage.bucket.LifecycleRuleSetStorageClass.values

google.cloud.storage.bucket.SoftDeletePolicy.clear

  clear 
 () 
 

API documentation for storage.bucket.SoftDeletePolicy.clear method.

See more: google.cloud.storage.bucket.SoftDeletePolicy.clear

google.cloud.storage.bucket.SoftDeletePolicy.copy

  copy 
 () 
 

API documentation for storage.bucket.SoftDeletePolicy.copy method.

See more: google.cloud.storage.bucket.SoftDeletePolicy.copy

google.cloud.storage.bucket.SoftDeletePolicy.from_api_repr

  from_api_repr 
 ( 
 resource 
 , 
 bucket 
 ) 
 

Factory: construct instance from resource.

See more: google.cloud.storage.bucket.SoftDeletePolicy.from_api_repr

google.cloud.storage.bucket.SoftDeletePolicy.fromkeys

  fromkeys 
 ( 
 value 
 = 
 None 
 , 
 / 
 ) 
 

Create a new dictionary with keys from iterable and values set to value.

See more: google.cloud.storage.bucket.SoftDeletePolicy.fromkeys

google.cloud.storage.bucket.SoftDeletePolicy.get

  get 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Return the value for key if key is in the dictionary, else default.

See more: google.cloud.storage.bucket.SoftDeletePolicy.get

google.cloud.storage.bucket.SoftDeletePolicy.items

  items 
 () 
 

API documentation for storage.bucket.SoftDeletePolicy.items method.

See more: google.cloud.storage.bucket.SoftDeletePolicy.items

google.cloud.storage.bucket.SoftDeletePolicy.keys

  keys 
 () 
 

API documentation for storage.bucket.SoftDeletePolicy.keys method.

See more: google.cloud.storage.bucket.SoftDeletePolicy.keys

google.cloud.storage.bucket.SoftDeletePolicy.pop

  pop 
 ( 
 k 
 [, 
 d 
 ]) 
 

If the key is not found, return the default if given; otherwise, raise a KeyError.

See more: google.cloud.storage.bucket.SoftDeletePolicy.pop

google.cloud.storage.bucket.SoftDeletePolicy.popitem

  popitem 
 () 
 

Remove and return a (key, value) pair as a 2-tuple.

See more: google.cloud.storage.bucket.SoftDeletePolicy.popitem

google.cloud.storage.bucket.SoftDeletePolicy.setdefault

  setdefault 
 ( 
 key 
 , 
 default 
 = 
 None 
 , 
 / 
 ) 
 

Insert key with a value of default if key is not in the dictionary.

See more: google.cloud.storage.bucket.SoftDeletePolicy.setdefault

google.cloud.storage.bucket.SoftDeletePolicy.update

  update 
 ([ 
 E 
 , 
 ] 
 ** 
 F 
 ) 
 

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k].

See more: google.cloud.storage.bucket.SoftDeletePolicy.update

google.cloud.storage.bucket.SoftDeletePolicy.values

  values 
 () 
 

API documentation for storage.bucket.SoftDeletePolicy.values method.

See more: google.cloud.storage.bucket.SoftDeletePolicy.values

google.cloud.storage.client.Client.batch

  batch 
 ( 
 raise_exception 
 = 
 True 
 ) 
 

Factory constructor for batch object.

See more: google.cloud.storage.client.Client.batch

google.cloud.storage.client.Client.bucket

  bucket 
 ( 
 bucket_name 
 , 
 user_project 
 = 
 None 
 , 
 generation 
 = 
 None 
 ) 
 

Factory constructor for bucket object.

See more: google.cloud.storage.client.Client.bucket

google.cloud.storage.client.Client.create_anonymous_client

  create_anonymous_client 
 () 
 

Factory: return client with anonymous credentials.

See more: google.cloud.storage.client.Client.create_anonymous_client

google.cloud.storage.client.Client.create_bucket

  create_bucket 
 ( 
 bucket_or_name 
 , 
 requester_pays 
 = 
 None 
 , 
 project 
 = 
 None 
 , 
 user_project 
 = 
 None 
 , 
 location 
 = 
 None 
 , 
 data_locations 
 = 
 None 
 , 
 predefined_acl 
 = 
 None 
 , 
 predefined_default_object_acl 
 = 
 None 
 , 
 enable_object_retention 
 = 
 False 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Create a new bucket via a POST request.

See more: google.cloud.storage.client.Client.create_bucket

google.cloud.storage.client.Client.create_hmac_key

  create_hmac_key 
 ( 
 service_account_email 
 , 
 project_id 
 = 
 None 
 , 
 user_project 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 None 
 ) 
 

Create an HMAC key for a service account.

See more: google.cloud.storage.client.Client.create_hmac_key

google.cloud.storage.client.Client.download_blob_to_file

  download_blob_to_file 
 ( 
 blob_or_uri 
 , 
 file_obj 
 , 
 start 
 = 
 None 
 , 
 end 
 = 
 None 
 , 
 raw_download 
 = 
 False 
 , 
 if_etag_match 
 = 
 None 
 , 
 if_etag_not_match 
 = 
 None 
 , 
 if_generation_match 
 = 
 None 
 , 
 if_generation_not_match 
 = 
 None 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 checksum 
 = 
 'auto' 
 , 
 retry 
 = 
 

Download the contents of a blob object or blob URI into a file-like object.

See more: google.cloud.storage.client.Client.download_blob_to_file

google.cloud.storage.client.Client.generate_signed_post_policy_v4

  generate_signed_post_policy_v4 
 ( 
 bucket_name 
 , 
 blob_name 
 , 
 expiration 
 , 
 conditions 
 = 
 None 
 , 
 fields 
 = 
 None 
 , 
 credentials 
 = 
 None 
 , 
 virtual_hosted_style 
 = 
 False 
 , 
 bucket_bound_hostname 
 = 
 None 
 , 
 scheme 
 = 
 "http" 
 , 
 service_account_email 
 = 
 None 
 , 
 access_token 
 = 
 None 
 , 
 ) 
 

Generate a V4 signed policy object.

See more: google.cloud.storage.client.Client.generate_signed_post_policy_v4

google.cloud.storage.client.Client.get_bucket

  get_bucket 
 ( 
 bucket_or_name 
 , 
 timeout 
 = 
 60 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 retry 
 = 
 

Retrieve a bucket via a GET request.

See more: google.cloud.storage.client.Client.get_bucket

  get_hmac_key_metadata 
 ( 
 access_id 
 , 
 project_id 
 = 
 None 
 , 
 user_project 
 = 
 None 
 , 
 timeout 
 = 
 60 
 ) 
 

Return a metadata instance for the given HMAC key.

See more: google.cloud.storage.client.Client.get_hmac_key_metadata

  get_service_account_email 
 ( 
 project 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Get the email address of the project's GCS service account .

See more: google.cloud.storage.client.Client.get_service_account_email

google.cloud.storage.client.Client.list_blobs

  list_blobs 
 ( 
 bucket_or_name 
 , 
 max_results 
 = 
 None 
 , 
 page_token 
 = 
 None 
 , 
 prefix 
 = 
 None 
 , 
 delimiter 
 = 
 None 
 , 
 start_offset 
 = 
 None 
 , 
 end_offset 
 = 
 None 
 , 
 include_trailing_delimiter 
 = 
 None 
 , 
 versions 
 = 
 None 
 , 
 projection 
 = 
 'noAcl' 
 , 
 fields 
 = 
 None 
 , 
 page_size 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Return an iterator used to find blobs in the bucket.

See more: google.cloud.storage.client.Client.list_blobs

google.cloud.storage.client.Client.list_buckets

  list_buckets 
 ( 
 max_results 
 = 
 None 
 , 
 page_token 
 = 
 None 
 , 
 prefix 
 = 
 None 
 , 
 projection 
 = 
 'noAcl' 
 , 
 fields 
 = 
 None 
 , 
 project 
 = 
 None 
 , 
 page_size 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Get all buckets in the project associated to the client.

See more: google.cloud.storage.client.Client.list_buckets

google.cloud.storage.client.Client.list_hmac_keys

  list_hmac_keys 
 ( 
 max_results 
 = 
 None 
 , 
 service_account_email 
 = 
 None 
 , 
 show_deleted_keys 
 = 
 None 
 , 
 project_id 
 = 
 None 
 , 
 user_project 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

List HMAC keys for a project.

See more: google.cloud.storage.client.Client.list_hmac_keys

google.cloud.storage.client.Client.lookup_bucket

  lookup_bucket 
 ( 
 bucket_name 
 , 
 timeout 
 = 
 60 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 retry 
 = 
 

Get a bucket by name, returning None if not found.

See more: google.cloud.storage.client.Client.lookup_bucket

google.cloud.storage.client.Client.restore_bucket

  restore_bucket 
 ( 
 bucket_name 
 , 
 generation 
 , 
 projection 
 = 
 'noAcl' 
 , 
 if_metageneration_match 
 = 
 None 
 , 
 if_metageneration_not_match 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Restores a soft-deleted bucket.

See more: google.cloud.storage.client.Client.restore_bucket

google.cloud.storage.fileio.BlobReader.close

  close 
 () 
 

Flush and close the IO object.

See more: google.cloud.storage.fileio.BlobReader.close

google.cloud.storage.fileio.BlobReader.read

  read 
 ( 
 size 
 =- 
 1 
 ) 
 

Read and return up to n bytes.

See more: google.cloud.storage.fileio.BlobReader.read

google.cloud.storage.fileio.BlobReader.read1

  read1 
 ( 
 size 
 =- 
 1 
 ) 
 

Read and return up to n bytes, with at most one read() call to the underlying raw stream.

See more: google.cloud.storage.fileio.BlobReader.read1

google.cloud.storage.fileio.BlobReader.readable

  readable 
 () 
 

Return whether object was opened for reading.

See more: google.cloud.storage.fileio.BlobReader.readable

google.cloud.storage.fileio.BlobReader.seek

  seek 
 ( 
 pos 
 , 
 whence 
 = 
 0 
 ) 
 

Seek within the blob.

See more: google.cloud.storage.fileio.BlobReader.seek

google.cloud.storage.fileio.BlobReader.seekable

  seekable 
 () 
 

Return whether object supports random access.

See more: google.cloud.storage.fileio.BlobReader.seekable

google.cloud.storage.fileio.BlobReader.writable

  writable 
 () 
 

Return whether object was opened for writing.

See more: google.cloud.storage.fileio.BlobReader.writable

google.cloud.storage.fileio.BlobWriter.close

  close 
 () 
 

Flush and close the IO object.

See more: google.cloud.storage.fileio.BlobWriter.close

google.cloud.storage.fileio.BlobWriter.flush

  flush 
 () 
 

Flush write buffers, if applicable.

See more: google.cloud.storage.fileio.BlobWriter.flush

google.cloud.storage.fileio.BlobWriter.readable

  readable 
 () 
 

Return whether object was opened for reading.

See more: google.cloud.storage.fileio.BlobWriter.readable

google.cloud.storage.fileio.BlobWriter.seekable

  seekable 
 () 
 

Return whether object supports random access.

See more: google.cloud.storage.fileio.BlobWriter.seekable

google.cloud.storage.fileio.BlobWriter.tell

  tell 
 () 
 

Return current stream position.

See more: google.cloud.storage.fileio.BlobWriter.tell

google.cloud.storage.fileio.BlobWriter.terminate

  terminate 
 () 
 

Cancel the ResumableUpload.

See more: google.cloud.storage.fileio.BlobWriter.terminate

google.cloud.storage.fileio.BlobWriter.writable

  writable 
 () 
 

Return whether object was opened for writing.

See more: google.cloud.storage.fileio.BlobWriter.writable

google.cloud.storage.fileio.BlobWriter.write

  write 
 ( 
 b 
 ) 
 

Write the given buffer to the IO stream.

See more: google.cloud.storage.fileio.BlobWriter.write

google.cloud.storage.fileio.SlidingBuffer.__len__

  __len__ 
 () 
 

Determine the size of the buffer by seeking to the end.

See more: google.cloud.storage.fileio.SlidingBuffer. len

google.cloud.storage.fileio.SlidingBuffer.flush

  flush 
 () 
 

Delete already-read data (all data to the left of the position).

See more: google.cloud.storage.fileio.SlidingBuffer.flush

google.cloud.storage.fileio.SlidingBuffer.read

  read 
 ( 
 size 
 =- 
 1 
 ) 
 

Read and move the cursor.

See more: google.cloud.storage.fileio.SlidingBuffer.read

google.cloud.storage.fileio.SlidingBuffer.seek

  seek 
 ( 
 pos 
 ) 
 

Seek to a position (backwards only) within the internal buffer.

See more: google.cloud.storage.fileio.SlidingBuffer.seek

google.cloud.storage.fileio.SlidingBuffer.tell

  tell 
 () 
 

Report how many bytes have been read from the buffer in total.

See more: google.cloud.storage.fileio.SlidingBuffer.tell

google.cloud.storage.fileio.SlidingBuffer.write

  write 
 ( 
 b 
 ) 
 

Append to the end of the buffer without changing the position.

See more: google.cloud.storage.fileio.SlidingBuffer.write

  delete 
 ( 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Delete the key from Cloud Storage.

See more: google.cloud.storage.hmac_key.HMACKeyMetadata.delete

  exists 
 ( 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Determine whether or not the key for this metadata exists.

See more: google.cloud.storage.hmac_key.HMACKeyMetadata.exists

  reload 
 ( 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Reload properties from Cloud Storage.

See more: google.cloud.storage.hmac_key.HMACKeyMetadata.reload

  update 
 ( 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Save writable properties to Cloud Storage.

See more: google.cloud.storage.hmac_key.HMACKeyMetadata.update

google.cloud.storage.notification.BucketNotification.create

  create 
 ( 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 None 
 ) 
 

API wrapper: create the notification.

See more: google.cloud.storage.notification.BucketNotification.create

google.cloud.storage.notification.BucketNotification.delete

  delete 
 ( 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

google.cloud.storage.notification.BucketNotification.exists

  exists 
 ( 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Test whether this notification exists.

See more: google.cloud.storage.notification.BucketNotification.exists

google.cloud.storage.notification.BucketNotification.from_api_repr

  from_api_repr 
 ( 
 resource 
 , 
 bucket 
 ) 
 

Construct an instance from the JSON repr returned by the server.

See more: google.cloud.storage.notification.BucketNotification.from_api_repr

google.cloud.storage.notification.BucketNotification.reload

  reload 
 ( 
 client 
 = 
 None 
 , 
 timeout 
 = 
 60 
 , 
 retry 
 = 
 

Update this notification from the server configuration.

See more: google.cloud.storage.notification.BucketNotification.reload

Create a Mobile Website
View Site in Mobile | Classic
Share by: