Skip to main content

Interface: GetWorkflowHandleOptions

client.GetWorkflowHandleOptions

Options for getting a result of a Workflow execution.

Hierarchy

Properties

firstExecutionRunId

Optional firstExecutionRunId: string

ID of the first execution in the Workflow execution chain.

When getting a handle with no runId, pass this option to ensure some WorkflowHandle methods (e.g. terminate and cancel) don't affect executions from another chain.


followRuns

Optional followRuns: boolean

If set to true, instructs the client to follow the chain of execution before returning a Workflow's result.

Workflow execution is chained if the Workflow has a cron schedule or continues-as-new or configured to retry after failure or timeout.

Default

true

Inherited from

WorkflowResultOptions.followRuns