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.TransferOptionsImplements
TransferTypes.TransferOptionsOrBuilderStatic 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 |
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> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns | |
---|---|
Type | Description |
UnknownFieldSet |
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 |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
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 |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
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 |
Exceptions | |
---|---|
Type | Description |
IOException |