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



992
993
994
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 992

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 that this option and deleteObjectsUniqueInSink are mutually exclusive. Corresponds to the JSON property deleteObjectsFromSourceAfterTransfer

Returns:

  • (Boolean) 


975
976
977
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 975

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 that this option and deleteObjectsFromSourceAfterTransfer are mutually exclusive. Corresponds to the JSON property deleteObjectsUniqueInSink

Returns:

  • (Boolean) 


983
984
985
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 983

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) 


989
990
991
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 989

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



997
998
999
1000
1001
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 997

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