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.BuilderImplements
TransferTypes.TransferOptionsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TransferTypes.TransferOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
TransferTypes.TransferOptions.Builder |
build()
public TransferTypes.TransferOptions build()
Type | Description |
TransferTypes.TransferOptions |
buildPartial()
public TransferTypes.TransferOptions buildPartial()
Type | Description |
TransferTypes.TransferOptions |
clear()
public TransferTypes.TransferOptions.Builder clear()
Type | Description |
TransferTypes.TransferOptions.Builder |
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;
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;
Type | Description |
TransferTypes.TransferOptions.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public TransferTypes.TransferOptions.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
TransferTypes.TransferOptions.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public TransferTypes.TransferOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
TransferTypes.TransferOptions.Builder |
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;
Type | Description |
TransferTypes.TransferOptions.Builder | This builder for chaining. |
clone()
public TransferTypes.TransferOptions.Builder clone()
Type | Description |
TransferTypes.TransferOptions.Builder |
getDefaultInstanceForType()
public TransferTypes.TransferOptions getDefaultInstanceForType()
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;
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;
Type | Description |
boolean | The deleteObjectsUniqueInSink. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
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;
Type | Description |
boolean | The overwriteObjectsAlreadyExistingInSink. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TransferTypes.TransferOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
TransferTypes.TransferOptions.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public TransferTypes.TransferOptions.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
TransferTypes.TransferOptions.Builder |
mergeFrom(TransferTypes.TransferOptions other)
public TransferTypes.TransferOptions.Builder mergeFrom(TransferTypes.TransferOptions other)
Name | Description |
other | TransferTypes.TransferOptions |
Type | Description |
TransferTypes.TransferOptions.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TransferTypes.TransferOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
TransferTypes.TransferOptions.Builder |
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;
Name | Description |
value | boolean The deleteObjectsFromSourceAfterTransfer to set. |
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;
Name | Description |
value | boolean The deleteObjectsUniqueInSink to set. |
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)
Name | Description |
field | FieldDescriptor |
value | Object |
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 will be overwritten with the source object.
bool overwrite_objects_already_existing_in_sink = 1;
Name | Description |
value | boolean The overwriteObjectsAlreadyExistingInSink to set. |
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)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
TransferTypes.TransferOptions.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final TransferTypes.TransferOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
TransferTypes.TransferOptions.Builder |