BlobBeginCopyFromUrlPollState interface

Package:: @azure/storage-blob

The state used by the poller returned from BlobClient.beginCopyFromURL.

This state is passed into the user-specified onProgress callback whenever copy progress is detected.

Extends: PollOperationState<BlobBeginCopyFromURLResponse>

Properties

blobClient	The instance of BlobClient that was used when calling BlobClient.beginCopyFromURL.
copyId	The copyId that identifies the in-progress blob copy.
copyProgress	the progress of the blob copy as reported by the service.
copySource	The source URL provided in BlobClient.beginCopyFromURL.
startCopyFromURLOptions	The options that were passed to the initial BlobClient.beginCopyFromURL call. This is exposed for the poller and should not be modified directly.

Inherited Properties

error	Will exist if the operation encountered any error.
isCancelled	True if the operation has been cancelled.
isCompleted	True if the operation has been completed.
isStarted	True if the operation has started.
result	Will exist if the operation concluded in a result of an expected type.

Property Details

blobClient

The instance of BlobClient that was used when calling BlobClient.beginCopyFromURL.

blobClient: CopyPollerBlobClient

Property Value

CopyPollerBlobClient

copyId

The copyId that identifies the in-progress blob copy.

copyId?: string

Property Value

string

copyProgress

the progress of the blob copy as reported by the service.

copyProgress?: string

Property Value

string

copySource

The source URL provided in BlobClient.beginCopyFromURL.

copySource: string

Property Value

string

startCopyFromURLOptions

The options that were passed to the initial BlobClient.beginCopyFromURL call. This is exposed for the poller and should not be modified directly.

startCopyFromURLOptions?: BlobStartCopyFromURLOptions

Property Value

BlobStartCopyFromURLOptions

Inherited Property Details

error

Will exist if the operation encountered any error.

error?: Error

Property Value

Error

Inherited From PollOperationState.error

isCancelled

True if the operation has been cancelled.

isCancelled?: boolean

Property Value

boolean

Inherited From PollOperationState.isCancelled

isCompleted

True if the operation has been completed.

isCompleted?: boolean

Property Value

boolean

Inherited From PollOperationState.isCompleted

isStarted

True if the operation has started.

isStarted?: boolean

Property Value

boolean

Inherited From PollOperationState.isStarted

result

Will exist if the operation concluded in a result of an expected type.

result?: BlobBeginCopyFromURLResponse

Property Value

BlobBeginCopyFromURLResponse

Inherited From PollOperationState.result