Skip to main content

Interface: IStartWorkflowExecutionResponse

workflowservice.v1.IStartWorkflowExecutionResponse

Properties of a StartWorkflowExecutionResponse.

Hierarchy​

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.

Inherited from​

$Properties.eagerWorkflowTask


firstExecutionRunId​

• Optional firstExecutionRunId: null | 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.

Inherited from​

$Properties.firstExecutionRunId


• Optional link: null | $Properties

Link to the workflow event.

Inherited from​

$Properties.link


runId​

• Optional runId: null | string

The run id of the workflow that was started - or used (via WorkflowIdConflictPolicy USE_EXISTING).

Inherited from​

$Properties.runId


started​

• Optional started: null | boolean

If true, a new workflow was started.

Inherited from​

$Properties.started


status​

• Optional status: null | 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).

Inherited from​

$Properties.status