Skip to main content

Class: PollWorkflowExecutionTimeSkippingRequest

A long-poll request that blocks according to a time-skipping waiting policy on the workflow execution. Currently the only supported policy is waiting for completion of the fast-forward identified by fast_forward_id; the poll also returns once anything else settles that outcome (e.g. the execution ends or time skipping is disabled).

Properties​

fastForwardId​

fastForwardId: string

Required. Identifies the fast-forward whose completion the caller wants to wait for. Must match the fast_forward_id set in the execution's TimeSkippingConfig.

namespace​

namespace: string

PollWorkflowExecutionTimeSkippingRequest namespace.

workflowExecution?​

optional workflowExecution?: $Properties | null

PollWorkflowExecutionTimeSkippingRequest workflowExecution.

Methods​

toJSON()​

toJSON(): object

Converts this PollWorkflowExecutionTimeSkippingRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): PollWorkflowExecutionTimeSkippingRequest & $Properties

Creates a new PollWorkflowExecutionTimeSkippingRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PollWorkflowExecutionTimeSkippingRequest & $Properties

PollWorkflowExecutionTimeSkippingRequest instance

Call Signature​

static create(properties?): PollWorkflowExecutionTimeSkippingRequest

Creates a new PollWorkflowExecutionTimeSkippingRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PollWorkflowExecutionTimeSkippingRequest

PollWorkflowExecutionTimeSkippingRequest instance

decode()​

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

Decodes a PollWorkflowExecutionTimeSkippingRequest 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​

PollWorkflowExecutionTimeSkippingRequest & $Properties

PollWorkflowExecutionTimeSkippingRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): PollWorkflowExecutionTimeSkippingRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

PollWorkflowExecutionTimeSkippingRequest & $Properties

PollWorkflowExecutionTimeSkippingRequest

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

Parameters​

message​

$Properties

PollWorkflowExecutionTimeSkippingRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

PollWorkflowExecutionTimeSkippingRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): PollWorkflowExecutionTimeSkippingRequest

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

Parameters​

object​

Plain object

Returns​

PollWorkflowExecutionTimeSkippingRequest

PollWorkflowExecutionTimeSkippingRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

PollWorkflowExecutionTimeSkippingRequest

PollWorkflowExecutionTimeSkippingRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object