Class: SignalExternalWorkflowExecutionCommandAttributes
command.v1.SignalExternalWorkflowExecutionCommandAttributes
Represents a SignalExternalWorkflowExecutionCommandAttributes.
Properties
childWorkflowOnly
• childWorkflowOnly: boolean
Set this to true if the workflow being cancelled is a child of the workflow originating this command. The request will be rejected if it is set to true and the target workflow is not a child of the requesting workflow.
control
• control: string
Deprecated
execution
• Optional execution: null | $Properties
SignalExternalWorkflowExecutionCommandAttributes execution.
header
• Optional header: null | $Properties
Headers that are passed by the workflow that is sending a signal to the external workflow that is receiving this signal.
input
• Optional input: null | $Properties
Serialized value(s) to provide with the signal.
namespace
• namespace: string
Deprecated. Cross-namespace operations are disabled by default as of server 1.30.1.
signalName
• signalName: string
The workflow author-defined name of the signal to send to the workflow.
Methods
toJSON
▸ toJSON(): Object
Converts this SignalExternalWorkflowExecutionCommandAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SignalExternalWorkflowExecutionCommandAttributes & $Properties
Creates a new SignalExternalWorkflowExecutionCommandAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
SignalExternalWorkflowExecutionCommandAttributes & $Properties
SignalExternalWorkflowExecutionCommandAttributes instance
▸ create(properties?): SignalExternalWorkflowExecutionCommandAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
SignalExternalWorkflowExecutionCommandAttributes
decode
▸ decode(reader, length?): SignalExternalWorkflowExecutionCommandAttributes & $Properties
Decodes a SignalExternalWorkflowExecutionCommandAttributes 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
SignalExternalWorkflowExecutionCommandAttributes & $Properties
SignalExternalWorkflowExecutionCommandAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SignalExternalWorkflowExecutionCommandAttributes & $Properties
Decodes a SignalExternalWorkflowExecutionCommandAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SignalExternalWorkflowExecutionCommandAttributes & $Properties
SignalExternalWorkflowExecutionCommandAttributes
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 SignalExternalWorkflowExecutionCommandAttributes message. Does not implicitly temporal.api.command.v1.SignalExternalWorkflowExecutionCommandAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SignalExternalWorkflowExecutionCommandAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SignalExternalWorkflowExecutionCommandAttributes message, length delimited. Does not implicitly temporal.api.command.v1.SignalExternalWorkflowExecutionCommandAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SignalExternalWorkflowExecutionCommandAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SignalExternalWorkflowExecutionCommandAttributes
Creates a SignalExternalWorkflowExecutionCommandAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SignalExternalWorkflowExecutionCommandAttributes
SignalExternalWorkflowExecutionCommandAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a SignalExternalWorkflowExecutionCommandAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SignalExternalWorkflowExecutionCommandAttributes | SignalExternalWorkflowExecutionCommandAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object