Interface TransferTypes.TransferOptionsOrBuilder (1.45.0)

Version 1.45.0

• 1.53.0 (latest)
• 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 interface TransferTypes.TransferOptionsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDeleteObjectsFromSourceAfterTransfer()

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

getMetadataOptions()

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

getMetadataOptionsOrBuilder()

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