Skip to main content

Interface: CodeWorkflowOptions

Options of wf.codeWorkflow.

Extends​

Properties​

after?​

optional after?: AfterInput | readonly AfterInput[]

Inherited from​

NodeOptions.after


args?​

optional args?: ArgsOf<Record<string, Json>>

Inherited from​

NodeOptions.args


connection?​

optional connection?: string | readonly string[]

Connection name(s), resolved to connection ids at push time.

Inherited from​

NodeOptions.connection


connections?​

optional connections?: readonly ConnectionRef[]

Connection references by id, written as they are.

Inherited from​

NodeOptions.connections


context?​

optional context?: JsonObject

args.context, written as it is.

Inherited from​

NodeOptions.context


credentials?​

optional credentials?: readonly LegacyCredentialRef[]

Legacy credential references (args.credentials), written as they are.

Inherited from​

NodeOptions.credentials


disabled?​

optional disabled?: boolean

Inherited from​

NodeOptions.disabled


errorConfig?​

optional errorConfig?: NodeErrorConfig

The whole error policy, written as it is (instead of retry / timeout / onError).

Inherited from​

NodeOptions.errorConfig


executionSettings?​

optional executionSettings?: ExecutionSettings

Inherited from​

NodeOptions.executionSettings


extra?​

optional extra?: JsonObject

Other node fields, deep-merged into the node verbatim.

Inherited from​

NodeOptions.extra


failOnError?​

optional failOnError?: boolean


id?​

optional id?: string

Node id. Required (stable ids keep layout and pinned data across builds).

Inherited from​

NodeOptions.id


input?​

optional input?: ArgValue

inputMapping; default passthrough.


label?​

optional label?: string

Inherited from​

NodeOptions.label


onError?​

optional onError?: OnErrorOption

Inherited from​

NodeOptions.onError


operation?​

optional operation?: string | false

operation_name override; false writes none.

Inherited from​

NodeOptions.operation


parentClosePolicy?​

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

Default (DB13, applied by the service when absent): TERMINATE when the node waits for completion, ABANDON when it does not.


retry?​

optional retry?: RetryConfig

Inherited from​

NodeOptions.retry


taskQueue?​

optional taskQueue?: string

Default managed, the platform's queue.


timeout?​

optional timeout?: NodeTimeout

Inherited from​

NodeOptions.timeout


timeoutSeconds?​

optional timeoutSeconds?: number

Node-level timeout in seconds; 0 or absent means none.


version?​

optional version?: string | false

Node package version override; false writes none.

Inherited from​

NodeOptions.version


waitForCompletion?​

optional waitForCompletion?: boolean

Default true.