Class TransferTypes.TransferOptions.Builder (1.52.0)

Version 1.52.0

• 1.55.0 (latest)
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 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.TransferOptions.Builder extends GeneratedMessageV3.Builder<TransferTypes.TransferOptions.Builder> implements TransferTypes.TransferOptionsOrBuilder

TransferOptions define the actions to be performed on objects in a transfer.

Protobuf type google.storagetransfer.v1.TransferOptions

Inheritance

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

Implements

TransferTypes.TransferOptionsOrBuilder

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)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(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.TransferOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
TransferTypes.TransferOptions.Builder

Overrides

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

build()

public TransferTypes.TransferOptions build()

Returns
Type	Description
TransferTypes.TransferOptions

buildPartial()

public TransferTypes.TransferOptions buildPartial()

Returns
Type	Description
TransferTypes.TransferOptions

clear()

public TransferTypes.TransferOptions.Builder clear()

Returns
Type	Description
TransferTypes.TransferOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDeleteObjectsFromSourceAfterTransfer()

public TransferTypes.TransferOptions.Builder clearDeleteObjectsFromSourceAfterTransfer()

Whether objects should be deleted from the source after they are transferred to the sink.

Note: This option and delete_objects_unique_in_sink are mutually exclusive.

bool delete_objects_from_source_after_transfer = 3;

Returns
Type	Description
TransferTypes.TransferOptions.Builder	This builder for chaining.

clearDeleteObjectsUniqueInSink()

public TransferTypes.TransferOptions.Builder clearDeleteObjectsUniqueInSink()

Whether objects that exist only in the sink should be deleted.

Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.

bool delete_objects_unique_in_sink = 2;

Returns
Type	Description
TransferTypes.TransferOptions.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
TransferTypes.TransferOptions.Builder

Overrides

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

clearMetadataOptions()

public TransferTypes.TransferOptions.Builder clearMetadataOptions()

Represents the selected metadata options for a transfer job.

.google.storagetransfer.v1.MetadataOptions metadata_options = 5;

Returns
Type	Description
TransferTypes.TransferOptions.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
TransferTypes.TransferOptions.Builder

Overrides

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

clearOverwriteObjectsAlreadyExistingInSink()

public TransferTypes.TransferOptions.Builder clearOverwriteObjectsAlreadyExistingInSink()

When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object.

bool overwrite_objects_already_existing_in_sink = 1;

Returns
Type	Description
TransferTypes.TransferOptions.Builder	This builder for chaining.

clearOverwriteWhen()

public TransferTypes.TransferOptions.Builder clearOverwriteWhen()

When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.

.google.storagetransfer.v1.TransferOptions.OverwriteWhen overwrite_when = 4;

Returns
Type	Description
TransferTypes.TransferOptions.Builder	This builder for chaining.

clone()

public TransferTypes.TransferOptions.Builder clone()

Returns
Type	Description
TransferTypes.TransferOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public TransferTypes.TransferOptions getDefaultInstanceForType()

Returns
Type	Description
TransferTypes.TransferOptions

getDeleteObjectsFromSourceAfterTransfer()

public boolean getDeleteObjectsFromSourceAfterTransfer()

Whether objects should be deleted from the source after they are transferred to the sink.

Note: This option and delete_objects_unique_in_sink are mutually exclusive.

bool delete_objects_from_source_after_transfer = 3;

Returns
Type	Description
boolean	The deleteObjectsFromSourceAfterTransfer.

getDeleteObjectsUniqueInSink()

public boolean getDeleteObjectsUniqueInSink()

Whether objects that exist only in the sink should be deleted.

Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.

bool delete_objects_unique_in_sink = 2;

Returns
Type	Description
boolean	The deleteObjectsUniqueInSink.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMetadataOptions()

public TransferTypes.MetadataOptions getMetadataOptions()

Represents the selected metadata options for a transfer job.

.google.storagetransfer.v1.MetadataOptions metadata_options = 5;

Returns
Type	Description
TransferTypes.MetadataOptions	The metadataOptions.

getMetadataOptionsBuilder()

public TransferTypes.MetadataOptions.Builder getMetadataOptionsBuilder()

Represents the selected metadata options for a transfer job.

.google.storagetransfer.v1.MetadataOptions metadata_options = 5;

Returns
Type	Description
TransferTypes.MetadataOptions.Builder

getMetadataOptionsOrBuilder()

public TransferTypes.MetadataOptionsOrBuilder getMetadataOptionsOrBuilder()

Represents the selected metadata options for a transfer job.

.google.storagetransfer.v1.MetadataOptions metadata_options = 5;

Returns
Type	Description
TransferTypes.MetadataOptionsOrBuilder

getOverwriteObjectsAlreadyExistingInSink()

public boolean getOverwriteObjectsAlreadyExistingInSink()

When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object.

bool overwrite_objects_already_existing_in_sink = 1;

Returns
Type	Description
boolean	The overwriteObjectsAlreadyExistingInSink.

getOverwriteWhen()

public TransferTypes.TransferOptions.OverwriteWhen getOverwriteWhen()

When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.

.google.storagetransfer.v1.TransferOptions.OverwriteWhen overwrite_when = 4;

Returns
Type	Description
TransferTypes.TransferOptions.OverwriteWhen	The overwriteWhen.

getOverwriteWhenValue()

public int getOverwriteWhenValue()

When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.

.google.storagetransfer.v1.TransferOptions.OverwriteWhen overwrite_when = 4;

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

hasMetadataOptions()

public boolean hasMetadataOptions()

Represents the selected metadata options for a transfer job.

.google.storagetransfer.v1.MetadataOptions metadata_options = 5;

Returns
Type	Description
boolean	Whether the metadataOptions field is set.

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.TransferOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.TransferOptions.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public TransferTypes.TransferOptions.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
TransferTypes.TransferOptions.Builder

Overrides

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

mergeFrom(TransferTypes.TransferOptions other)

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

Parameter
Name	Description
other	TransferTypes.TransferOptions

Returns
Type	Description
TransferTypes.TransferOptions.Builder

mergeMetadataOptions(TransferTypes.MetadataOptions value)

public TransferTypes.TransferOptions.Builder mergeMetadataOptions(TransferTypes.MetadataOptions value)

Represents the selected metadata options for a transfer job.

.google.storagetransfer.v1.MetadataOptions metadata_options = 5;

Parameter
Name	Description
value	TransferTypes.MetadataOptions

Returns
Type	Description
TransferTypes.TransferOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
TransferTypes.TransferOptions.Builder

Overrides

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

setDeleteObjectsFromSourceAfterTransfer(boolean value)

public TransferTypes.TransferOptions.Builder setDeleteObjectsFromSourceAfterTransfer(boolean value)

Whether objects should be deleted from the source after they are transferred to the sink.

Note: This option and delete_objects_unique_in_sink are mutually exclusive.

bool delete_objects_from_source_after_transfer = 3;

Parameter
Name	Description
value	boolean The deleteObjectsFromSourceAfterTransfer to set.

Returns
Type	Description
TransferTypes.TransferOptions.Builder	This builder for chaining.

setDeleteObjectsUniqueInSink(boolean value)

public TransferTypes.TransferOptions.Builder setDeleteObjectsUniqueInSink(boolean value)

Whether objects that exist only in the sink should be deleted.

Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.

bool delete_objects_unique_in_sink = 2;

Parameter
Name	Description
value	boolean The deleteObjectsUniqueInSink to set.

Returns
Type	Description
TransferTypes.TransferOptions.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
TransferTypes.TransferOptions.Builder

Overrides

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

setMetadataOptions(TransferTypes.MetadataOptions value)

public TransferTypes.TransferOptions.Builder setMetadataOptions(TransferTypes.MetadataOptions value)

Represents the selected metadata options for a transfer job.

.google.storagetransfer.v1.MetadataOptions metadata_options = 5;

Parameter
Name	Description
value	TransferTypes.MetadataOptions

Returns
Type	Description
TransferTypes.TransferOptions.Builder

setMetadataOptions(TransferTypes.MetadataOptions.Builder builderForValue)

public TransferTypes.TransferOptions.Builder setMetadataOptions(TransferTypes.MetadataOptions.Builder builderForValue)

Represents the selected metadata options for a transfer job.

.google.storagetransfer.v1.MetadataOptions metadata_options = 5;

Parameter
Name	Description
builderForValue	TransferTypes.MetadataOptions.Builder

Returns
Type	Description
TransferTypes.TransferOptions.Builder

setOverwriteObjectsAlreadyExistingInSink(boolean value)

public TransferTypes.TransferOptions.Builder setOverwriteObjectsAlreadyExistingInSink(boolean value)

When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source are overwritten with the source object.

bool overwrite_objects_already_existing_in_sink = 1;

Parameter
Name	Description
value	boolean The overwriteObjectsAlreadyExistingInSink to set.

Returns
Type	Description
TransferTypes.TransferOptions.Builder	This builder for chaining.

setOverwriteWhen(TransferTypes.TransferOptions.OverwriteWhen value)

public TransferTypes.TransferOptions.Builder setOverwriteWhen(TransferTypes.TransferOptions.OverwriteWhen value)

When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.

.google.storagetransfer.v1.TransferOptions.OverwriteWhen overwrite_when = 4;

Parameter
Name	Description
value	TransferTypes.TransferOptions.OverwriteWhen The overwriteWhen to set.

Returns
Type	Description
TransferTypes.TransferOptions.Builder	This builder for chaining.

setOverwriteWhenValue(int value)

public TransferTypes.TransferOptions.Builder setOverwriteWhenValue(int value)

When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.

.google.storagetransfer.v1.TransferOptions.OverwriteWhen overwrite_when = 4;

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

Returns
Type	Description
TransferTypes.TransferOptions.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
TransferTypes.TransferOptions.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

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

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
TransferTypes.TransferOptions.Builder

Overrides

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