Skip to main content

Interface: ChildWorkflowOptions

workflow.ChildWorkflowOptions

Hierarchy​

Properties​

cancellationType​

• Optional cancellationType: ChildWorkflowCancellationType

Determines:

  • whether cancellation requests should be propagated from the Parent Workflow to the Child, and
  • whether and when should the Child's cancellation be reported back to the Parent Workflow (i.e. at which moment should the executeChild's or ChildWorkflowHandle.result's promise fail with a ChildWorkflowFailure, with cause set to a CancelledFailure).

Note that this setting only applies to cancellation originating from an external request for the Parent Workflow itself, or from internal cancellation of the CancellationScope in which the Child Workflow call was made. Eventual Cancellation of a Child Workflow on completion of the Parent Workflow is controlled by the ParentClosePolicy setting.

Default

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​

Omit.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​

Omit.memo

parentClosePolicy​

• Optional parentClosePolicy: ParentClosePolicy

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

Default

ParentClosePolicy.PARENT_CLOSE_POLICY_TERMINATE

priority​

• Optional priority: Priority

Priority of a workflow

Inherited from​

Omit.priority

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​

Omit.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​

Omit.searchAttributes

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.

User metadata is a new API and susceptible to change.

Inherited from​

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

User metadata is a new API and susceptible to change.

Inherited from​

Omit.staticSummary

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.

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​

Omit.typedSearchAttributes

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'

Deprecated

Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments

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​

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

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​

Omit.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​

Omit.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​

Omit.workflowTaskTimeout