Class: SignalWithStartWorkflowExecutionResponse
workflowservice.v1.SignalWithStartWorkflowExecutionResponse
Represents a SignalWithStartWorkflowExecutionResponse.
Implements
Constructors
constructor
• new SignalWithStartWorkflowExecutionResponse(properties?): SignalWithStartWorkflowExecutionResponse
Constructs a new SignalWithStartWorkflowExecutionResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISignalWithStartWorkflowExecutionResponse | Properties to set |
Returns
SignalWithStartWorkflowExecutionResponse
Properties
runId
• runId: string
The run id of the workflow that was started - or just signaled, if it was already running.
Implementation of
ISignalWithStartWorkflowExecutionResponse.runId
signalLink
• Optional signalLink: null | ILink
Link to be associated with the WorkflowExecutionSignaled event. Added on the response to propagate the backlink. Available from Temporal server 1.31 and up.
Implementation of
ISignalWithStartWorkflowExecutionResponse.signalLink
started
• started: boolean
If true, a new workflow was started.
Implementation of
ISignalWithStartWorkflowExecutionResponse.started
Methods
toJSON
▸ toJSON(): Object
Converts this SignalWithStartWorkflowExecutionResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SignalWithStartWorkflowExecutionResponse
Creates a new SignalWithStartWorkflowExecutionResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISignalWithStartWorkflowExecutionResponse | Properties to set |
Returns
SignalWithStartWorkflowExecutionResponse
SignalWithStartWorkflowExecutionResponse instance
decode
▸ decode(reader, length?): SignalWithStartWorkflowExecutionResponse
Decodes a SignalWithStartWorkflowExecutionResponse 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
SignalWithStartWorkflowExecutionResponse
SignalWithStartWorkflowExecutionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SignalWithStartWorkflowExecutionResponse
Decodes a SignalWithStartWorkflowExecutionResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SignalWithStartWorkflowExecutionResponse
SignalWithStartWorkflowExecutionResponse
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 SignalWithStartWorkflowExecutionResponse message. Does not implicitly temporal.api.workflowservice.v1.SignalWithStartWorkflowExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISignalWithStartWorkflowExecutionResponse | SignalWithStartWorkflowExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SignalWithStartWorkflowExecutionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.SignalWithStartWorkflowExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISignalWithStartWorkflowExecutionResponse | SignalWithStartWorkflowExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SignalWithStartWorkflowExecutionResponse
Creates a SignalWithStartWorkflowExecutionResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SignalWithStartWorkflowExecutionResponse
SignalWithStartWorkflowExecutionResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for SignalWithStartWorkflowExecutionResponse
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 SignalWithStartWorkflowExecutionResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SignalWithStartWorkflowExecutionResponse | SignalWithStartWorkflowExecutionResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object