Package com.google.storagetransfer.v1.proto

Class TransferTypes.TransferOptions.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<TransferTypes.TransferOptions.Builder>
com.google.storagetransfer.v1.proto.TransferTypes.TransferOptions.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransferTypes.TransferOptionsOrBuilder, Cloneable
Enclosing class:
TransferTypes.TransferOptions
public static final class TransferTypes.TransferOptions.Builder extends com.google.protobuf.GeneratedMessage.Builder<TransferTypes.TransferOptions.Builder> implements TransferTypes.TransferOptionsOrBuilder
 TransferOptions define the actions to be performed on objects in a transfer.
Protobuf type google.storagetransfer.v1.TransferOptions

  • 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.Builder<TransferTypes.TransferOptions.Builder>

    • clear

      public TransferTypes.TransferOptions.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<TransferTypes.TransferOptions.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<TransferTypes.TransferOptions.Builder>

    • getDefaultInstanceForType

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

    • build

      public TransferTypes.TransferOptions build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public TransferTypes.TransferOptions buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public TransferTypes.TransferOptions.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferTypes.TransferOptions.Builder>

    • mergeFrom

      public TransferTypes.TransferOptions.Builder mergeFrom(TransferTypes.TransferOptions other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<TransferTypes.TransferOptions.Builder>

    • mergeFrom

      public TransferTypes.TransferOptions.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferTypes.TransferOptions.Builder>
      Throws:
      IOException

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

    • setOverwriteObjectsAlreadyExistingInSink

      public TransferTypes.TransferOptions.Builder setOverwriteObjectsAlreadyExistingInSink(boolean value)
       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;
      Parameters:
      value - The overwriteObjectsAlreadyExistingInSink to set.
      Returns:
      This builder for chaining.

    • clearOverwriteObjectsAlreadyExistingInSink

      public TransferTypes.TransferOptions.Builder clearOverwriteObjectsAlreadyExistingInSink()
       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;
      Returns:
      This builder for chaining.

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

    • setDeleteObjectsUniqueInSink

      public TransferTypes.TransferOptions.Builder setDeleteObjectsUniqueInSink(boolean value)
       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;
      Parameters:
      value - The deleteObjectsUniqueInSink to set.
      Returns:
      This builder for chaining.

    • clearDeleteObjectsUniqueInSink

      public TransferTypes.TransferOptions.Builder clearDeleteObjectsUniqueInSink()
       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;
      Returns:
      This builder for chaining.

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

    • setDeleteObjectsFromSourceAfterTransfer

      public TransferTypes.TransferOptions.Builder setDeleteObjectsFromSourceAfterTransfer(boolean value)
       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;
      Parameters:
      value - The deleteObjectsFromSourceAfterTransfer to set.
      Returns:
      This builder for chaining.

    • clearDeleteObjectsFromSourceAfterTransfer

      public TransferTypes.TransferOptions.Builder clearDeleteObjectsFromSourceAfterTransfer()
       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;
      Returns:
      This builder for chaining.

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

    • setOverwriteWhenValue

      public TransferTypes.TransferOptions.Builder setOverwriteWhenValue(int value)
       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;
      Parameters:
      value - The enum numeric value on the wire for overwriteWhen to set.
      Returns:
      This builder for chaining.

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

    • setOverwriteWhen

      public TransferTypes.TransferOptions.Builder setOverwriteWhen(TransferTypes.TransferOptions.OverwriteWhen value)
       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;
      Parameters:
      value - The overwriteWhen to set.
      Returns:
      This builder for chaining.

    • clearOverwriteWhen

      public TransferTypes.TransferOptions.Builder clearOverwriteWhen()
       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;
      Returns:
      This builder for chaining.

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

    • setMetadataOptions

      public TransferTypes.TransferOptions.Builder setMetadataOptions(TransferTypes.MetadataOptions value)
       Represents the selected metadata options for a transfer job.
      .google.storagetransfer.v1.MetadataOptions metadata_options = 5;

    • setMetadataOptions

      public TransferTypes.TransferOptions.Builder setMetadataOptions(TransferTypes.MetadataOptions.Builder builderForValue)
       Represents the selected metadata options for a transfer job.
      .google.storagetransfer.v1.MetadataOptions metadata_options = 5;

    • mergeMetadataOptions

      public TransferTypes.TransferOptions.Builder mergeMetadataOptions(TransferTypes.MetadataOptions value)
       Represents the selected metadata options for a transfer job.
      .google.storagetransfer.v1.MetadataOptions metadata_options = 5;

    • clearMetadataOptions

      public TransferTypes.TransferOptions.Builder clearMetadataOptions()
       Represents the selected metadata options for a transfer job.
      .google.storagetransfer.v1.MetadataOptions metadata_options = 5;

    • getMetadataOptionsBuilder

      public TransferTypes.MetadataOptions.Builder getMetadataOptionsBuilder()
       Represents the selected metadata options for a transfer job.
      .google.storagetransfer.v1.MetadataOptions metadata_options = 5;

    • 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