AnalyzeBatchOperationState interface
The state of the begin analyze polling operation.
- Extends
Inherited Properties
action |
Number of failed actions. |
action |
Number of actions still in progress. |
action |
Number of successfully completed actions. |
created |
The date and time the operation was created. |
display |
The operation's display name. |
error | Will exist if the operation encountered any error. |
expires |
The date and time when the operation results will expire on the server. |
is |
True if the operation has been cancelled. |
is |
True if the operation has been completed. |
is |
True if the operation has started. |
last |
The time the operation status was last updated. |
operation |
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
actionFailedCount
Number of failed actions.
actionFailedCount: number
Property Value
number
Inherited From AnalyzeBatchOperationMetadata.actionFailedCount
actionInProgressCount
Number of actions still in progress.
actionInProgressCount: number
Property Value
number
Inherited From AnalyzeBatchOperationMetadata.actionInProgressCount
actionSucceededCount
Number of successfully completed actions.
actionSucceededCount: number
Property Value
number
Inherited From AnalyzeBatchOperationMetadata.actionSucceededCount
createdOn
The date and time the operation was created.
createdOn: Date
Property Value
Date
Inherited From AnalyzeBatchOperationMetadata.createdOn
displayName
The operation's display name.
displayName?: string
Property Value
string
Inherited From AnalyzeBatchOperationMetadata.displayName
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 AnalyzeBatchOperationMetadata.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 AnalyzeBatchOperationMetadata.lastModifiedOn
operationId
The operation id.
operationId: string
Property Value
string
Inherited From AnalyzeBatchOperationMetadata.operationId
result
Will exist if the operation concluded in a result of an expected type.
result?: PagedAnalyzeBatchResult
Property Value
Inherited From PollOperationState.result
status
The current status of the operation.
status: OperationStatus
Property Value
Inherited From AnalyzeBatchOperationMetadata.status
Azure SDK for JavaScript
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for