Skip to main content

Class: AsyncOperation

Represents an AsyncOperation.

Properties​

checkDuration?​

optional checkDuration?: $Properties | null

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?: $Properties | null

The date and time when the operation completed.

id​

id: string

The operation id.

operationInput?​

optional operationInput?: $Properties | null

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?: $Properties | null

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()​

Call Signature​

static create(properties?): AsyncOperation & $Properties

Creates a new AsyncOperation instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

AsyncOperation & $Properties

AsyncOperation instance

Call Signature​

static create(properties?): AsyncOperation

Creates a new AsyncOperation instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

AsyncOperation

AsyncOperation instance

decode()​

static decode(reader, length?): AsyncOperation & $Properties

Decodes an AsyncOperation message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

AsyncOperation & $Properties

AsyncOperation

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): AsyncOperation & $Properties

Decodes an AsyncOperation message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

AsyncOperation & $Properties

AsyncOperation

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified AsyncOperation message. Does not implicitly temporal.api.cloud.operation.v1.AsyncOperation.verify|verify messages.

Parameters​

message​

$Properties

AsyncOperation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified AsyncOperation message, length delimited. Does not implicitly temporal.api.cloud.operation.v1.AsyncOperation.verify|verify messages.

Parameters​

message​

$Properties

AsyncOperation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): AsyncOperation

Creates an AsyncOperation message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

AsyncOperation

AsyncOperation

toObject()​

static toObject(message, options?): object

Creates a plain object from an AsyncOperation message. Also converts values to other types if specified.

Parameters​

message​

AsyncOperation

AsyncOperation

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object