Class: WorkflowExecutionSignaledEventAttributes
history.v1.WorkflowExecutionSignaledEventAttributes
Represents a WorkflowExecutionSignaledEventAttributes.
Properties
externalWorkflowExecution
• Optional externalWorkflowExecution: null | $Properties
When signal origin is a workflow execution, this field is set.
header
• Optional header: null | $Properties
Headers that were passed by the sender of the signal and copied by temporal server into the workflow task.
identity
• identity: string
id of the worker/client who sent this signal
input
• Optional input: null | $Properties
Will be deserialized and provided as argument(s) to the signal handler
requestId
• requestId: string
The request ID of the Signal request, used by the server to attach this to the correct Event ID when generating link.
signalName
• signalName: string
The name/type of the signal to fire
skipGenerateWorkflowTask
• skipGenerateWorkflowTask: boolean
Deprecated. This field is never respected and should always be set to false.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionSignaledEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionSignaledEventAttributes & $Properties
Creates a new WorkflowExecutionSignaledEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkflowExecutionSignaledEventAttributes & $Properties
WorkflowExecutionSignaledEventAttributes instance
▸ create(properties?): WorkflowExecutionSignaledEventAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
WorkflowExecutionSignaledEventAttributes
decode
▸ decode(reader, length?): WorkflowExecutionSignaledEventAttributes & $Properties
Decodes a WorkflowExecutionSignaledEventAttributes 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
WorkflowExecutionSignaledEventAttributes & $Properties
WorkflowExecutionSignaledEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionSignaledEventAttributes & $Properties
Decodes a WorkflowExecutionSignaledEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionSignaledEventAttributes & $Properties
WorkflowExecutionSignaledEventAttributes
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 WorkflowExecutionSignaledEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowExecutionSignaledEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionSignaledEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionSignaledEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowExecutionSignaledEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionSignaledEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionSignaledEventAttributes
Creates a WorkflowExecutionSignaledEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionSignaledEventAttributes
WorkflowExecutionSignaledEventAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowExecutionSignaledEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionSignaledEventAttributes | WorkflowExecutionSignaledEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object