Skip to main content

Interface: CompiledWorkflowOptions

client.CompiledWorkflowOptions

Hierarchy​

Properties​

args​

• args: unknown[]

cronSchedule​

• Optional cronSchedule: string

Optional cron schedule for Workflow. If a cron schedule is specified, the Workflow will run as a cron based on the schedule. The scheduling will be based on UTC time. The schedule for the next run only happens after the current run is completed/failed/timeout. If a RetryPolicy is also supplied, and the Workflow failed or timed out, the Workflow will be retried based on the retry policy. While the Workflow is retrying, it won't schedule its next run. If the next schedule is due while the Workflow is running (or retrying), then it will skip that schedule. Cron Workflow will not stop until it is terminated or cancelled (by returning temporal.CanceledError). https://crontab.guru/ is useful for testing your cron expressions.

Inherited from​

WithCompiledWorkflowOptions.cronSchedule

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​

WithCompiledWorkflowOptions.followRuns

memo​

• Optional memo: Record<string, unknown>

Specifies additional non-indexed information to attach to the Workflow Execution. The values can be anything that is serializable by DataConverter.

Inherited from​

WithCompiledWorkflowOptions.memo

priority​

• Optional priority: Priority

Priority of a workflow

Inherited from​

WithCompiledWorkflowOptions.priority

requestEagerStart​

• Optional requestEagerStart: boolean

Potentially reduce the latency to start this workflow by requesting that the server start it on a local worker running with this same client.

Inherited from​

WithCompiledWorkflowOptions.requestEagerStart

retry​

• Optional retry: RetryPolicy

Controls how a Workflow Execution is retried.

By default, Workflow Executions are not retried. Do not override this behavior unless you know what you're doing. More information.

Inherited from​

WithCompiledWorkflowOptions.retry

searchAttributes​

• Optional searchAttributes: SearchAttributes

Specifies additional indexed information to attach to the Workflow Execution. More info: https://docs.temporal.io/docs/typescript/search-attributes

Values are always converted using JsonPayloadConverter, even when a custom data converter is provided.

Deprecated

Use typedSearchAttributes instead.

Inherited from​

WithCompiledWorkflowOptions.searchAttributes

startDelay​

• Optional startDelay: IDuration

Inherited from​

WithCompiledWorkflowOptions.startDelay

staticDetails​

• Optional staticDetails: string

General fixed details for this workflow execution that may appear in UI/CLI. This can be in Temporal markdown format and can span multiple lines.

Inherited from​

WithCompiledWorkflowOptions.staticDetails

staticSummary​

• Optional staticSummary: string

A single-line fixed summary for this workflow execution that may appear in the UI/CLI. This can be in single-line Temporal markdown format.

Inherited from​

WithCompiledWorkflowOptions.staticSummary

taskQueue​

• taskQueue: string

Task queue to use for Workflow tasks. It should match a task queue specified when creating a Worker that hosts the Workflow code.

Inherited from​

WithCompiledWorkflowOptions.taskQueue

typeInfo​

• Optional typeInfo: PayloadTypeInfo

Type information used to encode and decode Workflow input and output.

Inherited from​

WithCompiledWorkflowOptions.typeInfo

typedSearchAttributes​

• Optional typedSearchAttributes: TypedSearchAttributes | SearchAttributePair[]

Specifies additional indexed information to attach to the Workflow Execution. More info: https://docs.temporal.io/docs/typescript/search-attributes

Values are always converted using JsonPayloadConverter, even when a custom data converter is provided. Note that search attributes are not encoded, as such, do not include any sensitive information.

If both searchAttributes and typedSearchAttributes are provided, conflicting keys will be overwritten by typedSearchAttributes.

Inherited from​

WithCompiledWorkflowOptions.typedSearchAttributes

versioningOverride​

• Optional versioningOverride: IVersioningOverride

Inherited from​

WithCompiledWorkflowOptions.versioningOverride

workflowExecutionTimeout​

• Optional workflowExecutionTimeout: IDuration

Inherited from​

WithCompiledWorkflowOptions.workflowExecutionTimeout

workflowId​

• workflowId: string

Workflow id to use when starting.

Assign a meaningful business id. This ID can be used to ensure starting Workflows is idempotent. Workflow IDs are unique: see WorkflowOptions.workflowIdReusePolicy and WorkflowOptions.workflowIdConflictPolicy.

Inherited from​

WithCompiledWorkflowOptions.workflowId

workflowIdConflictPolicy​

• Optional workflowIdConflictPolicy: WorkflowIdConflictPolicy

Defines what happens when trying to start a Workflow with the same ID as a Running Workflow.

Note: It is not possible to have two actively running Workflows with the same ID.

Default

WorkflowIdConflictPolicy.WORKFLOW_ID_CONFLICT_POLICY_UNSPECIFIED

Inherited from​

WithCompiledWorkflowOptions.workflowIdConflictPolicy

workflowIdReusePolicy​

• Optional workflowIdReusePolicy: WorkflowIdReusePolicy

Defines what happens when trying to start a Workflow with the same ID as a Closed Workflow.

Note: It is not possible to have two actively running Workflows with the same ID.

Default

WorkflowIdReusePolicy.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE

Inherited from​

WithCompiledWorkflowOptions.workflowIdReusePolicy

workflowRunTimeout​

• Optional workflowRunTimeout: IDuration

Inherited from​

WithCompiledWorkflowOptions.workflowRunTimeout

workflowTaskTimeout​

• Optional workflowTaskTimeout: IDuration

Inherited from​

WithCompiledWorkflowOptions.workflowTaskTimeout