Skip to main content

Interface: $Properties

Properties of a StartChildWorkflowExecutionInitiatedEventAttributes.

Extended by​

Properties​

control?​

optional control?: string | null

Deprecated.

cronSchedule?​

optional cronSchedule?: string | null

If this child runs on a cron schedule, it will appear here

optional header?: $Properties | null

StartChildWorkflowExecutionInitiatedEventAttributes 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

StartChildWorkflowExecutionInitiatedEventAttributes input

memo?​

optional memo?: $Properties | null

StartChildWorkflowExecutionInitiatedEventAttributes memo

namespace?​

optional namespace?: string | null

Namespace of the child workflow. SDKs and UI tools should use namespace field but server must use namespace_id only.

namespaceId?​

optional namespaceId?: string | null

StartChildWorkflowExecutionInitiatedEventAttributes namespaceId

parentClosePolicy?​

optional parentClosePolicy?: ParentClosePolicy | null

Default: PARENT_CLOSE_POLICY_TERMINATE.

priority?​

optional priority?: $Properties | null

Priority metadata

retryPolicy?​

optional retryPolicy?: $Properties | null

StartChildWorkflowExecutionInitiatedEventAttributes retryPolicy

searchAttributes?​

optional searchAttributes?: $Properties | null

StartChildWorkflowExecutionInitiatedEventAttributes searchAttributes

taskQueue?​

optional taskQueue?: $Properties | null

StartChildWorkflowExecutionInitiatedEventAttributes taskQueue

timeSkippingConfig?​

optional timeSkippingConfig?: $Properties | null

The propagated time-skipping configuration for the child workflow.

timeSkippingStatePropagation?​

optional timeSkippingStatePropagation?: $Properties | null

The time-skipping state propagated from the parent workflow. This can be nil if no time skipping has occurred or there is no previous run.

versioningOverride?​

optional versioningOverride?: $Properties | null

Versioning override requested 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

StartChildWorkflowExecutionInitiatedEventAttributes workflowId

workflowIdReusePolicy?​

optional workflowIdReusePolicy?: WorkflowIdReusePolicy | null

Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

workflowRunTimeout?​

optional workflowRunTimeout?: $Properties | null

Timeout of a single workflow run.

workflowTaskCompletedEventId?​

optional workflowTaskCompletedEventId?: Long | null

The WORKFLOW_TASK_COMPLETED event which this command was reported with

workflowTaskTimeout?​

optional workflowTaskTimeout?: $Properties | null

Timeout of a single workflow task.

workflowType?​

optional workflowType?: $Properties | null

StartChildWorkflowExecutionInitiatedEventAttributes workflowType