Class: WorkflowEvent
Represents a WorkflowEvent.
Properties
eventRef
• Optional eventRef: null | $Properties
WorkflowEvent eventRef.
namespace
• namespace: string
WorkflowEvent namespace.
reference
• Optional reference: "eventRef" | "requestIdRef"
Additional information about the workflow event. Eg: the caller workflow can send the history event details that made the Nexus call.
requestIdRef
• Optional requestIdRef: null | $Properties
WorkflowEvent requestIdRef.
runId
• runId: string
WorkflowEvent runId.
workflowId
• workflowId: string
WorkflowEvent workflowId.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowEvent to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowEvent & $Shape
Creates a new WorkflowEvent instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
WorkflowEvent instance
▸ create(properties?): WorkflowEvent
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkflowEvent & $Shape
Decodes a WorkflowEvent 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
WorkflowEvent
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowEvent & $Shape
Decodes a WorkflowEvent message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowEvent
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 WorkflowEvent message. Does not implicitly temporal.api.common.v1.Link.WorkflowEvent.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowEvent message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowEvent message, length delimited. Does not implicitly temporal.api.common.v1.Link.WorkflowEvent.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowEvent message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowEvent
Creates a WorkflowEvent message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowEvent
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowEvent message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowEvent | WorkflowEvent |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object