Skip to main content

Class: WorkflowExecutionConfig

Represents a WorkflowExecutionConfig.

Properties​

defaultWorkflowTaskTimeout?​

optional defaultWorkflowTaskTimeout?: $Properties | null

WorkflowExecutionConfig defaultWorkflowTaskTimeout.

taskQueue?​

optional taskQueue?: $Properties | null

WorkflowExecutionConfig taskQueue.

userMetadata?​

optional userMetadata?: $Properties | null

User metadata provided on start workflow.

workflowExecutionTimeout?​

optional workflowExecutionTimeout?: $Properties | null

WorkflowExecutionConfig workflowExecutionTimeout.

workflowRunTimeout?​

optional workflowRunTimeout?: $Properties | null

WorkflowExecutionConfig workflowRunTimeout.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowExecutionConfig to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowExecutionConfig & $Properties

Creates a new WorkflowExecutionConfig instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionConfig & $Properties

WorkflowExecutionConfig instance

Call Signature​

static create(properties?): WorkflowExecutionConfig

Creates a new WorkflowExecutionConfig instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionConfig

WorkflowExecutionConfig instance

decode()​

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

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

WorkflowExecutionConfig & $Properties

WorkflowExecutionConfig

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowExecutionConfig & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowExecutionConfig & $Properties

WorkflowExecutionConfig

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

Parameters​

message​

$Properties

WorkflowExecutionConfig message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowExecutionConfig message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowExecutionConfig

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

Parameters​

object​

Plain object

Returns​

WorkflowExecutionConfig

WorkflowExecutionConfig

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowExecutionConfig

WorkflowExecutionConfig

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object