Skip to main content

Class: Link

Link can be associated with history events. It might contain information about an external entity related to the history event. For example, workflow A makes a Nexus call that starts workflow B: in this case, a history event in workflow A could contain a Link to the workflow started event in workflow B, and vice-versa.

Properties​

activity?​

optional activity?: $Properties | null

Link activity.

batchJob?​

optional batchJob?: $Properties | null

Link batchJob.

callback?​

optional callback?: $Properties | null

Link callback.

nexusOperation?​

optional nexusOperation?: $Properties | null

Link nexusOperation.

variant?​

optional variant?: "workflowEvent" | "batchJob" | "activity" | "nexusOperation" | "workflow" | "callback"

Link variant.

workflow?​

optional workflow?: $Properties | null

Link workflow.

workflowEvent?​

optional workflowEvent?: $Properties | null

Link workflowEvent.

Methods​

toJSON()​

toJSON(): object

Converts this Link to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Link & $Shape

Creates a new Link instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Link & $Shape

Link instance

Call Signature​

static create(properties?): Link

Creates a new Link instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Link

Link instance

decode()​

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

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

Link & $Shape

Link

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Link & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Link & $Shape

Link

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

Parameters​

message​

$Properties

Link message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Link message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Link

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Link

Link

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Link

Link

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object