Class TransferTypes.TransferOptions (1.37.0)
Version 1.37.0keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static TransferTypes . TransferOptions . Builder newBuilder ()
newBuilder(TransferTypes.TransferOptions prototype)
public static TransferTypes . TransferOptions . Builder newBuilder ( TransferTypes . TransferOptions prototype )
public static TransferTypes . TransferOptions parseDelimitedFrom ( InputStream input )
public static TransferTypes . TransferOptions parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static TransferTypes . TransferOptions parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes . TransferOptions parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static TransferTypes . TransferOptions parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes . TransferOptions parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static TransferTypes . TransferOptions parseFrom ( CodedInputStream input )
public static TransferTypes . TransferOptions parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static TransferTypes . TransferOptions parseFrom ( InputStream input )
public static TransferTypes . TransferOptions parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static TransferTypes . TransferOptions parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes . TransferOptions parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<TransferTypes . TransferOptions > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public TransferTypes . TransferOptions getDefaultInstanceForType ()
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.
public TransferTypes . MetadataOptions getMetadataOptions ()
Represents the selected metadata options for a transfer job.
.google.storagetransfer.v1.MetadataOptions metadata_options = 5;
public TransferTypes . MetadataOptionsOrBuilder getMetadataOptionsOrBuilder ()
Represents the selected metadata options for a transfer job.
.google.storagetransfer.v1.MetadataOptions metadata_options = 5;
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;
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 ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public TransferTypes . TransferOptions . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransferTypes . TransferOptions . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public TransferTypes . TransferOptions . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
