Package Methods (3.14.0)

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=google.api_core.retry.retry_unary.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=google.cloud.storage.retry.ConditionalRetryPolicy,
)

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=google.api_core.retry.retry_unary.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=google.cloud.storage.retry.ConditionalRetryPolicy,
)

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=google.cloud.storage.retry.ConditionalRetryPolicy,
)

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=google.api_core.retry.retry_unary.Retry,
)