Class MetadataOptions (1.5.1)

MetadataOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Specifies the metadata options for running a transfer.

Attributes

NameDescription
symlink google.cloud.storage_transfer_v1.types.MetadataOptions.Symlink
Specifies how symlinks should be handled by the transfer. By default, symlinks are not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.
mode google.cloud.storage_transfer_v1.types.MetadataOptions.Mode
Specifies how each file's mode attribute should be handled by the transfer. By default, mode is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.
gid google.cloud.storage_transfer_v1.types.MetadataOptions.GID
Specifies how each file's POSIX group ID (GID) attribute should be handled by the transfer. By default, GID is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.
uid google.cloud.storage_transfer_v1.types.MetadataOptions.UID
Specifies how each file's POSIX user ID (UID) attribute should be handled by the transfer. By default, UID is not preserved. Only applicable to transfers involving POSIX file systems, and ignored for other transfers.
acl google.cloud.storage_transfer_v1.types.MetadataOptions.Acl
Specifies how each object's ACLs should be preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as ACL_DESTINATION_BUCKET_DEFAULT.
storage_class google.cloud.storage_transfer_v1.types.MetadataOptions.StorageClass
Specifies the storage class to set on objects being transferred to Google Cloud Storage buckets. If unspecified, the default behavior is the same as `STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT][google.storagetransfer.v1.MetadataOptions.StorageClass.STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT]`.
temporary_hold google.cloud.storage_transfer_v1.types.MetadataOptions.TemporaryHold
Specifies how each object's temporary hold status should be preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as `TEMPORARY_HOLD_PRESERVE][google.storagetransfer.v1.MetadataOptions.TemporaryHold.TEMPORARY_HOLD_PRESERVE]`.
kms_key google.cloud.storage_transfer_v1.types.MetadataOptions.KmsKey
Specifies how each object's Cloud KMS customer-managed encryption key (CMEK) is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as `KMS_KEY_DESTINATION_BUCKET_DEFAULT][google.storagetransfer.v1.MetadataOptions.KmsKey.KMS_KEY_DESTINATION_BUCKET_DEFAULT]`.
time_created google.cloud.storage_transfer_v1.types.MetadataOptions.TimeCreated
Specifies how each object's ``timeCreated`` metadata is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as `TIME_CREATED_SKIP][google.storagetransfer.v1.MetadataOptions.TimeCreated.TIME_CREATED_SKIP]`.

Inheritance

builtins.object > proto.message.Message > MetadataOptions

Classes

Acl

Acl(value)

Options for handling Cloud Storage object ACLs.

GID

GID(value)

Options for handling file GID attribute.

KmsKey

KmsKey(value)

Options for handling the KmsKey setting for Google Cloud Storage objects.

Mode

Mode(value)

Options for handling file mode attribute.

StorageClass

StorageClass(value)

Options for handling Google Cloud Storage object storage class.

Symlink(value)

Whether symlinks should be skipped or preserved during a transfer job.

TemporaryHold

TemporaryHold(value)

Options for handling temporary holds for Google Cloud Storage objects.

TimeCreated

TimeCreated(value)

Options for handling timeCreated metadata for Google Cloud Storage objects.

UID

UID(value)

Options for handling file UID attribute.