Skip to main content

Class: Link

common.v1.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.

Implements

Constructors

constructor

new Link(properties?): Link

Constructs a new Link.

Parameters

NameTypeDescription
properties?ILinkProperties to set

Returns

Link

Properties

batchJob

Optional batchJob: null | IBatchJob

Link batchJob.

Implementation of

ILink.batchJob


variant

Optional variant: "workflowEvent" | "batchJob"

Link variant.


workflowEvent

Optional workflowEvent: null | IWorkflowEvent

Link workflowEvent.

Implementation of

ILink.workflowEvent

Methods

toJSON

toJSON(): Object

Converts this Link to JSON.

Returns

Object

JSON object


create

create(properties?): Link

Creates a new Link instance using the specified properties.

Parameters

NameTypeDescription
properties?ILinkProperties to set

Returns

Link

Link instance


decode

decode(reader, length?): Link

Decodes a Link message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

Link

Link

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Link

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Link

Link

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageILinkLink message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageILinkLink message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): Link

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Link

Link


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Link

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageLinkLink
options?IConversionOptionsConversion options

Returns

Object

Plain object