Class: SignalWorkflowExecutionResponse
workflowservice.v1.SignalWorkflowExecutionResponse
Represents a SignalWorkflowExecutionResponse.
Properties
link
• Optional link: null | $Properties
Link to be associated with the WorkflowExecutionSignaled event. Added on the response to propagate the backlink. Available from Temporal server 1.31 and up.
Methods
toJSON
▸ toJSON(): Object
Converts this SignalWorkflowExecutionResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SignalWorkflowExecutionResponse & $Shape
Creates a new SignalWorkflowExecutionResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
SignalWorkflowExecutionResponse & $Shape
SignalWorkflowExecutionResponse instance
▸ create(properties?): SignalWorkflowExecutionResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
SignalWorkflowExecutionResponse
decode
▸ decode(reader, length?): SignalWorkflowExecutionResponse & $Shape
Decodes a SignalWorkflowExecutionResponse 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
SignalWorkflowExecutionResponse & $Shape
SignalWorkflowExecutionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SignalWorkflowExecutionResponse & $Shape
Decodes a SignalWorkflowExecutionResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SignalWorkflowExecutionResponse & $Shape
SignalWorkflowExecutionResponse
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 SignalWorkflowExecutionResponse message. Does not implicitly temporal.api.workflowservice.v1.SignalWorkflowExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SignalWorkflowExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SignalWorkflowExecutionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.SignalWorkflowExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SignalWorkflowExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SignalWorkflowExecutionResponse
Creates a SignalWorkflowExecutionResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SignalWorkflowExecutionResponse
SignalWorkflowExecutionResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a SignalWorkflowExecutionResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SignalWorkflowExecutionResponse | SignalWorkflowExecutionResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object