Class: PollWorkflowExecutionUpdateRequest

Represents a PollWorkflowExecutionUpdateRequest.

Properties

identity

identity: string

The identity of the worker/client who is polling this Update outcome.

---

namespace

namespace: string

The namespace of the Workflow Execution to which the Update was originally issued.

---

updateRef?

optional updateRef?: $Properties | null

The Update reference returned in the initial UpdateWorkflowExecutionResponse.

---

waitPolicy?

optional waitPolicy?: $Properties | null

Specifies client's intent to wait for Update results. Omit to request a non-blocking poll.

Methods

toJSON()

toJSON(): object

Converts this PollWorkflowExecutionUpdateRequest to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): PollWorkflowExecutionUpdateRequest & $Properties

Creates a new PollWorkflowExecutionUpdateRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

PollWorkflowExecutionUpdateRequest & $Properties

PollWorkflowExecutionUpdateRequest instance

Call Signature

static create(properties?): PollWorkflowExecutionUpdateRequest

Creates a new PollWorkflowExecutionUpdateRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

PollWorkflowExecutionUpdateRequest

PollWorkflowExecutionUpdateRequest instance

---

decode()

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

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

PollWorkflowExecutionUpdateRequest & $Properties

PollWorkflowExecutionUpdateRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): PollWorkflowExecutionUpdateRequest & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

PollWorkflowExecutionUpdateRequest & $Properties

PollWorkflowExecutionUpdateRequest

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

Parameters

message

$Properties

PollWorkflowExecutionUpdateRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

PollWorkflowExecutionUpdateRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): PollWorkflowExecutionUpdateRequest

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

Parameters

object

Plain object

Returns

PollWorkflowExecutionUpdateRequest

PollWorkflowExecutionUpdateRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

PollWorkflowExecutionUpdateRequest

PollWorkflowExecutionUpdateRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object