Skip to main content

Interface: IStartChildWorkflowExecution

Properties of a StartChildWorkflowExecution.

Extends​

Properties​

cancellationType?​

optional cancellationType?: ChildWorkflowCancellationType | null

Defines behaviour of the underlying workflow when child workflow cancellation has been requested.

Inherited from​

$Properties.cancellationType

cronSchedule?​

optional cronSchedule?: string | null

StartChildWorkflowExecution cronSchedule

Inherited from​

$Properties.cronSchedule

headers?​

optional headers?: {[k: string]: $Properties; } | null

Header fields

Inherited from​

$Properties.headers

input?​

optional input?: $Properties[] | null

StartChildWorkflowExecution input

Inherited from​

$Properties.input

memo?​

optional memo?: {[k: string]: $Properties; } | null

Memo fields

Inherited from​

$Properties.memo

namespace?​

optional namespace?: string | null

StartChildWorkflowExecution namespace

Inherited from​

$Properties.namespace

parentClosePolicy?​

optional parentClosePolicy?: ParentClosePolicy | null

Default: PARENT_CLOSE_POLICY_TERMINATE.

Inherited from​

$Properties.parentClosePolicy

priority?​

optional priority?: $Properties | null

The Priority to use for this activity

Inherited from​

$Properties.priority

retryPolicy?​

optional retryPolicy?: $Properties | null

StartChildWorkflowExecution retryPolicy

Inherited from​

$Properties.retryPolicy

searchAttributes?​

optional searchAttributes?: $Properties | null

Search attributes

Inherited from​

$Properties.searchAttributes

seq?​

optional seq?: number | null

Lang's incremental sequence number, used as the operation identifier

Inherited from​

$Properties.seq

taskQueue?​

optional taskQueue?: string | null

StartChildWorkflowExecution taskQueue

Inherited from​

$Properties.taskQueue

versioningIntent?​

optional versioningIntent?: VersioningIntent | null

Whether this child should run on a worker with a compatible build id or not.

Inherited from​

$Properties.versioningIntent

versioningOverride?​

optional versioningOverride?: $Properties | null

Allows routing the child independently of the parent's worker deployment version. Requires Temporal Server 1.32+.

Inherited from​

$Properties.versioningOverride

workflowExecutionTimeout?​

optional workflowExecutionTimeout?: $Properties | null

Total workflow execution timeout including retries and continue as new.

Inherited from​

$Properties.workflowExecutionTimeout

workflowId?​

optional workflowId?: string | null

StartChildWorkflowExecution workflowId

Inherited from​

$Properties.workflowId

workflowIdReusePolicy?​

optional workflowIdReusePolicy?: WorkflowIdReusePolicy | null

string control = 11; (unused from StartChildWorkflowExecutionCommandAttributes) Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

Inherited from​

$Properties.workflowIdReusePolicy

workflowRunTimeout?​

optional workflowRunTimeout?: $Properties | null

Timeout of a single workflow run.

Inherited from​

$Properties.workflowRunTimeout

workflowTaskTimeout?​

optional workflowTaskTimeout?: $Properties | null

Timeout of a single workflow task.

Inherited from​

$Properties.workflowTaskTimeout

workflowType?​

optional workflowType?: string | null

StartChildWorkflowExecution workflowType

Inherited from​

$Properties.workflowType