Storage Transfer Service V1 API - Class Google::Cloud::StorageTransfer::V1::TransferOptions (v1.1.1)

Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::TransferOptions.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#delete_objects_from_source_after_transfer

def delete_objects_from_source_after_transfer() -> ::Boolean
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.

#delete_objects_from_source_after_transfer=

def delete_objects_from_source_after_transfer=(value) -> ::Boolean
Parameter
  • value (::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.

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.

#delete_objects_unique_in_sink

def delete_objects_unique_in_sink() -> ::Boolean
Returns

#delete_objects_unique_in_sink=

def delete_objects_unique_in_sink=(value) -> ::Boolean
Parameter
Returns

#metadata_options

def metadata_options() -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions
Returns

#metadata_options=

def metadata_options=(value) -> ::Google::Cloud::StorageTransfer::V1::MetadataOptions
Parameter
Returns

#overwrite_objects_already_existing_in_sink

def overwrite_objects_already_existing_in_sink() -> ::Boolean
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.

#overwrite_objects_already_existing_in_sink=

def overwrite_objects_already_existing_in_sink=(value) -> ::Boolean
Parameter
  • value (::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.
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.

#overwrite_when

def overwrite_when() -> ::Google::Cloud::StorageTransfer::V1::TransferOptions::OverwriteWhen
Returns

#overwrite_when=

def overwrite_when=(value) -> ::Google::Cloud::StorageTransfer::V1::TransferOptions::OverwriteWhen
Parameter
Returns