Storage Transfer Service V1 API - Class Google::Cloud::StorageTransfer::V1::MetadataOptions (v1.1.0)

Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::MetadataOptions.

Specifies the metadata options for running a transfer.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#acl

def acl() -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::Acl

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#acl=

def acl=(value) -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::Acl

Parameter

value (::Google::Cloud::StorageTransfer::V1::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.

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#gid

def gid() -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::GID

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#gid=

def gid=(value) -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::GID

Parameter

value (::Google::Cloud::StorageTransfer::V1::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.

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#kms_key

def kms_key() -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::KmsKey

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#kms_key=

def kms_key=(value) -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::KmsKey

Parameter

value (::Google::Cloud::StorageTransfer::V1::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.

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#mode

def mode() -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::Mode

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#mode=

def mode=(value) -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::Mode

Parameter

value (::Google::Cloud::StorageTransfer::V1::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.

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#storage_class

def storage_class() -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::StorageClass

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#storage_class=

def storage_class=(value) -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::StorageClass

Parameter

value (::Google::Cloud::StorageTransfer::V1::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.

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#symlink

def symlink() -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::Symlink

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#symlink=

def symlink=(value) -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::Symlink

Parameter

value (::Google::Cloud::StorageTransfer::V1::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.

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#temporary_hold

def temporary_hold() -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::TemporaryHold

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#temporary_hold=

def temporary_hold=(value) -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::TemporaryHold

Parameter

value (::Google::Cloud::StorageTransfer::V1::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.

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#time_created

def time_created() -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::TimeCreated

Returns

(::Google::Cloud::StorageTransfer::V1::MetadataOptions::TimeCreated) — Specifies how each object's timeCreated metadata is preserved for transfers. If unspecified, the default behavior is the same as TIME_CREATED_SKIP. This behavior is supported for transfers to Cloud Storage buckets from Cloud Storage, Amazon S3, S3-compatible storage, and Azure sources.

#time_created=

def time_created=(value) -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::TimeCreated

Parameter

value (::Google::Cloud::StorageTransfer::V1::MetadataOptions::TimeCreated) — Specifies how each object's timeCreated metadata is preserved for transfers. If unspecified, the default behavior is the same as TIME_CREATED_SKIP. This behavior is supported for transfers to Cloud Storage buckets from Cloud Storage, Amazon S3, S3-compatible storage, and Azure sources.

Returns

(::Google::Cloud::StorageTransfer::V1::MetadataOptions::TimeCreated) — Specifies how each object's timeCreated metadata is preserved for transfers. If unspecified, the default behavior is the same as TIME_CREATED_SKIP. This behavior is supported for transfers to Cloud Storage buckets from Cloud Storage, Amazon S3, S3-compatible storage, and Azure sources.

#uid

def uid() -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::UID

Returns

(::Google::Cloud::StorageTransfer::V1::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.

#uid=

def uid=(value) -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions::UID

Parameter

value (::Google::Cloud::StorageTransfer::V1::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.

Returns

(::Google::Cloud::StorageTransfer::V1::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.