Class: StartWorkflowExecutionResponse
workflowservice.v1.StartWorkflowExecutionResponse
Represents a StartWorkflowExecutionResponse.
Properties
eagerWorkflowTask
• Optional eagerWorkflowTask: null | $Properties
When request_eager_execution is set on the StartWorkflowExecutionRequest, the server - if supported - will
return the first workflow task to be eagerly executed.
The caller is expected to have a worker available to process the task.
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.
link
• Optional link: null | $Properties
Link to the workflow event.
runId
• runId: string
The run id of the workflow that was started - or used (via WorkflowIdConflictPolicy USE_EXISTING).
started
• started: boolean
If true, a new workflow was started.
status
• status: WorkflowExecutionStatus
Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING unless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs).
Methods
toJSON
▸ toJSON(): Object
Converts this StartWorkflowExecutionResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): StartWorkflowExecutionResponse & $Shape
Creates a new StartWorkflowExecutionResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
StartWorkflowExecutionResponse & $Shape
StartWorkflowExecutionResponse instance
▸ create(properties?): StartWorkflowExecutionResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
StartWorkflowExecutionResponse
decode
▸ decode(reader, length?): StartWorkflowExecutionResponse & $Shape
Decodes a StartWorkflowExecutionResponse 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
StartWorkflowExecutionResponse & $Shape
StartWorkflowExecutionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): StartWorkflowExecutionResponse & $Shape
Decodes a StartWorkflowExecutionResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
StartWorkflowExecutionResponse & $Shape
StartWorkflowExecutionResponse
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 StartWorkflowExecutionResponse message. Does not implicitly temporal.api.workflowservice.v1.StartWorkflowExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | StartWorkflowExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified StartWorkflowExecutionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.StartWorkflowExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | StartWorkflowExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): StartWorkflowExecutionResponse
Creates a StartWorkflowExecutionResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
StartWorkflowExecutionResponse
StartWorkflowExecutionResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a StartWorkflowExecutionResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | StartWorkflowExecutionResponse | StartWorkflowExecutionResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object