com.google.storagetransfer.v1.proto

Class TransferTypes.TransferOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.storagetransfer.v1.proto.TransferTypes.TransferOptions

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransferTypes.TransferOptionsOrBuilder, Serializable

Enclosing class:

TransferTypes

public static final class TransferTypes.TransferOptions
extends com.google.protobuf.GeneratedMessageV3
implements TransferTypes.TransferOptionsOrBuilder

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

Protobuf type google.storagetransfer.v1.TransferOptions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransferTypes.TransferOptions.Builder TransferOptions define the actions to be performed on objects in a transfer.
static class	TransferTypes.TransferOptions.OverwriteWhen Specifies when to overwrite an object in the sink when an object with matching name is found in the source.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DELETE_OBJECTS_FROM_SOURCE_AFTER_TRANSFER_FIELD_NUMBER
static int	DELETE_OBJECTS_UNIQUE_IN_SINK_FIELD_NUMBER
static int	METADATA_OPTIONS_FIELD_NUMBER
static int	OVERWRITE_OBJECTS_ALREADY_EXISTING_IN_SINK_FIELD_NUMBER
static int	OVERWRITE_WHEN_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static TransferTypes.TransferOptions	getDefaultInstance()
TransferTypes.TransferOptions	getDefaultInstanceForType()
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.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<TransferTypes.TransferOptions>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasMetadataOptions() Represents the selected metadata options for a transfer job.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static TransferTypes.TransferOptions.Builder	newBuilder()
static TransferTypes.TransferOptions.Builder	newBuilder(TransferTypes.TransferOptions prototype)
TransferTypes.TransferOptions.Builder	newBuilderForType()
protected TransferTypes.TransferOptions.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static TransferTypes.TransferOptions	parseDelimitedFrom(InputStream input)
static TransferTypes.TransferOptions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransferTypes.TransferOptions	parseFrom(byte[] data)
static TransferTypes.TransferOptions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransferTypes.TransferOptions	parseFrom(ByteBuffer data)
static TransferTypes.TransferOptions	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransferTypes.TransferOptions	parseFrom(com.google.protobuf.ByteString data)
static TransferTypes.TransferOptions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransferTypes.TransferOptions	parseFrom(com.google.protobuf.CodedInputStream input)
static TransferTypes.TransferOptions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransferTypes.TransferOptions	parseFrom(InputStream input)
static TransferTypes.TransferOptions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<TransferTypes.TransferOptions>	parser()
TransferTypes.TransferOptions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

OVERWRITE_OBJECTS_ALREADY_EXISTING_IN_SINK_FIELD_NUMBER

public static final int OVERWRITE_OBJECTS_ALREADY_EXISTING_IN_SINK_FIELD_NUMBER

See Also:

Constant Field Values

DELETE_OBJECTS_UNIQUE_IN_SINK_FIELD_NUMBER

public static final int DELETE_OBJECTS_UNIQUE_IN_SINK_FIELD_NUMBER

See Also:

Constant Field Values

DELETE_OBJECTS_FROM_SOURCE_AFTER_TRANSFER_FIELD_NUMBER

public static final int DELETE_OBJECTS_FROM_SOURCE_AFTER_TRANSFER_FIELD_NUMBER

See Also:

Constant Field Values

OVERWRITE_WHEN_FIELD_NUMBER

public static final int OVERWRITE_WHEN_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_OPTIONS_FIELD_NUMBER

public static final int METADATA_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

Specified by:

getOverwriteObjectsAlreadyExistingInSink in interface TransferTypes.TransferOptionsOrBuilder

Returns:

The overwriteObjectsAlreadyExistingInSink.

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;

Specified by:

getDeleteObjectsUniqueInSink in interface TransferTypes.TransferOptionsOrBuilder

Returns:

The deleteObjectsUniqueInSink.

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;

Specified by:

getDeleteObjectsFromSourceAfterTransfer in interface TransferTypes.TransferOptionsOrBuilder

Returns:

The deleteObjectsFromSourceAfterTransfer.

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

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

Specified by:

getOverwriteWhenValue in interface TransferTypes.TransferOptionsOrBuilder

Returns:

The enum numeric value on the wire for overwriteWhen.

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

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

Specified by:

getOverwriteWhen in interface TransferTypes.TransferOptionsOrBuilder

Returns:

The overwriteWhen.

hasMetadataOptions

public boolean hasMetadataOptions()

 Represents the selected metadata options for a transfer job.
 

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

Specified by:

hasMetadataOptions in interface TransferTypes.TransferOptionsOrBuilder

Returns:

Whether the metadataOptions field is set.

getMetadataOptions

public TransferTypes.MetadataOptions getMetadataOptions()

 Represents the selected metadata options for a transfer job.
 

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

Specified by:

getMetadataOptions in interface TransferTypes.TransferOptionsOrBuilder

Returns:

The metadataOptions.

getMetadataOptionsOrBuilder

public TransferTypes.MetadataOptionsOrBuilder getMetadataOptionsOrBuilder()

 Represents the selected metadata options for a transfer job.
 

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

Specified by:

getMetadataOptionsOrBuilder in interface TransferTypes.TransferOptionsOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static TransferTypes.TransferOptions parseFrom(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransferTypes.TransferOptions parseFrom(ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransferTypes.TransferOptions parseFrom(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransferTypes.TransferOptions parseFrom(com.google.protobuf.ByteString data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransferTypes.TransferOptions parseFrom(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransferTypes.TransferOptions parseFrom(byte[] data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransferTypes.TransferOptions parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static TransferTypes.TransferOptions parseFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static TransferTypes.TransferOptions parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static TransferTypes.TransferOptions parseDelimitedFrom(InputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseFrom

public static TransferTypes.TransferOptions parseFrom(com.google.protobuf.CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static TransferTypes.TransferOptions parseFrom(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

newBuilderForType

public TransferTypes.TransferOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static TransferTypes.TransferOptions.Builder newBuilder()

newBuilder

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

toBuilder

public TransferTypes.TransferOptions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected TransferTypes.TransferOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static TransferTypes.TransferOptions getDefaultInstance()

parser

public static com.google.protobuf.Parser<TransferTypes.TransferOptions> parser()

getParserForType

public com.google.protobuf.Parser<TransferTypes.TransferOptions> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public TransferTypes.TransferOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder