Package com.google.storagetransfer.v1.proto

Class TransferTypes.TransferOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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.GeneratedMessage implements TransferTypes.TransferOptionsOrBuilder
 TransferOptions define the actions to be performed on objects in a transfer.
Protobuf type google.storagetransfer.v1.TransferOptions
See Also:

  • Field Details

    • OVERWRITE_OBJECTS_ALREADY_EXISTING_IN_SINK_FIELD_NUMBER

      public static final int OVERWRITE_OBJECTS_ALREADY_EXISTING_IN_SINK_FIELD_NUMBER
      See Also:

    • DELETE_OBJECTS_UNIQUE_IN_SINK_FIELD_NUMBER

      public static final int DELETE_OBJECTS_UNIQUE_IN_SINK_FIELD_NUMBER
      See Also:

    • DELETE_OBJECTS_FROM_SOURCE_AFTER_TRANSFER_FIELD_NUMBER

      public static final int DELETE_OBJECTS_FROM_SOURCE_AFTER_TRANSFER_FIELD_NUMBER
      See Also:

    • OVERWRITE_WHEN_FIELD_NUMBER

      public static final int OVERWRITE_WHEN_FIELD_NUMBER
      See Also:

    • METADATA_OPTIONS_FIELD_NUMBER

      public static final int METADATA_OPTIONS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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 overwritten. 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public TransferTypes.TransferOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder