Skip to main content

Interface: ChildWorkflowOptions

workflow.ChildWorkflowOptions

Hierarchy​

Properties​

cancellationType​

• Optional cancellationType: ChildWorkflowCancellationType

Specifies:

Default

{@link ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED}

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​

CommonWorkflowOptions.cronSchedule

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​

CommonWorkflowOptions.memo

parentClosePolicy​

• Optional parentClosePolicy: ParentClosePolicy

Specifies how the Child reacts to the Parent Workflow reaching a Closed state.

Default

{@link ParentClosePolicy.PARENT_CLOSE_POLICY_TERMINATE}

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​

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

Inherited from​

CommonWorkflowOptions.searchAttributes

taskQueue​

• Optional 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.

By default, a child is scheduled on the same Task Queue as the parent.

versioningIntent​

• Optional versioningIntent: VersioningIntent

When using the Worker Versioning feature, specifies whether this Child Workflow should run on a worker with a compatible Build Id or not. See VersioningIntent.

Default

'COMPATIBLE'

@experimental

workflowExecutionTimeout​

• Optional workflowExecutionTimeout: Duration

The time after which workflow execution (which includes run retries and continue as new) is automatically terminated by Temporal service. Do not rely on execution timeout for business level timeouts. It is preferred to use in workflow timers for this purpose.

Format

number of milliseconds or ms-formatted string

Inherited from​

CommonWorkflowOptions.workflowExecutionTimeout

workflowId​

• Optional workflowId: string

Workflow id to use when starting. If not specified a UUID is generated. Note that it is dangerous as in case of client side retries no deduplication will happen based on the generated id. So prefer assigning business meaningful ids if possible.

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

{@link WorkflowIdConflictPolicy.WORKFLOW_ID_CONFLICT_POLICY_UNSPECIFIED}

Inherited from​

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

{@link WorkflowIdReusePolicy.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE}

Inherited from​

CommonWorkflowOptions.workflowIdReusePolicy

workflowRunTimeout​

• Optional workflowRunTimeout: Duration

The time after which workflow run is automatically terminated by Temporal service. Do not rely on run timeout for business level timeouts. It is preferred to use in workflow timers for this purpose.

Format

number of milliseconds or ms-formatted string

Inherited from​

CommonWorkflowOptions.workflowRunTimeout

workflowTaskTimeout​

• Optional workflowTaskTimeout: Duration

Maximum execution time of a single workflow task. Default is 10 seconds.

Format

number of milliseconds or ms-formatted string

Inherited from​

CommonWorkflowOptions.workflowTaskTimeout