Class: AsyncOperation

operation.v1.AsyncOperation

Represents an AsyncOperation.

Implements

• IAsyncOperation

Constructors

constructor

• new AsyncOperation(properties?): AsyncOperation

Constructs a new AsyncOperation.

Parameters

Name	Type	Description
properties?	IAsyncOperation	Properties to set

Returns

AsyncOperation

Properties

checkDuration

• Optional checkDuration: null | IDuration

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

Implementation of

IAsyncOperation.checkDuration

---

failureReason

• failureReason: string

If the operation failed, the reason for the failure.

Implementation of

IAsyncOperation.failureReason

---

finishedTime

• Optional finishedTime: null | ITimestamp

The date and time when the operation completed.

Implementation of

IAsyncOperation.finishedTime

---

id

• id: string

The operation id.

Implementation of

IAsyncOperation.id

---

operationInput

• Optional operationInput: null | IAny

The input to the operation being performed.

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

Implementation of

IAsyncOperation.operationInput

---

operationType

• operationType: string

The type of operation being performed.

Implementation of

IAsyncOperation.operationType

---

startedTime

• Optional startedTime: null | ITimestamp

The date and time when the operation initiated.

Implementation of

IAsyncOperation.startedTime

---

state

• state: State

The current state of this operation. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=state_deprecated

Implementation of

IAsyncOperation.state

---

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

Implementation of

IAsyncOperation.stateDeprecated

Methods

toJSON

▸ toJSON(): Object

Converts this AsyncOperation to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): AsyncOperation

Creates a new AsyncOperation instance using the specified properties.

Parameters

Name	Type	Description
properties?	IAsyncOperation	Properties to set

Returns

AsyncOperation

AsyncOperation instance

---

decode

▸ decode(reader, length?): AsyncOperation

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

AsyncOperation

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): AsyncOperation

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

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	IAsyncOperation	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	IAsyncOperation	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

AsyncOperation

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for AsyncOperation

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

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