public sealed class TransferOptions : IMessage<TransferOptions>, IEquatable<TransferOptions>, IDeepCloneable<TransferOptions>, IBufferMessage, IMessageReference documentation and code samples for the Storage Transfer v1 API class TransferOptions.
TransferOptions define the actions to be performed on objects in a transfer.
Implements
IMessageTransferOptions, IEquatableTransferOptions, IDeepCloneableTransferOptions, IBufferMessage, IMessageNamespace
Google.Cloud.StorageTransfer.V1Assembly
Google.Cloud.StorageTransfer.V1.dll
Constructors
TransferOptions()
public TransferOptions()TransferOptions(TransferOptions)
public TransferOptions(TransferOptions other)| Parameter | |
|---|---|
| Name | Description |
other |
TransferOptions |
Properties
DeleteObjectsFromSourceAfterTransfer
public bool DeleteObjectsFromSourceAfterTransfer { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
DeleteObjectsUniqueInSink
public bool DeleteObjectsUniqueInSink { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
MetadataOptions
public MetadataOptions MetadataOptions { get; set; }Represents the selected metadata options for a transfer job.
| Property Value | |
|---|---|
| Type | Description |
MetadataOptions |
|
OverwriteObjectsAlreadyExistingInSink
public bool OverwriteObjectsAlreadyExistingInSink { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
OverwriteWhen
public TransferOptions.Types.OverwriteWhen OverwriteWhen { get; set; }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].
| Property Value | |
|---|---|
| Type | Description |
TransferOptionsTypesOverwriteWhen |
|