Class: AsyncOperation
Represents an AsyncOperation.
Properties
checkDuration
• Optional checkDuration: null | $Properties
The recommended duration to check back for an update in the operation's state.
failureReason
• failureReason: string
If the operation failed, the reason for the failure.
finishedTime
• Optional finishedTime: null | $Properties
The date and time when the operation completed.
id
• id: string
The operation id.
operationInput
• Optional operationInput: null | $Properties
The input to the operation being performed.
(-- api-linter: core::0146::any=disabled --)
operationType
• operationType: string
The type of operation being performed.
startedTime
• Optional startedTime: null | $Properties
The date and time when the operation initiated.
state
• state: State
The current state of this operation. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=state_deprecated
stateDeprecated
• stateDeprecated: string
The current state of this operation. Possible values are: pending, in_progress, failed, cancelled, fulfilled. Deprecated: Not supported after v0.3.0 api version. Use state instead. temporal:versioning:max_version=v0.3.0
Methods
toJSON
▸ toJSON(): Object
Converts this AsyncOperation to JSON.
Returns
Object
JSON object
create
▸ create(properties?): AsyncOperation & $Properties
Creates a new AsyncOperation instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
AsyncOperation instance
▸ create(properties?): AsyncOperation
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): AsyncOperation & $Properties
Decodes an AsyncOperation message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
AsyncOperation
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): AsyncOperation & $Properties
Decodes an AsyncOperation message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
AsyncOperation
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified AsyncOperation message. Does not implicitly temporal.api.cloud.operation.v1.AsyncOperation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | AsyncOperation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified AsyncOperation message, length delimited. Does not implicitly temporal.api.cloud.operation.v1.AsyncOperation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | AsyncOperation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): AsyncOperation
Creates an AsyncOperation message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
AsyncOperation
toObject
▸ toObject(message, options?): Object
Creates a plain object from an AsyncOperation message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | AsyncOperation | AsyncOperation |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object