Skip to main content

Class: WorkflowExecutionOptions

Represents a WorkflowExecutionOptions.

Properties​

priority?​

optional priority?: $Properties | null

If set, overrides the workflow's priority sent by the SDK.

timeSkippingConfig?​

optional timeSkippingConfig?: $Properties | null

The time-skipping configuration for this workflow execution. When fast_forward is set, time will be fast-forwarded to a future point relative to the current workflow timestamp. Each call takes effect, even if fast_forward is set to the same duration, since the target time is recalculated from the current timestamp on every call.

This field must be updated as a whole; updating individual sub-fields is not supported. When setting the update mask in UpdateWorkflowExecutionOptionsRequest, BatchOperationUpdateWorkflowExecutionOptions, etc., use a mask that covers the entire field.

versioningOverride?​

optional versioningOverride?: $Properties | null

If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowExecutionOptions to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowExecutionOptions & $Shape

Creates a new WorkflowExecutionOptions instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

WorkflowExecutionOptions & $Shape

WorkflowExecutionOptions instance

Call Signature​

static create(properties?): WorkflowExecutionOptions

Creates a new WorkflowExecutionOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionOptions

WorkflowExecutionOptions instance

decode()​

static decode(reader, length?): WorkflowExecutionOptions & $Shape

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

WorkflowExecutionOptions & $Shape

WorkflowExecutionOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowExecutionOptions & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowExecutionOptions & $Shape

WorkflowExecutionOptions

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

Parameters​

message​

$Properties

WorkflowExecutionOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowExecutionOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowExecutionOptions

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

Parameters​

object​

Plain object

Returns​

WorkflowExecutionOptions

WorkflowExecutionOptions

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowExecutionOptions

WorkflowExecutionOptions

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object