Class: SignalWorkflowExecutionRequest
workflowservice.v1.SignalWorkflowExecutionRequest
Represents a SignalWorkflowExecutionRequest.
Implements
Constructors
constructor
• new SignalWorkflowExecutionRequest(properties?): SignalWorkflowExecutionRequest
Constructs a new SignalWorkflowExecutionRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISignalWorkflowExecutionRequest | Properties to set |
Returns
SignalWorkflowExecutionRequest
Properties
control
• control: string
Deprecated
Implementation of
ISignalWorkflowExecutionRequest.control
header
• Optional header: null | IHeader
Headers that are passed with the signal to the processing workflow. These can include things like auth or tracing tokens.
Implementation of
ISignalWorkflowExecutionRequest.header
identity
• identity: string
The identity of the worker/client
Implementation of
ISignalWorkflowExecutionRequest.identity
input
• Optional input: null | IPayloads
Serialized value(s) to provide with the signal
Implementation of
ISignalWorkflowExecutionRequest.input
links
• links: ILink[]
Links to be associated with the WorkflowExecutionSignaled event.
Implementation of
ISignalWorkflowExecutionRequest.links
namespace
• namespace: string
SignalWorkflowExecutionRequest namespace.
Implementation of
ISignalWorkflowExecutionRequest.namespace
requestId
• requestId: string
Used to de-dupe sent signals
Implementation of
ISignalWorkflowExecutionRequest.requestId
signalName
• signalName: string
The workflow author-defined name of the signal to send to the workflow
Implementation of
ISignalWorkflowExecutionRequest.signalName
skipGenerateWorkflowTask
• skipGenerateWorkflowTask: boolean
Indicates that a new workflow task should not be generated when this signal is received.
Implementation of
ISignalWorkflowExecutionRequest.skipGenerateWorkflowTask
workflowExecution
• Optional workflowExecution: null | IWorkflowExecution
SignalWorkflowExecutionRequest workflowExecution.
Implementation of
ISignalWorkflowExecutionRequest.workflowExecution
Methods
toJSON
▸ toJSON(): Object
Converts this SignalWorkflowExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SignalWorkflowExecutionRequest
Creates a new SignalWorkflowExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISignalWorkflowExecutionRequest | Properties to set |
Returns
SignalWorkflowExecutionRequest
SignalWorkflowExecutionRequest instance
decode
▸ decode(reader, length?): SignalWorkflowExecutionRequest
Decodes a SignalWorkflowExecutionRequest 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
SignalWorkflowExecutionRequest
SignalWorkflowExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SignalWorkflowExecutionRequest
Decodes a SignalWorkflowExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SignalWorkflowExecutionRequest
SignalWorkflowExecutionRequest
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 SignalWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISignalWorkflowExecutionRequest | SignalWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SignalWorkflowExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISignalWorkflowExecutionRequest | SignalWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SignalWorkflowExecutionRequest
Creates a SignalWorkflowExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SignalWorkflowExecutionRequest
SignalWorkflowExecutionRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for SignalWorkflowExecutionRequest
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 SignalWorkflowExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SignalWorkflowExecutionRequest | SignalWorkflowExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object