TransferOptions Class

Definition

Namespace:

Azure.Storage.DataMovement

Assembly:

Azure.Storage.DataMovement.dll

Package:

Azure.Storage.DataMovement v12.0.0

Source:

TransferOptions.cs

TransferOptions is used to provide options for a transfer.

public class TransferOptions : IEquatable<Azure.Storage.DataMovement.TransferOptions>

type TransferOptions = class
    interface IEquatable<TransferOptions>

Public Class TransferOptions
Implements IEquatable(Of TransferOptions)

Inheritance

Object

TransferOptions

Implements

IEquatable<TransferOptions>

Constructors

TransferOptions()

Properties

CreationMode	Configures the behavior when a transfer encounters a resource that already exists. Will default to Default which will be FailIfExists when starting a new transfer. When resuming a transfer, the value will default to the value used when first starting the transfer for all resources that were successfully enumerated and the regular default for any remaining resources.
InitialTransferSize	The size of the first range request in bytes. Single Transfer sizes smaller than this limit will be Uploaded or Downloaded in a single request. Transfers larger than this limit will continue being downloaded or uploaded in chunks of size MaximumTransferChunkSize. The default value is 32 MiB. When resuming a transfer, the default value will be the value specified when the transfer was first started but can still be overriden. This value may be clamped to the maximum allowed for the particular transfer/resource type.
MaximumTransferChunkSize	The maximum size to use for each chunk when transferring data in chunks. The default value is 4 MiB. When resuming a transfer, the default value will be the value specified when the transfer was first started but can still be overriden. This value may be clamped to the maximum allowed for the particular transfer/resource type.
ProgressHandlerOptions	Optional. Options for changing behavior of the ProgressHandler.

Events

ItemTransferCompleted	If a single transfer within the resource container gets transferred successfully the event will get added to this handler. Only applies to container transfers, not single resource transfers.
ItemTransferFailed	If the transfer has any failed events that occur the event will get added to this handler.
ItemTransferSkipped	If the transfer has any skipped events that occur the event will get added to this handler. Skipped transfer occur during Transfer due to no overwrite allowed as specified in CreationMode
TransferStatusChanged	If the transfer status of the job changes then the event will get added to this handler.