Skip to main content

Class: WorkflowExecution

Identifies a specific workflow within a namespace. Practically speaking, because run_id is a uuid, a workflow execution is globally unique. Note that many commands allow specifying an empty run id as a way of saying "target the latest run of the workflow".

Properties​

runId​

runId: string

WorkflowExecution runId.

workflowId​

workflowId: string

WorkflowExecution workflowId.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowExecution to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowExecution & $Properties

Creates a new WorkflowExecution instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecution & $Properties

WorkflowExecution instance

Call Signature​

static create(properties?): WorkflowExecution

Creates a new WorkflowExecution instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecution

WorkflowExecution instance

decode()​

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

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

WorkflowExecution & $Properties

WorkflowExecution

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowExecution & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowExecution & $Properties

WorkflowExecution

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

Parameters​

message​

$Properties

WorkflowExecution message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowExecution message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowExecution

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

WorkflowExecution

WorkflowExecution

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowExecution

WorkflowExecution

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object