Package Methods (2.17.0)

is_etag_in_data(data)

is_etag_in_json(data)

is_generation_specified(query_params)

is_metageneration_specified(query_params)

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

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_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
)

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

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_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
)

add_entity(entity)

all()

all_authenticated()

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

domain(domain)

entity(entity_type, identifier=None)

entity_from_dict(entity_dict)

get_entities()

get_entity(entity, default=None)

group(identifier)

has_entity(entity)

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

reset()

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_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=

user(identifier)

validate_predefined(predefined)

current()

finish(raise_exception=True)

MIMEApplicationHTTP(method, uri, headers, body)

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

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

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

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

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='md5', retry=

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=

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_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='md5', retry=

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='md5', retry=

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=

from_string(uri, client=None)

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",
)

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

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=

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=

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

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

path_helper(bucket_path, blob_name)

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=

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=

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

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

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

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=

upload_from_file(file_obj, rewind=False, size=None, content_type=None, num_retries=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=None, retry=

upload_from_filename(filename, content_type=None, num_retries=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=None, retry=

upload_from_string(data, content_type='text/plain', num_retries=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=None, retry=

clear()

copy()

from_api_repr(resource, blob)

fromkeys(value=None, /)

get(key, default=None, /)

items()

keys()

pop(k[,d])

popitem()

setdefault(key, default=None, /)

update([E, ]**F)

values()

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

add_lifecycle_abort_incomplete_multipart_upload_rule(**kw)

add_lifecycle_delete_rule(**kw)

add_lifecycle_set_storage_class_rule(storage_class, **kw)

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

clear_lifecycle_rules()

clear_lifecyle_rules()

configure_website(main_page_suffix=None, not_found_page=None)

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=

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

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

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=

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=

disable_logging()

disable_website()

enable_logging(bucket_name, object_prefix="")

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

from_string(uri, client=None)

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",
)

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

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_iam_policy(client=None, requested_policy_version=None, timeout=60, retry=

get_logging()

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

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=

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

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

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

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

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

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

path_helper(bucket_name)

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=

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=

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=

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

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

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

clear()

copy()

from_api_repr(resource, bucket)

fromkeys(value=None, /)

get(key, default=None, /)

items()

keys()

pop(k[,d])

popitem()

setdefault(key, default=None, /)

update([E, ]**F)

values()

clear()

copy()

from_api_repr(resource)

fromkeys(value=None, /)

get(key, default=None, /)

items()

keys()

pop(k[,d])

popitem()

setdefault(key, default=None, /)

update([E, ]**F)

values()

clear()

copy()

from_api_repr(resource)

fromkeys(value=None, /)

get(key, default=None, /)

items()

keys()

pop(k[,d])

popitem()

setdefault(key, default=None, /)

update([E, ]**F)

values()

clear()

copy()

from_api_repr(resource)

fromkeys(value=None, /)

get(key, default=None, /)

items()

keys()

pop(k[,d])

popitem()

setdefault(key, default=None, /)

update([E, ]**F)

values()

clear()

copy()

from_api_repr(resource)

fromkeys(value=None, /)

get(key, default=None, /)

items()

keys()

pop(k[,d])

popitem()

setdefault(key, default=None, /)

update([E, ]**F)

values()

clear()

copy()

from_api_repr(resource, bucket)

fromkeys(value=None, /)

get(key, default=None, /)

items()

keys()

pop(k[,d])

popitem()

setdefault(key, default=None, /)

update([E, ]**F)

values()

batch(raise_exception=True)

bucket(bucket_name, user_project=None)

create_anonymous_client()

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_hmac_key(
    service_account_email, project_id=None, user_project=None, timeout=60, retry=None
)

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='md5', retry=

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,
)

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

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

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

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=

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

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

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

close()

read(size=-1)

read1(size=-1)

readable()

seek(pos, whence=0)

seekable()

writable()

close()

flush()

readable()

seekable()

tell()

writable()

write(b)

__len__()

flush()

read(size=-1)

seek(pos)

tell()

write(b)

delete(timeout=60, retry=

exists(timeout=60, retry=

reload(timeout=60, retry=

update(timeout=60, retry=

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

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

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

from_api_repr(resource, bucket)

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