com.google.api.services.storagetransfer.v1.model

Class TransferOptions

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.storagetransfer.v1.model.TransferOptions

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class TransferOptions
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Storage Transfer API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
TransferOptions()

Method Summary

Modifier and Type	Method and Description
TransferOptions	clone()
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.
MetadataOptions	getMetadataOptions() Represents the selected metadata options for a transfer job.
Boolean	getOverwriteObjectsAlreadyExistingInSink() When to overwrite objects that already exist in the sink.
String	getOverwriteWhen() When to overwrite objects that already exist in the sink.
TransferOptions	set(String fieldName, Object value)
TransferOptions	setDeleteObjectsFromSourceAfterTransfer(Boolean deleteObjectsFromSourceAfterTransfer) Whether objects should be deleted from the source after they are transferred to the sink.
TransferOptions	setDeleteObjectsUniqueInSink(Boolean deleteObjectsUniqueInSink) Whether objects that exist only in the sink should be deleted.
TransferOptions	setMetadataOptions(MetadataOptions metadataOptions) Represents the selected metadata options for a transfer job.
TransferOptions	setOverwriteObjectsAlreadyExistingInSink(Boolean overwriteObjectsAlreadyExistingInSink) When to overwrite objects that already exist in the sink.
TransferOptions	setOverwriteWhen(String overwriteWhen) When to overwrite objects that already exist in the sink.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

TransferOptions

public TransferOptions()

Method Detail

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.

Returns:

value or null for none

setDeleteObjectsFromSourceAfterTransfer

public TransferOptions setDeleteObjectsFromSourceAfterTransfer(Boolean deleteObjectsFromSourceAfterTransfer)

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.

Parameters:

deleteObjectsFromSourceAfterTransfer - deleteObjectsFromSourceAfterTransfer or null for none

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.

Returns:

value or null for none

setDeleteObjectsUniqueInSink

public TransferOptions setDeleteObjectsUniqueInSink(Boolean deleteObjectsUniqueInSink)

Whether objects that exist only in the sink should be deleted. **Note:** This option and delete_objects_from_source_after_transfer are mutually exclusive.

Parameters:

deleteObjectsUniqueInSink - deleteObjectsUniqueInSink or null for none

getMetadataOptions

public MetadataOptions getMetadataOptions()

Represents the selected metadata options for a transfer job.

Returns:

value or null for none

setMetadataOptions

public TransferOptions setMetadataOptions(MetadataOptions metadataOptions)

Represents the selected metadata options for a transfer job.

Parameters:

metadataOptions - metadataOptions or null for none

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.

Returns:

value or null for none

setOverwriteObjectsAlreadyExistingInSink

public TransferOptions setOverwriteObjectsAlreadyExistingInSink(Boolean overwriteObjectsAlreadyExistingInSink)

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.

Parameters:

overwriteObjectsAlreadyExistingInSink - overwriteObjectsAlreadyExistingInSink or null for none

getOverwriteWhen

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

Returns:

value or null for none

setOverwriteWhen

public TransferOptions setOverwriteWhen(String overwriteWhen)

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

Parameters:

overwriteWhen - overwriteWhen or null for none

set

public TransferOptions set(String fieldName,
                           Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public TransferOptions clone()

Overrides:

clone in class com.google.api.client.json.GenericJson