Class: Google::Cloud::StorageTransfer::V1::TransferOptions

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/storagetransfer/v1/transfer_types.rb

Overview

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

Defined Under Namespace

Modules: OverwriteWhen

Instance Attribute Summary collapse

Instance Attribute Details

#delete_objects_from_source_after_transfer ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

    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.



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 613

class TransferOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies when to overwrite an object in the sink when an object with
  # matching name is found in the source.
  module OverwriteWhen
    # Overwrite behavior is unspecified.
    OVERWRITE_WHEN_UNSPECIFIED = 0

    # Overwrites destination objects with the source objects, only if the
    # objects have the same name but different HTTP ETags or checksum values.
    DIFFERENT = 1

    # Never overwrites a destination object if a source object has the
    # same name. In this case, the source object is not transferred.
    NEVER = 2

    # Always overwrite the destination object with the source object, even if
    # the HTTP Etags or checksum values are the same.
    ALWAYS = 3
  end
end

#delete_objects_unique_in_sink ⇒ ::Boolean

Returns Whether objects that exist only in the sink should be deleted.

Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.

Returns:



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 613

class TransferOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies when to overwrite an object in the sink when an object with
  # matching name is found in the source.
  module OverwriteWhen
    # Overwrite behavior is unspecified.
    OVERWRITE_WHEN_UNSPECIFIED = 0

    # Overwrites destination objects with the source objects, only if the
    # objects have the same name but different HTTP ETags or checksum values.
    DIFFERENT = 1

    # Never overwrites a destination object if a source object has the
    # same name. In this case, the source object is not transferred.
    NEVER = 2

    # Always overwrite the destination object with the source object, even if
    # the HTTP Etags or checksum values are the same.
    ALWAYS = 3
  end
end

#metadata_options ⇒ ::Google::Cloud::StorageTransfer::V1::MetadataOptions

Returns Represents the selected metadata options for a transfer job.

Returns:



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 613

class TransferOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies when to overwrite an object in the sink when an object with
  # matching name is found in the source.
  module OverwriteWhen
    # Overwrite behavior is unspecified.
    OVERWRITE_WHEN_UNSPECIFIED = 0

    # Overwrites destination objects with the source objects, only if the
    # objects have the same name but different HTTP ETags or checksum values.
    DIFFERENT = 1

    # Never overwrites a destination object if a source object has the
    # same name. In this case, the source object is not transferred.
    NEVER = 2

    # Always overwrite the destination object with the source object, even if
    # the HTTP Etags or checksum values are the same.
    ALWAYS = 3
  end
end

#overwrite_objects_already_existing_in_sink ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

    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.



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 613

class TransferOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies when to overwrite an object in the sink when an object with
  # matching name is found in the source.
  module OverwriteWhen
    # Overwrite behavior is unspecified.
    OVERWRITE_WHEN_UNSPECIFIED = 0

    # Overwrites destination objects with the source objects, only if the
    # objects have the same name but different HTTP ETags or checksum values.
    DIFFERENT = 1

    # Never overwrites a destination object if a source object has the
    # same name. In this case, the source object is not transferred.
    NEVER = 2

    # Always overwrite the destination object with the source object, even if
    # the HTTP Etags or checksum values are the same.
    ALWAYS = 3
  end
end

#overwrite_when ⇒ ::Google::Cloud::StorageTransfer::V1::TransferOptions::OverwriteWhen

Returns When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.

Returns:



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 613

class TransferOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies when to overwrite an object in the sink when an object with
  # matching name is found in the source.
  module OverwriteWhen
    # Overwrite behavior is unspecified.
    OVERWRITE_WHEN_UNSPECIFIED = 0

    # Overwrites destination objects with the source objects, only if the
    # objects have the same name but different HTTP ETags or checksum values.
    DIFFERENT = 1

    # Never overwrites a destination object if a source object has the
    # same name. In this case, the source object is not transferred.
    NEVER = 2

    # Always overwrite the destination object with the source object, even if
    # the HTTP Etags or checksum values are the same.
    ALWAYS = 3
  end
end