Class: Google::Apis::StoragetransferV1::TransferOptions
- Inherits:
-
Object
- Object
- Google::Apis::StoragetransferV1::TransferOptions
- 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
-
#delete_objects_from_source_after_transfer ⇒ Boolean
(also: #delete_objects_from_source_after_transfer?)
Whether objects should be deleted from the source after they are transferred to the sink.
-
#delete_objects_unique_in_sink ⇒ Boolean
(also: #delete_objects_unique_in_sink?)
Whether objects that exist only in the sink should be deleted.
-
#overwrite_objects_already_existing_in_sink ⇒ Boolean
(also: #overwrite_objects_already_existing_in_sink?)
Whether overwriting objects that already exist in the sink is allowed.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TransferOptions
constructor
A new instance of TransferOptions.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ TransferOptions
Returns a new instance of TransferOptions
933 934 935 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 933 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
916 917 918 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 916 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
924 925 926 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 924 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
930 931 932 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 930 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
938 939 940 941 942 |
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 938 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 |