Class: WorkflowEvent
Represents a WorkflowEvent.
Implements
Constructors
constructor
• new WorkflowEvent(properties?): WorkflowEvent
Constructs a new WorkflowEvent.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowEvent | Properties to set |
Returns
Properties
eventRef
• Optional eventRef: null | IEventReference
WorkflowEvent eventRef.
Implementation of
namespace
• namespace: string
WorkflowEvent namespace.
Implementation of
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 | IRequestIdReference
WorkflowEvent requestIdRef.
Implementation of
runId
• runId: string
WorkflowEvent runId.
Implementation of
workflowId
• workflowId: string
WorkflowEvent workflowId.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowEvent to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowEvent
Creates a new WorkflowEvent instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowEvent | Properties to set |
Returns
WorkflowEvent instance
decode
▸ decode(reader, length?): WorkflowEvent
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
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 | IWorkflowEvent | 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 | IWorkflowEvent | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowEvent
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
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