Class TransferTypes.TransferOptions (1.16.0)

Version 1.16.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 final class TransferTypes.TransferOptions extends GeneratedMessageV3 implements TransferTypes.TransferOptionsOrBuilder

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

Protobuf type google.storagetransfer.v1.TransferOptions

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferTypes.TransferOptions

Implements

TransferTypes.TransferOptionsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DELETE_OBJECTS_FROM_SOURCE_AFTER_TRANSFER_FIELD_NUMBER

public static final int DELETE_OBJECTS_FROM_SOURCE_AFTER_TRANSFER_FIELD_NUMBER

Field Value
Type	Description
int

DELETE_OBJECTS_UNIQUE_IN_SINK_FIELD_NUMBER

public static final int DELETE_OBJECTS_UNIQUE_IN_SINK_FIELD_NUMBER

Field Value
Type	Description
int

METADATA_OPTIONS_FIELD_NUMBER

public static final int METADATA_OPTIONS_FIELD_NUMBER

Field Value
Type	Description
int

OVERWRITE_OBJECTS_ALREADY_EXISTING_IN_SINK_FIELD_NUMBER

public static final int OVERWRITE_OBJECTS_ALREADY_EXISTING_IN_SINK_FIELD_NUMBER

Field Value
Type	Description
int

OVERWRITE_WHEN_FIELD_NUMBER

public static final int OVERWRITE_WHEN_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static TransferTypes.TransferOptions getDefaultInstance()

Returns
Type	Description
TransferTypes.TransferOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static TransferTypes.TransferOptions.Builder newBuilder()

Returns
Type	Description
TransferTypes.TransferOptions.Builder

newBuilder(TransferTypes.TransferOptions prototype)

public static TransferTypes.TransferOptions.Builder newBuilder(TransferTypes.TransferOptions prototype)

Parameter
Name	Description
prototype	TransferTypes.TransferOptions

Returns
Type	Description
TransferTypes.TransferOptions.Builder

parseDelimitedFrom(InputStream input)

public static TransferTypes.TransferOptions parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
TransferTypes.TransferOptions

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.TransferOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.TransferOptions

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static TransferTypes.TransferOptions parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
TransferTypes.TransferOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.TransferOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.TransferOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferTypes.TransferOptions parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
TransferTypes.TransferOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.TransferOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.TransferOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferTypes.TransferOptions parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
TransferTypes.TransferOptions

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.TransferOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.TransferOptions

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static TransferTypes.TransferOptions parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
TransferTypes.TransferOptions

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.TransferOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.TransferOptions

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static TransferTypes.TransferOptions parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
TransferTypes.TransferOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.TransferOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransferTypes.TransferOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<TransferTypes.TransferOptions> parser()

Returns
Type	Description
Parser<TransferOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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 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 are mutually exclusive.

bool delete_objects_unique_in_sink = 2;

Returns
Type	Description
boolean	The deleteObjectsUniqueInSink.

getMetadataOptions()

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

getParserForType()

public Parser<TransferTypes.TransferOptions> getParserForType()

Returns
Type	Description
Parser<TransferOptions>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hasMetadataOptions()

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

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public TransferTypes.TransferOptions.Builder newBuilderForType()

Returns
Type	Description
TransferTypes.TransferOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.TransferOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
TransferTypes.TransferOptions.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TransferTypes.TransferOptions.Builder toBuilder()

Returns
Type	Description
TransferTypes.TransferOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException