Skip to main content

Interface: IAsyncOperation

operation.v1.IAsyncOperation

Properties of an AsyncOperation.

Implemented by

Properties

checkDuration

Optional checkDuration: null | IDuration

The recommended duration to check back for an update in the operation's state.


failureReason

Optional failureReason: null | string

If the operation failed, the reason for the failure.


finishedTime

Optional finishedTime: null | ITimestamp

The date and time when the operation completed.


id

Optional id: null | string

The operation id.


operationInput

Optional operationInput: null | IAny

The input to the operation being performed.

(-- api-linter: core::0146::any=disabled --)


operationType

Optional operationType: null | string

The type of operation being performed.


startedTime

Optional startedTime: null | ITimestamp

The date and time when the operation initiated.


state

Optional state: null | State

The current state of this operation. temporal:versioning:min_version=2024-10-01-00 temporal:enums:replaces=state_deprecated


stateDeprecated

Optional stateDeprecated: null | string

The current state of this operation. Possible values are: pending, in_progress, failed, cancelled, fulfilled. Deprecated: Not supported after 2024-10-01-00 api version. Use state instead. temporal:versioning:max_version=2024-10-01-00