Skip to main content

Interface: ChildOptions

Options of ctx.child and ctx.startChild (11 §2.35).

Properties​

cancellationType?​

optional cancellationType?: "WAIT_CANCELLATION_COMPLETED" | "WAIT_CANCELLATION_REQUESTED" | "TRY_CANCEL" | "ABANDON"

How the awaitable reacts when its scope is cancelled. Unset, it rejects at once and the child is left to the parent-close policy; set, the SDK sends a cancel request to the child (REQUEST_CANCEL_EXTERNAL_RUN, a parity command).


context?​

optional context?: JsonObject


details?​

optional details?: string


executionTimeout?​

optional executionTimeout?: Duration


fairnessKey?​

optional fairnessKey?: string

Fairness of the child's tasks (11 §2.11).


fairnessWeight?​

optional fairnessWeight?: number


headers?​

optional headers?: Headers


idConflictPolicy?​

optional idConflictPolicy?: "FAIL" | "USE_EXISTING" | "TERMINATE_EXISTING"


idReusePolicy?​

optional idReusePolicy?: "ALLOW_DUPLICATE" | "ALLOW_DUPLICATE_FAILED_ONLY" | "REJECT_DUPLICATE"


input?​

optional input?: unknown


parentClosePolicy?​

optional parentClosePolicy?: "ABANDON" | "TERMINATE" | "REQUEST_CANCEL"

Default TERMINATE for ctx.child, ABANDON for ctx.startChild (DB13).


priority?​

optional priority?: number


retry?​

optional retry?: WorkflowRetryOptions

Run-level retry of the child.


runTimeout?​

optional runTimeout?: Duration


searchAttributes?​

optional searchAttributes?: JsonObject

The child's search attributes at its start (11 §2.35): like a top-level start, the child inherits none from its parent. Needs fluidgrids.search-attributes.


startDelay?​

optional startDelay?: Duration


summary?​

optional summary?: string


taskQueue?​

optional taskQueue?: string


version?​

optional version?: string

active (default), vN or @alias.


versioningBehavior?​

optional versioningBehavior?: "PINNED" | "AUTO_UPGRADE"


workflowId?​

optional workflowId?: string


workflowTaskTimeout?​

optional workflowTaskTimeout?: Duration