MetadataOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)Specifies the metadata options for running a transfer.
Attributes | |
|---|---|
| Name | Description |
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].
|
Classes
Acl
Acl(value)Options for handling Cloud Storage object ACLs.
Values:
ACL_UNSPECIFIED (0):
ACL behavior is unspecified.
ACL_DESTINATION_BUCKET_DEFAULT (1):
Use the destination bucket's default object
ACLS, if applicable.
ACL_PRESERVE (2):
Preserve the object's original ACLs. This requires the
service account to have storage.objects.getIamPolicy
permission for the source object. Uniform bucket-level
access <https://cloud.google.com/storage/docs/uniform-bucket-level-access>__
must not be enabled on either the source or destination
buckets.
GID
GID(value)Options for handling file GID attribute.
Values: GID_UNSPECIFIED (0): GID behavior is unspecified. GID_SKIP (1): Do not preserve GID during a transfer job. GID_NUMBER (2): Preserve GID during a transfer job.
KmsKey
KmsKey(value)Options for handling the KmsKey setting for Google Cloud Storage objects.
Values: KMS_KEY_UNSPECIFIED (0): KmsKey behavior is unspecified. KMS_KEY_DESTINATION_BUCKET_DEFAULT (1): Use the destination bucket's default encryption settings. KMS_KEY_PRESERVE (2): Preserve the object's original Cloud KMS customer-managed encryption key (CMEK) if present. Objects that do not use a Cloud KMS encryption key will be encrypted using the destination bucket's encryption settings.
Mode
Mode(value)Options for handling file mode attribute.
Values: MODE_UNSPECIFIED (0): Mode behavior is unspecified. MODE_SKIP (1): Do not preserve mode during a transfer job. MODE_PRESERVE (2): Preserve mode during a transfer job.
StorageClass
StorageClass(value)Options for handling Google Cloud Storage object storage class.
Values: STORAGE_CLASS_UNSPECIFIED (0): Storage class behavior is unspecified. STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT (1): Use the destination bucket's default storage class. STORAGE_CLASS_PRESERVE (2): Preserve the object's original storage class. This is only supported for transfers from Google Cloud Storage buckets. REGIONAL and MULTI_REGIONAL storage classes will be mapped to STANDARD to ensure they can be written to the destination bucket. STORAGE_CLASS_STANDARD (3): Set the storage class to STANDARD. STORAGE_CLASS_NEARLINE (4): Set the storage class to NEARLINE. STORAGE_CLASS_COLDLINE (5): Set the storage class to COLDLINE. STORAGE_CLASS_ARCHIVE (6): Set the storage class to ARCHIVE.
Symlink
Symlink(value)Whether symlinks should be skipped or preserved during a transfer job.
Values: SYMLINK_UNSPECIFIED (0): Symlink behavior is unspecified. SYMLINK_SKIP (1): Do not preserve symlinks during a transfer job. SYMLINK_PRESERVE (2): Preserve symlinks during a transfer job.
TemporaryHold
TemporaryHold(value)Options for handling temporary holds for Google Cloud Storage objects.
Values: TEMPORARY_HOLD_UNSPECIFIED (0): Temporary hold behavior is unspecified. TEMPORARY_HOLD_SKIP (1): Do not set a temporary hold on the destination object. TEMPORARY_HOLD_PRESERVE (2): Preserve the object's original temporary hold status.
TimeCreated
TimeCreated(value)Options for handling timeCreated metadata for Google Cloud
Storage objects.
Values:
TIME_CREATED_UNSPECIFIED (0):
TimeCreated behavior is unspecified.
TIME_CREATED_SKIP (1):
Do not preserve the timeCreated metadata from the source
object.
TIME_CREATED_PRESERVE_AS_CUSTOM_TIME (2):
Preserves the source object's timeCreated metadata in
the customTime field in the destination object. Note
that any value stored in the source object's customTime
field will not be propagated to the destination object.
UID
UID(value)Options for handling file UID attribute.
Values: UID_UNSPECIFIED (0): UID behavior is unspecified. UID_SKIP (1): Do not preserve UID during a transfer job. UID_NUMBER (2): Preserve UID during a transfer job.