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. |
Inheritance
builtins.object > proto.message.Message > TransferOptionsClasses
OverwriteWhen
OverwriteWhen(value)
Specifies when to overwrite an object in the sink when an object with matching name is found in the source.