Skip to main content

Class: Workflow

A link to a workflow execution. This is a more general version of WorkflowEvent that doesn't specify a particular event within the workflow, useful when you want to link to a workflow but there is no particular event to link to, such as a Query or a Rejected Update.

Properties​

namespace​

namespace: string

Workflow namespace.

reason​

reason: string

Workflow reason.

runId​

runId: string

Workflow runId.

workflowId​

workflowId: string

Workflow workflowId.

Methods​

toJSON()​

toJSON(): object

Converts this Workflow to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Workflow & $Properties

Creates a new Workflow instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Workflow & $Properties

Workflow instance

Call Signature​

static create(properties?): Workflow

Creates a new Workflow instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Workflow

Workflow instance

decode()​

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

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

Workflow & $Properties

Workflow

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Workflow & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Workflow & $Properties

Workflow

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

Parameters​

message​

$Properties

Workflow message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Workflow message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Workflow

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

Parameters​

object​

Plain object

Returns​

Workflow

Workflow

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Workflow

Workflow

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object