Class: SignalExternalWorkflowExecution
coresdk.workflow_commands.SignalExternalWorkflowExecution
Send a signal to an external or child workflow
Implements
Constructors
constructor
• new SignalExternalWorkflowExecution(properties?): SignalExternalWorkflowExecution
Constructs a new SignalExternalWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISignalExternalWorkflowExecution | Properties to set |
Returns
SignalExternalWorkflowExecution
Properties
args
• args: IPayload[]
Arguments for the handler
Implementation of
ISignalExternalWorkflowExecution.args
childWorkflowId
• Optional childWorkflowId: null | string
The desired target must be a child of the issuing workflow, and this is its workflow id
Implementation of
ISignalExternalWorkflowExecution.childWorkflowId
headers
• headers: Object
Headers to attach to the signal
Index signature
▪ [k: string]: IPayload
Implementation of
ISignalExternalWorkflowExecution.headers
seq
• seq: number
Lang's incremental sequence number, used as the operation identifier
Implementation of
ISignalExternalWorkflowExecution.seq
signalName
• signalName: string
Name of the signal handler
Implementation of
ISignalExternalWorkflowExecution.signalName
target
• Optional target: "workflowExecution" | "childWorkflowId"
What workflow is being targeted
workflowExecution
• Optional workflowExecution: null | INamespacedWorkflowExecution
A specific workflow instance
Implementation of
ISignalExternalWorkflowExecution.workflowExecution
Methods
toJSON
▸ toJSON(): Object
Converts this SignalExternalWorkflowExecution to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SignalExternalWorkflowExecution
Creates a new SignalExternalWorkflowExecution instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISignalExternalWorkflowExecution | Properties to set |
Returns
SignalExternalWorkflowExecution
SignalExternalWorkflowExecution instance
decode
▸ decode(reader, length?): SignalExternalWorkflowExecution
Decodes a SignalExternalWorkflowExecution 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
SignalExternalWorkflowExecution
SignalExternalWorkflowExecution
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SignalExternalWorkflowExecution
Decodes a SignalExternalWorkflowExecution message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SignalExternalWorkflowExecution
SignalExternalWorkflowExecution
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 SignalExternalWorkflowExecution message. Does not implicitly coresdk.workflow_commands.SignalExternalWorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISignalExternalWorkflowExecution | SignalExternalWorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SignalExternalWorkflowExecution message, length delimited. Does not implicitly coresdk.workflow_commands.SignalExternalWorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISignalExternalWorkflowExecution | SignalExternalWorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SignalExternalWorkflowExecution
Creates a SignalExternalWorkflowExecution message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SignalExternalWorkflowExecution
SignalExternalWorkflowExecution
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for SignalExternalWorkflowExecution
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 SignalExternalWorkflowExecution message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SignalExternalWorkflowExecution | SignalExternalWorkflowExecution |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object