Class TransferTypes.MetadataOptions.Builder (1.4.0)

Version 1.4.0

• 1.42.0 (latest)
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.0.4

public static final class TransferTypes.MetadataOptions.Builder extends GeneratedMessageV3.Builder<TransferTypes.MetadataOptions.Builder> implements TransferTypes.MetadataOptionsOrBuilder

Specifies the metadata options for running a transfer.

Protobuf type google.storagetransfer.v1.MetadataOptions

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransferTypes.MetadataOptions.Builder

Implements

TransferTypes.MetadataOptionsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.MetadataOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
TransferTypes.MetadataOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public TransferTypes.MetadataOptions build()

Returns

Type	Description
TransferTypes.MetadataOptions

buildPartial()

public TransferTypes.MetadataOptions buildPartial()

Returns

Type	Description
TransferTypes.MetadataOptions

clear()

public TransferTypes.MetadataOptions.Builder clear()

Returns

Type	Description
TransferTypes.MetadataOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAcl()

public TransferTypes.MetadataOptions.Builder clearAcl()

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.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TransferTypes.MetadataOptions.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
TransferTypes.MetadataOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGid()

public TransferTypes.MetadataOptions.Builder clearGid()

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.Builder	This builder for chaining.

clearKmsKey()

public TransferTypes.MetadataOptions.Builder clearKmsKey()

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.Builder	This builder for chaining.

clearMode()

public TransferTypes.MetadataOptions.Builder clearMode()

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.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TransferTypes.MetadataOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
TransferTypes.MetadataOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearStorageClass()

public TransferTypes.MetadataOptions.Builder clearStorageClass()

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.Builder	This builder for chaining.

clearSymlink()

public TransferTypes.MetadataOptions.Builder clearSymlink()

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.Builder	This builder for chaining.

clearTemporaryHold()

public TransferTypes.MetadataOptions.Builder clearTemporaryHold()

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.Builder	This builder for chaining.

clearTimeCreated()

public TransferTypes.MetadataOptions.Builder clearTimeCreated()

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

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

clearUid()

public TransferTypes.MetadataOptions.Builder clearUid()

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.Builder	This builder for chaining.

clone()

public TransferTypes.MetadataOptions.Builder clone()

Returns

Type	Description
TransferTypes.MetadataOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAcl()

public 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 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.

getDefaultInstanceForType()

public TransferTypes.MetadataOptions getDefaultInstanceForType()

Returns

Type	Description
TransferTypes.MetadataOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getGid()

public 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 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 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 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 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 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 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 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.

getSymlink()

public 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 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 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 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 TransferTypes.MetadataOptions.TimeCreated getTimeCreated()

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

Returns

Type	Description
TransferTypes.MetadataOptions.TimeCreated	The timeCreated.

getTimeCreatedValue()

public int getTimeCreatedValue()

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

Returns

Type	Description
int	The enum numeric value on the wire for timeCreated.

getUid()

public 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransferTypes.MetadataOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
TransferTypes.MetadataOptions.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public TransferTypes.MetadataOptions.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
TransferTypes.MetadataOptions.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(TransferTypes.MetadataOptions other)

public TransferTypes.MetadataOptions.Builder mergeFrom(TransferTypes.MetadataOptions other)

Parameter

Name	Description
other	TransferTypes.MetadataOptions

Returns

Type	Description
TransferTypes.MetadataOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.MetadataOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
TransferTypes.MetadataOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAcl(TransferTypes.MetadataOptions.Acl value)

public TransferTypes.MetadataOptions.Builder setAcl(TransferTypes.MetadataOptions.Acl value)

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;

Parameter

Name	Description
value	TransferTypes.MetadataOptions.Acl The acl to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setAclValue(int value)

public TransferTypes.MetadataOptions.Builder setAclValue(int value)

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;

Parameter

Name	Description
value	int The enum numeric value on the wire for acl to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.MetadataOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
TransferTypes.MetadataOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGid(TransferTypes.MetadataOptions.GID value)

public TransferTypes.MetadataOptions.Builder setGid(TransferTypes.MetadataOptions.GID value)

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;

Parameter

Name	Description
value	TransferTypes.MetadataOptions.GID The gid to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setGidValue(int value)

public TransferTypes.MetadataOptions.Builder setGidValue(int value)

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;

Parameter

Name	Description
value	int The enum numeric value on the wire for gid to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setKmsKey(TransferTypes.MetadataOptions.KmsKey value)

public TransferTypes.MetadataOptions.Builder setKmsKey(TransferTypes.MetadataOptions.KmsKey value)

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;

Parameter

Name	Description
value	TransferTypes.MetadataOptions.KmsKey The kmsKey to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setKmsKeyValue(int value)

public TransferTypes.MetadataOptions.Builder setKmsKeyValue(int value)

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;

Parameter

Name	Description
value	int The enum numeric value on the wire for kmsKey to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setMode(TransferTypes.MetadataOptions.Mode value)

public TransferTypes.MetadataOptions.Builder setMode(TransferTypes.MetadataOptions.Mode value)

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;

Parameter

Name	Description
value	TransferTypes.MetadataOptions.Mode The mode to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setModeValue(int value)

public TransferTypes.MetadataOptions.Builder setModeValue(int value)

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;

Parameter

Name	Description
value	int The enum numeric value on the wire for mode to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TransferTypes.MetadataOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
TransferTypes.MetadataOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStorageClass(TransferTypes.MetadataOptions.StorageClass value)

public TransferTypes.MetadataOptions.Builder setStorageClass(TransferTypes.MetadataOptions.StorageClass value)

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;

Parameter

Name	Description
value	TransferTypes.MetadataOptions.StorageClass The storageClass to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setStorageClassValue(int value)

public TransferTypes.MetadataOptions.Builder setStorageClassValue(int value)

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;

Parameter

Name	Description
value	int The enum numeric value on the wire for storageClass to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setSymlink(TransferTypes.MetadataOptions.Symlink value)

public TransferTypes.MetadataOptions.Builder setSymlink(TransferTypes.MetadataOptions.Symlink value)

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;

Parameter

Name	Description
value	TransferTypes.MetadataOptions.Symlink The symlink to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setSymlinkValue(int value)

public TransferTypes.MetadataOptions.Builder setSymlinkValue(int value)

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;

Parameter

Name	Description
value	int The enum numeric value on the wire for symlink to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setTemporaryHold(TransferTypes.MetadataOptions.TemporaryHold value)

public TransferTypes.MetadataOptions.Builder setTemporaryHold(TransferTypes.MetadataOptions.TemporaryHold value)

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;

Parameter

Name	Description
value	TransferTypes.MetadataOptions.TemporaryHold The temporaryHold to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setTemporaryHoldValue(int value)

public TransferTypes.MetadataOptions.Builder setTemporaryHoldValue(int value)

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;

Parameter

Name	Description
value	int The enum numeric value on the wire for temporaryHold to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setTimeCreated(TransferTypes.MetadataOptions.TimeCreated value)

public TransferTypes.MetadataOptions.Builder setTimeCreated(TransferTypes.MetadataOptions.TimeCreated value)

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

Parameter

Name	Description
value	TransferTypes.MetadataOptions.TimeCreated The timeCreated to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setTimeCreatedValue(int value)

public TransferTypes.MetadataOptions.Builder setTimeCreatedValue(int value)

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

Parameter

Name	Description
value	int The enum numeric value on the wire for timeCreated to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setUid(TransferTypes.MetadataOptions.UID value)

public TransferTypes.MetadataOptions.Builder setUid(TransferTypes.MetadataOptions.UID value)

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;

Parameter

Name	Description
value	TransferTypes.MetadataOptions.UID The uid to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setUidValue(int value)

public TransferTypes.MetadataOptions.Builder setUidValue(int value)

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;

Parameter

Name	Description
value	int The enum numeric value on the wire for uid to set.

Returns

Type	Description
TransferTypes.MetadataOptions.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.MetadataOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
TransferTypes.MetadataOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)