Class TransferTypes.TransferOptions.Builder (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

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

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

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] [google.storagetransfer.v1.TransferOptions.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] [google.storagetransfer.v1.TransferOptions.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

clearOneof(Descriptors.OneofDescriptor oneof)

public TransferTypes.TransferOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TransferTypes.TransferOptions.Builder
Overrides

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 will be overwritten with the source object.

bool overwrite_objects_already_existing_in_sink = 1;

Returns
Type Description
TransferTypes.TransferOptions.Builder

This builder for chaining.

clone()

public TransferTypes.TransferOptions.Builder clone()
Returns
Type Description
TransferTypes.TransferOptions.Builder
Overrides

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] [google.storagetransfer.v1.TransferOptions.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] [google.storagetransfer.v1.TransferOptions.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

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 will be overwritten with the source object.

bool overwrite_objects_already_existing_in_sink = 1;

Returns
Type Description
boolean

The overwriteObjectsAlreadyExistingInSink.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

mergeFrom(TransferTypes.TransferOptions other)

public TransferTypes.TransferOptions.Builder mergeFrom(TransferTypes.TransferOptions other)
Parameter
Name Description
other TransferTypes.TransferOptions
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

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] [google.storagetransfer.v1.TransferOptions.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] [google.storagetransfer.v1.TransferOptions.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

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 will be 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.

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

setUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.TransferOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.TransferOptions.Builder
Overrides