Share via

AnalysisPollOperationState interface

Package:
@azure/ai-text-analytics

An interface representing the state of an analysis poller operation.

Extends

@azure/core-lro.PollOperationState<TResult>,OperationMetadata

Inherited Properties

createdOn

The date and time the operation was created.
error

Will exist if the operation encountered any error.
expiresOn

The date and time when the operation results will expire on the server.
isCancelled

True if the operation has been cancelled.
isCompleted

True if the operation has been completed.
isStarted

True if the operation has started.
lastModifiedOn

The time the operation status was last updated.
operationId

The operation id.
result

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

The current status of the operation.

Inherited Property Details

createdOn

The date and time the operation was created.

createdOn: Date

Property Value

Date

Inherited From OperationMetadata.createdOn

error

Will exist if the operation encountered any error.

error?: Error

Property Value

Error

Inherited From PollOperationState.error

expiresOn

The date and time when the operation results will expire on the server.

expiresOn?: Date

Property Value

Date

Inherited From OperationMetadata.expiresOn

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

lastModifiedOn

The time the operation status was last updated.

lastModifiedOn: Date

Property Value

Date

Inherited From OperationMetadata.lastModifiedOn

operationId

The operation id.

operationId: string

Property Value

string

Inherited From OperationMetadata.operationId

result

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

result?: TResult

Property Value

TResult

Inherited From PollOperationState.result

status

The current status of the operation.

status: TextAnalyticsOperationStatus

Property Value

TextAnalyticsOperationStatus

Inherited From OperationMetadata.status