Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Module blob (3.12.0)

Create / interact with Google Cloud Storage blobs.

Classes

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.

ObjectContexts(blob, custom=None)

Container for an object's contexts.

Parameters
Name	Description
`blob`	`Blob` blob for which these contexts apply to.
`custom`	`dict or NoneType` (Optional) Custom contexts mapping.

ObjectCustomContextPayload(value=None)

Payload for a custom context.

Parameter
Name	Description
`value`	`str or NoneType` (Optional) The value of the custom context.

Retention(blob, mode=None, retain_until_time=None, retention_expiration_time=None)

Map an object's retention configuration.