Class Blob (3.0.0rc1)

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

A wrapper around Cloud Storage's concept of an Object.

Parameters
Name	Description
`name`	`str` The name of the blob. This corresponds to the unique path of the object in the bucket. If bytes, will be converted to a unicode object. Blob / object names can contain any sequence of valid unicode characters, of length 1-1024 bytes when UTF-8 encoded.
`bucket`	`Bucket` The bucket to which this blob belongs.
`chunk_size`	`int` (Optional) The size of a chunk of data whenever iterating (in bytes). This must be a multiple of 256 KB per the API specification. If not specified, the chunk_size of the blob itself is used. If that is not specified, a default value of 40 MB is used.
`encryption_key`	`bytes` (Optional) 32 byte encryption key for customer-supplied encryption. See https://cloud.google.com/storage/docs/encryption#customer-supplied.
`kms_key_name`	`str` (Optional) Resource name of Cloud KMS key used to encrypt the blob's contents.
`generation`	`long` (Optional) If present, selects a specific revision of this object.

Properties

acl

Create our ACL on demand.

bucket

Bucket which contains the object.

Returns
Type	Description
`Bucket`	The object's bucket.

cache_control

Scalar property getter.

chunk_size

Get the blob's default chunk size.

Returns
Type	Description
`int or NoneType`	The current blob's chunk size, if it is set.

client

The client bound to this blob.

component_count

Number of underlying components that make up this object.

See https://cloud.google.com/storage/docs/json_api/v1/objects

Returns
Type	Description
`int or NoneType`	The component count (in case of a composed object) or `None` if the blob's resource has not been loaded from the server. This property will not be set on objects not created via `compose`.

content_disposition

Scalar property getter.

content_encoding

Scalar property getter.

content_language

Scalar property getter.

content_type

Scalar property getter.

crc32c

Scalar property getter.

custom_time

Retrieve the custom time for the object.

See https://cloud.google.com/storage/docs/json_api/v1/objects

Returns
Type	Description
`datetime.datetime or NoneType`	Datetime object parsed from RFC3339 valid timestamp, or `None` if the blob's resource has not been loaded from the server (see `reload`).

encryption_key

Retrieve the customer-supplied encryption key for the object.

Returns
Type	Description
`bytes or NoneType`	The encryption key or `None` if no customer-supplied encryption key was used, or the blob's resource has not been loaded from the server.

etag

Retrieve the ETag for the object.

See RFC 2616 (etags) and API reference docs.

Returns
Type	Description
`str or NoneType`	The blob etag or `None` if the blob's resource has not been loaded from the server.

event_based_hold

Scalar property getter.

generation

Retrieve the generation for the object.

See https://cloud.google.com/storage/docs/json_api/v1/objects

Returns
Type	Description
`int or NoneType`	The generation of the blob or `None` if the blob's resource has not been loaded from the server.

hard_delete_time

If this object has been soft-deleted, returns the time at which it will be permanently deleted.

Returns
Type	Description
`datetime.datetime or NoneType`	(readonly) The time that the object will be permanently deleted. Note this property is only set for soft-deleted objects.

id

Retrieve the ID for the object.

See https://cloud.google.com/storage/docs/json_api/v1/objects

The ID consists of the bucket name, object name, and generation number.

Returns
Type	Description
`str or NoneType`	The ID of the blob or `None` if the blob's resource has not been loaded from the server.

kms_key_name

Resource name of Cloud KMS key used to encrypt the blob's contents.

Returns
Type	Description
`str or NoneType`	The resource name or `None` if no Cloud KMS key was used, or the blob's resource has not been loaded from the server.

md5_hash

Scalar property getter.

media_link

Retrieve the media download URI for the object.

See https://cloud.google.com/storage/docs/json_api/v1/objects

Returns
Type	Description
`str or NoneType`	The media link for the blob or `None` if the blob's resource has not been loaded from the server.

metadata

Retrieve arbitrary/application specific metadata for the object.

See https://cloud.google.com/storage/docs/json_api/v1/objects

:setter: Update arbitrary/application specific metadata for the object. :getter: Retrieve arbitrary/application specific metadata for the object.

Returns
Type	Description
`dict or NoneType`	The metadata associated with the blob or `None` if the property is not set.

metageneration

Retrieve the metageneration for the object.

See https://cloud.google.com/storage/docs/json_api/v1/objects

Returns
Type	Description
`int or NoneType`	The metageneration of the blob or `None` if the blob's resource has not been loaded from the server.

owner

Retrieve info about the owner of the object.

See https://cloud.google.com/storage/docs/json_api/v1/objects

Returns
Type	Description
`dict or NoneType`	Mapping of owner's role/ID, or `None` if the blob's resource has not been loaded from the server.

path

Getter property for the URL path to this Blob.

Returns
Type	Description
`str`	The URL path to this Blob.

public_url

The public URL for this blob.

Use make_public to enable anonymous access via the returned URL.

Returns
Type	Description
`string`	The public URL for this blob.

retention

Retrieve the retention configuration for this object.

Returns
Type	Description
`Retention`	an instance for managing the object's retention configuration.

retention_expiration_time

Retrieve timestamp at which the object's retention period expires.

See https://cloud.google.com/storage/docs/json_api/v1/objects

Returns
Type	Description
`datetime.datetime or NoneType`	Datetime object parsed from RFC3339 valid timestamp, or `None` if the property is not set locally.

self_link

Retrieve the URI for the object.

See https://cloud.google.com/storage/docs/json_api/v1/objects

Returns
Type	Description
`str or NoneType`	The self link for the blob or `None` if the blob's resource has not been loaded from the server.

size

Size of the object, in bytes.

See https://cloud.google.com/storage/docs/json_api/v1/objects

Returns
Type	Description
`int or NoneType`	The size of the blob or `None` if the blob's resource has not been loaded from the server.

soft_delete_time

If this object has been soft-deleted, returns the time at which it became soft-deleted.

Returns
Type	Description
`datetime.datetime or NoneType`	(readonly) The time that the object became soft-deleted. Note this property is only set for soft-deleted objects.

storage_class

Scalar property getter.

temporary_hold

Scalar property getter.

time_created

Retrieve the timestamp at which the object was created.

See https://cloud.google.com/storage/docs/json_api/v1/objects

Returns
Type	Description
`datetime.datetime or NoneType`	Datetime object parsed from RFC3339 valid timestamp, or `None` if the blob's resource has not been loaded from the server (see `reload`).

time_deleted

Retrieve the timestamp at which the object was deleted.

See https://cloud.google.com/storage/docs/json_api/v1/objects

Returns
Type	Description
`datetime.datetime or NoneType`	Datetime object parsed from RFC3339 valid timestamp, or `None` if the blob's resource has not been loaded from the server (see `reload`). If the blob has not been deleted, this will never be set.

updated

Retrieve the timestamp at which the object was updated.

See https://cloud.google.com/storage/docs/json_api/v1/objects

Returns
Type	Description
`datetime.datetime or NoneType`	Datetime object parsed from RFC3339 valid timestamp, or `None` if the blob's resource has not been loaded from the server (see `reload`).

user_project

Project ID billed for API requests made via this blob.

Derived from bucket's value.

Methods

Blob

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

property name Get the blob's name.

compose

compose(sources, client=None, timeout=60, if_generation_match=None, if_metageneration_match=None, if_source_generation_match=None, retry=<google.cloud.storage.retry.ConditionalRetryPolicy object>)

Concatenate source blobs into this one.

If user_project is set on the bucket, bills the API request to that project.

See API reference docs and a code sample.

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

Create a resumable upload session.

Resumable upload sessions allow you to start an upload session from one client and complete the session in another. This method is called by the initiator to set the metadata and limits. The initiator then passes the session URL to the client that will upload the binary data. The client performs a PUT request on the session URL to complete the upload. This process allows untrusted clients to upload to an access-controlled bucket.

For more details, see the documentation on signed URLs.

The content type of the upload will be determined in order of precedence:

The value passed in to this method (if not :data:None)
The value stored on the current blob
The default value ('application/octet-stream')

See the object versioning and lifecycle API documents for details.

If encryption_key is set, the blob will be encrypted with a customer-supplied encryption key.

If user_project is set on the bucket, bills the API request to that project.

Exceptions
Type	Description
`GoogleCloudError`	if the session creation response returns an error status.

Returns
Type	Description
`str`	The resumable upload session URL. The upload can be completed by making an HTTP PUT request with the file's contents.

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

Deletes a blob from Cloud Storage.

If user_project is set on the bucket, bills the API request to that project.

Exceptions
Type	Description
`NotFound`	(propagated from delete_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=<google.api_core.retry.retry_unary.Retry object>)

Download the contents of this blob as a bytes object.

If user_project is set on the bucket, bills the API request to that project.

Exceptions
Type	Description
`NotFound`

Returns
Type	Description
`bytes`	The data stored in this 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=<google.api_core.retry.retry_unary.Retry object>)

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

If user_project is set on the bucket, bills the API request to that project.

Note: Deprecated alias for download_as_bytes.

Exceptions
Type	Description
`NotFound`

Returns
Type	Description
`bytes`	The data stored in this 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=<google.api_core.retry.retry_unary.Retry object>)

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

If user_project is set on the bucket, bills the API request to that project.

Returns
Type	Description
`text`	The data stored in this blob, decoded to text.

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

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

Note: If the server-set property, media_link, is not yet initialized, makes an additional API request to load it.

For more fine-grained control over the download process, check out google-resumable-media. For example, this library allows downloading parts of a blob rather than the whole thing.

If user_project is set on the bucket, bills the API request to that project.

Exceptions
Type	Description
`NotFound`

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

Download the contents of this blob into a named file.

If user_project is set on the bucket, bills the API request to that project.

See a code sample to download a file with a customer-supplied encryption key.

Exceptions
Type	Description
`NotFound`

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

Determines whether or not this blob exists.

If user_project is set on the bucket, bills the API request to that project.

Returns
Type	Description
`bool`	True if the blob exists in Cloud Storage.

from_string

from_string(uri, client=None)

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

Note: Deprecated alias for from_uri.

from google.cloud import storage
from google.cloud.storage.blob import Blob
client = storage.Client()
blob = Blob.from_string("gs://bucket/object", client=client)

Parameters
Name	Description
`uri`	`str` The blob uri following a gs://bucket/object pattern. Both a bucket and object name is required to construct a blob object.
`client`	`Client` (Optional) The client to use. Application code should always pass `client`.

Returns
Type	Description
`Blob`	The blob object created.

from_uri

from_uri(uri, client=None)

Get a constructor for blob object by URI.

from google.cloud import storage
from google.cloud.storage.blob import Blob
client = storage.Client()
blob = Blob.from_uri("gs://bucket/object", client=client)

Parameters
Name	Description
`uri`	`str` The blob uri following a gs://bucket/object pattern. Both a bucket and object name is required to construct a blob object.
`client`	`Client` (Optional) The client to use. Application code should always pass `client`.

Returns
Type	Description
`Blob`	The blob object created.

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 a code sample.

This is particularly useful if you don't want publicly accessible blobs, but don't want to require users to explicitly log in.

If bucket_bound_hostname is set as an argument of api_access_endpoint, https works only if using a CDN.

Parameters
Name	Description
`expiration`	`Union[Integer, datetime.datetime, datetime.timedelta]` Point in time when the signed URL should expire. If a `datetime` instance is passed without an explicit `tzinfo` set, it will be assumed to be `UTC`.
`api_access_endpoint`	`str` (Optional) URI base, for instance "https://storage.googleapis.com". If not specified, the client's api_endpoint will be used. Incompatible with bucket_bound_hostname.
`method`	`str` The HTTP verb that will be used when requesting the URL.
`content_md5`	`str` (Optional) The MD5 hash of the object referenced by `resource`.
`content_type`	`str` (Optional) The content type of the object referenced by `resource`.
`response_disposition`	`str` (Optional) Content disposition of responses to requests for the signed URL. For example, to enable the signed URL to initiate a file of `blog.png`, use the value `'attachment; filename=blob.png'`.
`response_type`	`str` (Optional) Content type of responses to requests for the signed URL. Ignored if content_type is set on object/blob metadata.
`generation`	`str` (Optional) A value that indicates which generation of the resource to fetch.
`headers`	`dict` (Optional) Additional HTTP headers to be included as part of the signed URLs. See: https://cloud.google.com/storage/docs/xml-api/reference-headers Requests using the signed URL must pass the specified header (name and value) with each request for the URL.
`query_parameters`	`dict` (Optional) Additional query parameters to be included as part of the signed URLs. See: https://cloud.google.com/storage/docs/xml-api/reference-headers#query
`client`	`Client` (Optional) The client to use. If not passed, falls back to the `client` stored on the blob's bucket.
`credentials`	`google.auth.credentials.Credentials` (Optional) The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment.
`version`	`str` (Optional) The version of signed credential to create. Must be one of 'v2' 'v4'.
`service_account_email`	`str` (Optional) E-mail address of the service account.
`access_token`	`str` (Optional) Access token for a service account.
`virtual_hosted_style`	`bool` (Optional) If true, then construct the URL relative the bucket's virtual hostname, e.g., '
`bucket_bound_hostname`	`str` (Optional) If passed, then construct the URL relative to the bucket-bound hostname. Value can be a bare or with scheme, e.g., 'example.com' or 'http://example.com'. Incompatible with api_access_endpoint and virtual_hosted_style. See: https://cloud.google.com/storage/docs/request-endpoints#cname
`scheme`	`str` (Optional) If `bucket_bound_hostname` is passed as a bare hostname, use this value as the scheme. `https` will work only when using a CDN. Defaults to `"http"`.

Exceptions
Type	Description
`ValueError	when version is invalid or mutually exclusive arguments are used.
`TypeError	when expiration is not a valid type.
`AttributeError	if credentials is not an instance of `google.auth.credentials.Signing`.

Returns
Type	Description
`str`	A signed URL you can use to access the resource until expiration.

get_iam_policy

get_iam_policy(client=None, requested_policy_version=None, timeout=60, retry=<google.api_core.retry.retry_unary.Retry object>)

Retrieve the IAM policy for the object.

Note: Blob- / object-level IAM support does not yet exist and methods currently call an internal ACL backend not providing any utility beyond the blob's acl at this time. The API may be enhanced in the future and is currently undocumented. Use acl for managing object access control.

Returns
Type	Description
`google.api_core.iam.Policy`	the policy instance, based on the resource returned from the `getIamPolicy` API request.

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

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

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

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

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.

This method can be used as a context manager, just like Python's built-in 'open()' function.

While reading, as with other read methods, if blob.generation is not set the most recent blob generation will be used. Because the file-like IO reader downloads progressively in chunks, this could result in data from multiple versions being mixed together. If this is a concern, use either bucket.get_blob(), or blob.reload(), which will download the latest generation number and set it; or, if the generation is known, set it manually, for instance with bucket.blob(generation=123456).

Checksumming (hashing) to verify data integrity is disabled for reads using this feature because reads are implemented using request ranges, which do not provide checksums to validate. See https://cloud.google.com/storage/docs/hashes-etags for details.

See a code sample.

Keyword arguments to pass to the underlying API calls. For both uploads and downloads, the following arguments are supported:

if_generation_match
if_generation_not_match
if_metageneration_match
if_metageneration_not_match
timeout
retry

For downloads only, the following additional arguments are supported:

raw_download

For uploads only, the following additional arguments are supported:

content_type
predefined_acl
checksum

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

Sends all changed properties in a PATCH request.

Updates the _properties with the response from the backend.

If user_project is set, bills the API request to that project.

Parameters
Name	Description
`client`	`Client or NoneType` the client to use. If not passed, falls back to the `client` stored on the current object.
`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`	`float or tuple` (Optional) The amount of time, in seconds, to wait for the server response. See: `configuring_timeouts`
`retry`	`google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy` (Optional) How to retry the RPC. See: `configuring_retries`
`override_unlocked_retention`	`bool` (Optional) override_unlocked_retention must be set to True if the operation includes a retention property that changes the mode from Unlocked to Locked, reduces the retainUntilTime, or removes the retention configuration from the object. See: https://cloud.google.com/storage/docs/json_api/v1/objects/patch

path_helper

path_helper(bucket_path, blob_name)

Relative URL path for a blob.

Parameters
Name	Description
`bucket_path`	`str` The URL path for a bucket.
`blob_name`	`str` The name of the blob.

Returns
Type	Description
`str`	The relative URL path for `blob_name`.

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

Reload properties from Cloud Storage.

If user_project is set, bills the API request to that project.

Parameters
Name	Description
`client`	`Client or NoneType` the client to use. If not passed, falls back to the `client` stored on the current object.
`projection`	`str` (Optional) If used, must be 'full' or 'noAcl'. Defaults to `'noAcl'`. Specifies the set of properties to return.
`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`	`float or tuple` (Optional) The amount of time, in seconds, to wait for the server response. See: `configuring_timeouts`
`retry`	`google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy` (Optional) How to retry the RPC. See: `configuring_retries`
`soft_deleted`	`bool` (Optional) If True, looks for a soft-deleted object. Will only return the object metadata if the object exists and is in a soft-deleted state. `generation` is required to be set on the blob if `soft_deleted` is set to True. See: https://cloud.google.com/storage/docs/soft-delete

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

Rewrite source blob into this one.

If user_project is set on the bucket, bills the API request to that project.

Note: rewrite is not supported in a Batch context.

Returns
Type	Description
`tuple`	`(token, bytes_rewritten, total_bytes)`, where `token` is a rewrite token (`None` if the rewrite is complete), `bytes_rewritten` is the number of bytes rewritten so far, and `total_bytes` is the total number of bytes to be rewritten.

set_iam_policy

set_iam_policy(policy, client=None, timeout=60, retry=<google.cloud.storage.retry.ConditionalRetryPolicy object>)

Update the IAM policy for the bucket.

Returns
Type	Description
`google.api_core.iam.Policy`	the policy instance, based on the resource returned from the `setIamPolicy` API request.

test_iam_permissions

test_iam_permissions(permissions, client=None, timeout=60, retry=<google.api_core.retry.retry_unary.Retry object>)

API call: test permissions

Returns
Type	Description
`list of string`	the permissions returned by the `testIamPermissions` API request.

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

Sends all properties in a PUT request.

Updates the _properties with the response from the backend.

If user_project is set, bills the API request to that project.

Parameters
Name	Description
`client`	`Client or NoneType` the client to use. If not passed, falls back to the `client` stored on the current object.
`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`	`float or tuple` (Optional) The amount of time, in seconds, to wait for the server response. See: `configuring_timeouts`
`retry`	`google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy` (Optional) How to retry the RPC. See: `configuring_retries`
`override_unlocked_retention`	`bool` (Optional) override_unlocked_retention must be set to True if the operation includes a retention property that changes the mode from Unlocked to Locked, reduces the retainUntilTime, or removes the retention configuration from the object. See: https://cloud.google.com/storage/docs/json_api/v1/objects/patch

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

Update blob's storage class via a rewrite-in-place. This helper will wait for the rewrite to complete before returning, so it may take some time for large files.

See https://cloud.google.com/storage/docs/per-object-storage-class

If user_project is set on the bucket, bills the API request to that project.

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

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

The content type of the upload will be determined in order of precedence:

The value passed in to this method (if not :data:None)
The value stored on the current blob
The default value ('application/octet-stream')

See the object versioning and lifecycle API documents for details.

If the size of the data to be uploaded exceeds 8 MB a resumable media request will be used, otherwise the content and the metadata will be uploaded in a single multipart upload request.

For more fine-grained over the upload process, check out google-resumable-media.

If user_project is set on the bucket, bills the API request to that project.

Exceptions
Type	Description
`GoogleCloudError`	if the upload response returns an error status.

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

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

The content type of the upload will be determined in order of precedence:

The value passed in to this method (if not :data:None)
The value stored on the current blob
The value given by mimetypes.guess_type
The default value ('application/octet-stream')

See the object versioning and lifecycle API documents for details.

If user_project is set on the bucket, bills the API request to that project.

See a code sample to upload a file with a customer-supplied encryption key.

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

Upload contents of this blob from the provided string.

See the object versioning and lifecycle API documents for details.

If user_project is set on the bucket, bills the API request to that project.

Class Blob (3.0.0rc1)

Parameters

Properties

acl

bucket

cache_control

chunk_size

client

component_count

content_disposition

content_encoding

content_language

content_type

crc32c

custom_time

encryption_key

etag

event_based_hold

generation

hard_delete_time

id

kms_key_name

md5_hash

media_link

metadata

metageneration

owner

path

public_url

retention

retention_expiration_time

self_link

size

soft_delete_time

storage_class

temporary_hold

time_created

time_deleted

updated

user_project

Methods

Blob

compose

create_resumable_upload_session

delete

download_as_bytes

download_as_string

download_as_text

download_to_file

download_to_filename

exists

from_string

from_uri

generate_signed_url

get_iam_policy

make_private

make_public

open

patch

path_helper

reload

rewrite

set_iam_policy

test_iam_permissions

update

update_storage_class

upload_from_file

upload_from_filename

upload_from_string