TransferContext Class |
Represents the context for a transfer, and provides additional runtime information about its execution.
Inheritance HierarchySystemObject
Microsoft.Azure.Storage.DataMovementTransferContext
Microsoft.Azure.Storage.DataMovementDirectoryTransferContext
Microsoft.Azure.Storage.DataMovementSingleTransferContext
Microsoft.Azure.Storage.DataMovementTransferContext
Microsoft.Azure.Storage.DataMovementDirectoryTransferContext
Microsoft.Azure.Storage.DataMovementSingleTransferContext
Namespace: Microsoft.Azure.Storage.DataMovement
Assembly: Microsoft.Azure.Storage.DataMovement (in Microsoft.Azure.Storage.DataMovement.dll) Version: 2.0.1.0 (2.0.1.0)
SyntaxThe TransferContext type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | 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| Name | Description | |
|---|---|---|
 | 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| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
 | ForceOverwrite |
Callback used to force overwrite the destination without existence check.
It can be used when destination credentials only contains write permission.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | 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.
|
See Also