TransferContext Class

Definition

Namespace:

Microsoft.Azure.Storage.DataMovement

Assembly:

Microsoft.Azure.Storage.DataMovement.dll

Package:

Microsoft.Azure.Storage.DataMovement v2.0.4

Represents the context for a transfer, and provides additional runtime information about its execution.

public abstract class TransferContext

type TransferContext = class

Public MustInherit Class TransferContext

Inheritance

Object

TransferContext

Derived

Microsoft.Azure.Storage.DataMovement.DirectoryTransferContext

Microsoft.Azure.Storage.DataMovement.SingleTransferContext

Constructors

TransferContext()	Initializes a new instance of the TransferContext class.
TransferContext(Stream)	Initializes a new instance of the TransferContext class.
TransferContext(TransferCheckpoint)	Initializes a new instance of the TransferContext class.

Properties

ClientRequestId	Gets or sets the client request id.
LastCheckpoint	Gets the last checkpoint of the transfer.
LogLevel	Gets or sets the logging level to be used for the related transfer operation.
ProgressHandler	Gets or sets the progress update handler.
SetAttributesCallbackAsync	Gets or sets the callback invoked to set destination's attributes in memory. The attributes set in this callback will be sent to azure storage service.
ShouldOverwriteCallbackAsync	Gets or sets the callback invoked to tell whether to overwrite an existing destination.

Methods

ForceOverwrite(Object, Object)

Callback used to force overwrite the destination without existence check. It can be used when destination credentials only contains write permission.

Events

FileFailed	The event triggered when a file transfer is failed.
FileSkipped	The event triggered when a file transfer is skipped.
FileTransferred	The event triggered when a file transfer is completed successfully.