Skip to main content

Class: WorkflowDefinition

(-- api-linter: core::0203::optional=disabled --)

Properties​

queryDefinitions​

queryDefinitions: $Properties[]

Query definitions, sorted by name.

signalDefinitions​

signalDefinitions: $Properties[]

Signal definitions, sorted by name.

type​

type: string

A name scoped by the task queue that maps to this workflow definition. If missing, this workflow is a dynamic workflow.

updateDefinitions​

updateDefinitions: $Properties[]

Update definitions, sorted by name.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowDefinition to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowDefinition & $Properties

Creates a new WorkflowDefinition instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowDefinition & $Properties

WorkflowDefinition instance

Call Signature​

static create(properties?): WorkflowDefinition

Creates a new WorkflowDefinition instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowDefinition

WorkflowDefinition instance

decode()​

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

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

WorkflowDefinition & $Properties

WorkflowDefinition

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowDefinition & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowDefinition & $Properties

WorkflowDefinition

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

Parameters​

message​

$Properties

WorkflowDefinition message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowDefinition message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowDefinition

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

Parameters​

object​

Plain object

Returns​

WorkflowDefinition

WorkflowDefinition

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowDefinition

WorkflowDefinition

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object