Class: SignalWithStartWorkflowExecutionResponse
Represents a SignalWithStartWorkflowExecutionResponse.
Properties
firstExecutionRunId
firstExecutionRunId:
string
If the workflow was started as a result of a de-dupe, this field will contain the run id of the first execution in the chain.
runId
runId:
string
The run id of the workflow that was started - or just signaled, if it was already running.
signalLink?
optionalsignalLink?:$Properties|null
Link to be associated with the WorkflowExecutionSignaled event. Added on the response to propagate the backlink. Available from Temporal server 1.31 and up.
started
started:
boolean
If true, a new workflow was started.
Methods
toJSON()
toJSON():
object
Converts this SignalWithStartWorkflowExecutionResponse to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):SignalWithStartWorkflowExecutionResponse&$Shape
Creates a new SignalWithStartWorkflowExecutionResponse instance using the specified properties.
Parameters
properties?
Properties to set
Returns
SignalWithStartWorkflowExecutionResponse & $Shape
SignalWithStartWorkflowExecutionResponse instance
Call Signature
staticcreate(properties?):SignalWithStartWorkflowExecutionResponse
Creates a new SignalWithStartWorkflowExecutionResponse instance using the specified properties.
Parameters
properties?
Properties to set
Returns
SignalWithStartWorkflowExecutionResponse
SignalWithStartWorkflowExecutionResponse instance
decode()
staticdecode(reader,length?):SignalWithStartWorkflowExecutionResponse&$Shape
Decodes a SignalWithStartWorkflowExecutionResponse message from the specified reader or buffer.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
length?
number
Message length if known beforehand
Returns
SignalWithStartWorkflowExecutionResponse & $Shape
SignalWithStartWorkflowExecutionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):SignalWithStartWorkflowExecutionResponse&$Shape
Decodes a SignalWithStartWorkflowExecutionResponse message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
SignalWithStartWorkflowExecutionResponse & $Shape
SignalWithStartWorkflowExecutionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified SignalWithStartWorkflowExecutionResponse message. Does not implicitly temporal.api.workflowservice.v1.SignalWithStartWorkflowExecutionResponse.verify|verify messages.
Parameters
message
SignalWithStartWorkflowExecutionResponse message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified SignalWithStartWorkflowExecutionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.SignalWithStartWorkflowExecutionResponse.verify|verify messages.
Parameters
message
SignalWithStartWorkflowExecutionResponse message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):SignalWithStartWorkflowExecutionResponse
Creates a SignalWithStartWorkflowExecutionResponse message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
SignalWithStartWorkflowExecutionResponse
SignalWithStartWorkflowExecutionResponse
toObject()
statictoObject(message,options?):object
Creates a plain object from a SignalWithStartWorkflowExecutionResponse message. Also converts values to other types if specified.
Parameters
message
SignalWithStartWorkflowExecutionResponse
SignalWithStartWorkflowExecutionResponse
options?
IConversionOptions
Conversion options
Returns
object
Plain object