Class TransferOptions (1.3.1)

Version 1.3.1

• 1.11.3 (latest)
• 1.11.2
• 1.10.0
• 1.9.2
• 1.8.1
• 1.7.1
• 1.6.0
• 1.5.2
• 1.4.1
• 1.3.1
• 1.2.1
• 1.1.1
• 1.0.2
• 0.1.0

TransferOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes
Name	Description
overwrite_objects_already_existing_in_sink	bool 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.
delete_objects_unique_in_sink	bool Whether objects that exist only in the sink should be deleted. **Note:** This option and delete_objects_from_source_after_transfer][google.storagetransfer.v1.TransferOptions.delete_objects_from_source_after_transfer] are mutually exclusive.
delete_objects_from_source_after_transfer	bool Whether objects should be deleted from the source after they are transferred to the sink. **Note:** This option and delete_objects_unique_in_sink][google.storagetransfer.v1.TransferOptions.delete_objects_unique_in_sink] are mutually exclusive.
overwrite_when	google.cloud.storage_transfer_v1.types.TransferOptions.OverwriteWhen When to overwrite objects that already exist in the sink. If not set overwrite behavior is determined by overwrite_objects_already_existing_in_sink][google.storagetransfer.v1.TransferOptions.overwrite_objects_already_existing_in_sink].
metadata_options	google.cloud.storage_transfer_v1.types.MetadataOptions Represents the selected metadata options for a transfer job. This feature is in Preview.

Classes

OverwriteWhen

OverwriteWhen(value)

Specifies when to overwrite an object in the sink when an object with matching name is found in the source.