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

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

Overview

TransferOptions uses three boolean parameters to define the actions to be performed on objects in a transfer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ TransferOptions

Returns a new instance of TransferOptions



251
252
253
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 251

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

Returns:

  • (Boolean) 


248
249
250
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 248

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

Returns:

  • (Boolean) 


235
236
237
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 235

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?

Whether overwriting objects that already exist in the sink is allowed. Corresponds to the JSON property overwriteObjectsAlreadyExistingInSink

Returns:

  • (Boolean) 


241
242
243
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 241

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



256
257
258
259
260
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 256

def update!(**args)
  @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)
  @delete_objects_from_source_after_transfer = args[:delete_objects_from_source_after_transfer] if args.key?(:delete_objects_from_source_after_transfer)
end