com.google.storagetransfer.v1.proto

Interface TransferTypes.TransferOptionsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TransferTypes.TransferOptions, TransferTypes.TransferOptions.Builder

Enclosing class:

TransferTypes

public static interface TransferTypes.TransferOptionsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getDeleteObjectsFromSourceAfterTransfer() Whether objects should be deleted from the source after they are transferred to the sink.
boolean	getDeleteObjectsUniqueInSink() Whether objects that exist only in the sink should be deleted.
TransferTypes.MetadataOptions	getMetadataOptions() Represents the selected metadata options for a transfer job.
TransferTypes.MetadataOptionsOrBuilder	getMetadataOptionsOrBuilder() Represents the selected metadata options for a transfer job.
boolean	getOverwriteObjectsAlreadyExistingInSink() When to overwrite objects that already exist in the sink.
TransferTypes.TransferOptions.OverwriteWhen	getOverwriteWhen() When to overwrite objects that already exist in the sink.
int	getOverwriteWhenValue() When to overwrite objects that already exist in the sink.
boolean	hasMetadataOptions() Represents the selected metadata options for a transfer job.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getOverwriteObjectsAlreadyExistingInSink

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:

The overwriteObjectsAlreadyExistingInSink.

getDeleteObjectsUniqueInSink

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:

The deleteObjectsUniqueInSink.

getDeleteObjectsFromSourceAfterTransfer

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:

The deleteObjectsFromSourceAfterTransfer.

getOverwriteWhenValue

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.overwrite_objects_already_existing_in_sink].
 

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

Returns:

The enum numeric value on the wire for overwriteWhen.

getOverwriteWhen

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.overwrite_objects_already_existing_in_sink].
 

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

Returns:

The overwriteWhen.

hasMetadataOptions

boolean hasMetadataOptions()

 Represents the selected metadata options for a transfer job.
 

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

Returns:

Whether the metadataOptions field is set.

getMetadataOptions

TransferTypes.MetadataOptions getMetadataOptions()

 Represents the selected metadata options for a transfer job.
 

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

Returns:

The metadataOptions.

getMetadataOptionsOrBuilder

TransferTypes.MetadataOptionsOrBuilder getMetadataOptionsOrBuilder()

 Represents the selected metadata options for a transfer job.
 

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