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: null | $Properties
Link activity.
batchJob
• Optional batchJob: null | $Properties
Link batchJob.
nexusOperation
• Optional nexusOperation: null | $Properties
Link nexusOperation.
variant
• Optional variant: "workflowEvent" | "batchJob" | "activity" | "nexusOperation" | "workflow"
Link variant.
workflow
• Optional workflow: null | $Properties
Link workflow.
workflowEvent
• Optional workflowEvent: null | $Properties
Link workflowEvent.
Methods
toJSON
▸ toJSON(): Object
Converts this Link to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Link & $Shape
Creates a new Link instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
Link instance
▸ create(properties?): Link
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Link & $Shape
Decodes a Link message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Link
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Link & $Shape
Decodes a Link message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | $Properties | Link message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | $Properties | Link message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Link
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Link message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Link | Link |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object