Skip to main content

Interface: $Properties

Properties of a StartChildWorkflowExecutionCommandAttributes.

Extended by​

Properties​

control?​

optional control?: string | null

StartChildWorkflowExecutionCommandAttributes control

cronSchedule?​

optional cronSchedule?: string | null

Establish a cron schedule for the child workflow.

optional header?: $Properties | null

StartChildWorkflowExecutionCommandAttributes header

inheritBuildId?​

optional inheritBuildId?: boolean | null

If this is set, the child workflow inherits the Build ID of the parent. Otherwise, the assignment rules of the child's Task Queue will be used to independently assign a Build ID to it. Deprecated. Only considered for versioning v0.2.

input?​

optional input?: $Properties | null

StartChildWorkflowExecutionCommandAttributes input

memo?​

optional memo?: $Properties | null

StartChildWorkflowExecutionCommandAttributes memo

namespace?​

optional namespace?: string | null

Deprecated. Cross-namespace operations are disabled by default as of server 1.30.1.

parentClosePolicy?​

optional parentClosePolicy?: ParentClosePolicy | null

Default: PARENT_CLOSE_POLICY_TERMINATE.

priority?​

optional priority?: $Properties | null

Priority metadata. If this message is not present, or any fields are not present, they inherit the values from the workflow.

retryPolicy?​

optional retryPolicy?: $Properties | null

StartChildWorkflowExecutionCommandAttributes retryPolicy

searchAttributes?​

optional searchAttributes?: $Properties | null

StartChildWorkflowExecutionCommandAttributes searchAttributes

taskQueue?​

optional taskQueue?: $Properties | null

StartChildWorkflowExecutionCommandAttributes taskQueue

versioningOverride?​

optional versioningOverride?: $Properties | null

Versioning override for the child workflow. If present, this explicit override takes precedence over versioning behavior inherited from the parent workflow.

workflowExecutionTimeout?​

optional workflowExecutionTimeout?: $Properties | null

Total workflow execution timeout including retries and continue as new.

workflowId?​

optional workflowId?: string | null

StartChildWorkflowExecutionCommandAttributes workflowId

workflowIdReusePolicy?​

optional workflowIdReusePolicy?: WorkflowIdReusePolicy | null

Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

workflowRunTimeout?​

optional workflowRunTimeout?: $Properties | null

Timeout of a single workflow run.

workflowTaskTimeout?​

optional workflowTaskTimeout?: $Properties | null

Timeout of a single workflow task.

workflowType?​

optional workflowType?: $Properties | null

StartChildWorkflowExecutionCommandAttributes workflowType