Class: SignalExternalWorkflowExecutionInitiatedEventAttributes
history.v1.SignalExternalWorkflowExecutionInitiatedEventAttributes
Represents a SignalExternalWorkflowExecutionInitiatedEventAttributes.
Properties
childWorkflowOnly
• childWorkflowOnly: boolean
Workers are expected to set this to true if the workflow they are requesting to cancel is a child of the workflow which issued the request
control
• control: string
Deprecated.
header
• Optional header: null | $Properties
SignalExternalWorkflowExecutionInitiatedEventAttributes header.
input
• Optional input: null | $Properties
Serialized arguments to provide to the signal handler
namespace
• namespace: string
Namespace of the to-be-signalled workflow.
SDKs and UI tools should use namespace field but server must use namespace_id only.
namespaceId
• namespaceId: string
SignalExternalWorkflowExecutionInitiatedEventAttributes namespaceId.
signalName
• signalName: string
name/type of the signal to fire in the external workflow
workflowExecution
• Optional workflowExecution: null | $Properties
SignalExternalWorkflowExecutionInitiatedEventAttributes workflowExecution.
workflowTaskCompletedEventId
• workflowTaskCompletedEventId: Long
The WORKFLOW_TASK_COMPLETED event which this command was reported with
Methods
toJSON
▸ toJSON(): Object
Converts this SignalExternalWorkflowExecutionInitiatedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SignalExternalWorkflowExecutionInitiatedEventAttributes & $Properties
Creates a new SignalExternalWorkflowExecutionInitiatedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
SignalExternalWorkflowExecutionInitiatedEventAttributes & $Properties
SignalExternalWorkflowExecutionInitiatedEventAttributes instance
▸ create(properties?): SignalExternalWorkflowExecutionInitiatedEventAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
SignalExternalWorkflowExecutionInitiatedEventAttributes
decode
▸ decode(reader, length?): SignalExternalWorkflowExecutionInitiatedEventAttributes & $Properties
Decodes a SignalExternalWorkflowExecutionInitiatedEventAttributes 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
SignalExternalWorkflowExecutionInitiatedEventAttributes & $Properties
SignalExternalWorkflowExecutionInitiatedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SignalExternalWorkflowExecutionInitiatedEventAttributes & $Properties
Decodes a SignalExternalWorkflowExecutionInitiatedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SignalExternalWorkflowExecutionInitiatedEventAttributes & $Properties
SignalExternalWorkflowExecutionInitiatedEventAttributes
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 SignalExternalWorkflowExecutionInitiatedEventAttributes message. Does not implicitly temporal.api.history.v1.SignalExternalWorkflowExecutionInitiatedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SignalExternalWorkflowExecutionInitiatedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SignalExternalWorkflowExecutionInitiatedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.SignalExternalWorkflowExecutionInitiatedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SignalExternalWorkflowExecutionInitiatedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SignalExternalWorkflowExecutionInitiatedEventAttributes
Creates a SignalExternalWorkflowExecutionInitiatedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SignalExternalWorkflowExecutionInitiatedEventAttributes
SignalExternalWorkflowExecutionInitiatedEventAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a SignalExternalWorkflowExecutionInitiatedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SignalExternalWorkflowExecutionInitiatedEventAttributes | SignalExternalWorkflowExecutionInitiatedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object