Interface TransferTypes.MetadataOptionsOrBuilder (1.54.0)

See more code actions.
public static interface TransferTypes.MetadataOptionsOrBuilder extends MessageOrBuilder
MessageOrBuilder
public abstract TransferTypes.MetadataOptions.Acl getAcl()

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.

.google.storagetransfer.v1.MetadataOptions.Acl acl = 5;

Returns
Type Description
TransferTypes.MetadataOptions.Acl

The acl.

getAclValue()

public abstract int getAclValue()

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.

.google.storagetransfer.v1.MetadataOptions.Acl acl = 5;

Returns
Type Description
int

The enum numeric value on the wire for acl.

getGid()

public abstract TransferTypes.MetadataOptions.GID getGid()

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.

.google.storagetransfer.v1.MetadataOptions.GID gid = 3;

Returns
Type Description
TransferTypes.MetadataOptions.GID

The gid.

getGidValue()

public abstract int getGidValue()

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.

.google.storagetransfer.v1.MetadataOptions.GID gid = 3;

Returns
Type Description
int

The enum numeric value on the wire for gid.

getKmsKey()

public abstract TransferTypes.MetadataOptions.KmsKey getKmsKey()

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 = 8;

Returns
Type Description
TransferTypes.MetadataOptions.KmsKey

The kmsKey.

getKmsKeyValue()

public abstract int getKmsKeyValue()

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 = 8;

Returns
Type Description
int

The enum numeric value on the wire for kmsKey.

getMode()

public abstract TransferTypes.MetadataOptions.Mode getMode()

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.

.google.storagetransfer.v1.MetadataOptions.Mode mode = 2;

Returns
Type Description
TransferTypes.MetadataOptions.Mode

The mode.

getModeValue()

public abstract int getModeValue()

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.

.google.storagetransfer.v1.MetadataOptions.Mode mode = 2;

Returns
Type Description
int

The enum numeric value on the wire for mode.

getStorageClass()

public abstract TransferTypes.MetadataOptions.StorageClass getStorageClass()

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 = 6;

Returns
Type Description
TransferTypes.MetadataOptions.StorageClass

The storageClass.

getStorageClassValue()

public abstract int getStorageClassValue()

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 = 6;

Returns
Type Description
int

The enum numeric value on the wire for storageClass.

public abstract TransferTypes.MetadataOptions.Symlink getSymlink()

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.

.google.storagetransfer.v1.MetadataOptions.Symlink symlink = 1;

Returns
Type Description
TransferTypes.MetadataOptions.Symlink

The symlink.

getSymlinkValue()

public abstract int getSymlinkValue()

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.

.google.storagetransfer.v1.MetadataOptions.Symlink symlink = 1;

Returns
Type Description
int

The enum numeric value on the wire for symlink.

getTemporaryHold()

public abstract TransferTypes.MetadataOptions.TemporaryHold getTemporaryHold()

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 = 7;

Returns
Type Description
TransferTypes.MetadataOptions.TemporaryHold

The temporaryHold.

getTemporaryHoldValue()

public abstract int getTemporaryHoldValue()

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 = 7;

Returns
Type Description
int

The enum numeric value on the wire for temporaryHold.

getTimeCreated()

public abstract TransferTypes.MetadataOptions.TimeCreated getTimeCreated()

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.

.google.storagetransfer.v1.MetadataOptions.TimeCreated time_created = 9;

Returns
Type Description
TransferTypes.MetadataOptions.TimeCreated

The timeCreated.

getTimeCreatedValue()

public abstract int getTimeCreatedValue()

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.

.google.storagetransfer.v1.MetadataOptions.TimeCreated time_created = 9;

Returns
Type Description
int

The enum numeric value on the wire for timeCreated.

getUid()

public abstract TransferTypes.MetadataOptions.UID getUid()

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.

.google.storagetransfer.v1.MetadataOptions.UID uid = 4;

Returns
Type Description
TransferTypes.MetadataOptions.UID

The uid.

getUidValue()

public abstract int getUidValue()

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.

.google.storagetransfer.v1.MetadataOptions.UID uid = 4;

Returns
Type Description
int

The enum numeric value on the wire for uid.