Class: Google::Apis::StoragetransferV1::TransferOptions

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/storagetransfer_v1/classes.rb,
lib/google/apis/storagetransfer_v1/representations.rb,
lib/google/apis/storagetransfer_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TransferOptions

Returns a new instance of TransferOptions.



1149
1150
1151
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1149

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#delete_objects_from_source_after_transfer ⇒ Boolean Also known as: delete_objects_from_source_after_transfer?

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. Corresponds to the JSON property deleteObjectsFromSourceAfterTransfer

Returns:

  • (Boolean) 


1130
1131
1132
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1130

def delete_objects_from_source_after_transfer
  @delete_objects_from_source_after_transfer
end

#delete_objects_unique_in_sink ⇒ Boolean Also known as: delete_objects_unique_in_sink?

Whether objects that exist only in the sink should be deleted. Note: This option and delete_objects_from_source_after_transfer are mutually exclusive. Corresponds to the JSON property deleteObjectsUniqueInSink

Returns:

  • (Boolean) 


1137
1138
1139
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1137

def delete_objects_unique_in_sink
  @delete_objects_unique_in_sink
end

#overwrite_objects_already_existing_in_sink ⇒ Boolean Also known as: overwrite_objects_already_existing_in_sink?

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 will be overwritten with the source object. Corresponds to the JSON property overwriteObjectsAlreadyExistingInSink

Returns:

  • (Boolean) 


1146
1147
1148
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1146

def overwrite_objects_already_existing_in_sink
  @overwrite_objects_already_existing_in_sink
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1154
1155
1156
1157
1158
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1154

def update!(**args)
  @delete_objects_from_source_after_transfer = args[:delete_objects_from_source_after_transfer] if args.key?(:delete_objects_from_source_after_transfer)
  @delete_objects_unique_in_sink = args[:delete_objects_unique_in_sink] if args.key?(:delete_objects_unique_in_sink)
  @overwrite_objects_already_existing_in_sink = args[:overwrite_objects_already_existing_in_sink] if args.key?(:overwrite_objects_already_existing_in_sink)
end