Skip to main content

Interface: $Properties

Properties of a StartWorkflowExecutionResponse.

Extended by​

Properties​

eagerWorkflowTask?​

optional eagerWorkflowTask?: $Properties | null

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?​

optional firstExecutionRunId?: string | null

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.

optional link?: $Properties | null

Link to the workflow event.

runId?​

optional runId?: string | null

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

started?​

optional started?: boolean | null

If true, a new workflow was started.

status?​

optional status?: WorkflowExecutionStatus | null

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).