Class: WaitPolicy

Specifies client's intent to wait for Update results.

Properties

lifecycleStage

lifecycleStage: UpdateWorkflowExecutionLifecycleStage

Indicates the Update lifecycle stage that the Update must reach before API call is returned. NOTE: This field works together with API call timeout which is limited by server timeout (maximum wait time). If server timeout is expired before user specified timeout, API call returns even if specified stage is not reached.

Methods

toJSON()

toJSON(): object

Converts this WaitPolicy to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): WaitPolicy & $Properties

Creates a new WaitPolicy instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

WaitPolicy & $Properties

WaitPolicy instance

Call Signature

static create(properties?): WaitPolicy

Creates a new WaitPolicy instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

WaitPolicy

WaitPolicy instance

---

decode()

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

Decodes a WaitPolicy 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

WaitPolicy & $Properties

WaitPolicy

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): WaitPolicy & $Properties

Decodes a WaitPolicy message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

WaitPolicy & $Properties

WaitPolicy

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 WaitPolicy message. Does not implicitly temporal.api.update.v1.WaitPolicy.verify|verify messages.

Parameters

message

$Properties

WaitPolicy message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified WaitPolicy message, length delimited. Does not implicitly temporal.api.update.v1.WaitPolicy.verify|verify messages.

Parameters

message

$Properties

WaitPolicy message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): WaitPolicy

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

Parameters

object

Plain object

Returns

WaitPolicy

WaitPolicy

---

toObject()

static toObject(message, options?): object

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

Parameters

message

WaitPolicy

WaitPolicy

options?

IConversionOptions

Conversion options

Returns

object

Plain object