Skip to main content

Class: StartChildWorkflowExecution

Start a child workflow execution

Properties​

cancellationType​

cancellationType: ChildWorkflowCancellationType

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

cronSchedule​

cronSchedule: string

StartChildWorkflowExecution cronSchedule.

headers​

headers: object

Header fields

Index Signature​

[k: string]: $Properties

input​

input: $Properties[]

StartChildWorkflowExecution input.

memo​

memo: object

Memo fields

Index Signature​

[k: string]: $Properties

namespace​

namespace: string

StartChildWorkflowExecution namespace.

parentClosePolicy​

parentClosePolicy: ParentClosePolicy

Default: PARENT_CLOSE_POLICY_TERMINATE.

priority?​

optional priority?: $Properties | null

The Priority to use for this activity

retryPolicy?​

optional retryPolicy?: $Properties | null

StartChildWorkflowExecution retryPolicy.

searchAttributes?​

optional searchAttributes?: $Properties | null

Search attributes

seq​

seq: number

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

taskQueue​

taskQueue: string

StartChildWorkflowExecution taskQueue.

versioningIntent​

versioningIntent: VersioningIntent

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

versioningOverride?​

optional versioningOverride?: $Properties | null

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

workflowExecutionTimeout?​

optional workflowExecutionTimeout?: $Properties | null

Total workflow execution timeout including retries and continue as new.

workflowId​

workflowId: string

StartChildWorkflowExecution workflowId.

workflowIdReusePolicy​

workflowIdReusePolicy: WorkflowIdReusePolicy

string control = 11; (unused from StartChildWorkflowExecutionCommandAttributes) 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​

workflowType: string

StartChildWorkflowExecution workflowType.

Methods​

toJSON()​

toJSON(): object

Converts this StartChildWorkflowExecution to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): StartChildWorkflowExecution & $Shape

Creates a new StartChildWorkflowExecution instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

StartChildWorkflowExecution & $Shape

StartChildWorkflowExecution instance

Call Signature​

static create(properties?): StartChildWorkflowExecution

Creates a new StartChildWorkflowExecution instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StartChildWorkflowExecution

StartChildWorkflowExecution instance

decode()​

static decode(reader, length?): StartChildWorkflowExecution & $Shape

Decodes a StartChildWorkflowExecution message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

StartChildWorkflowExecution & $Shape

StartChildWorkflowExecution

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): StartChildWorkflowExecution & $Shape

Decodes a StartChildWorkflowExecution message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

StartChildWorkflowExecution & $Shape

StartChildWorkflowExecution

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified StartChildWorkflowExecution message. Does not implicitly coresdk.workflow_commands.StartChildWorkflowExecution.verify|verify messages.

Parameters​

message​

$Properties

StartChildWorkflowExecution message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified StartChildWorkflowExecution message, length delimited. Does not implicitly coresdk.workflow_commands.StartChildWorkflowExecution.verify|verify messages.

Parameters​

message​

$Properties

StartChildWorkflowExecution message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): StartChildWorkflowExecution

Creates a StartChildWorkflowExecution message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

StartChildWorkflowExecution

StartChildWorkflowExecution

toObject()​

static toObject(message, options?): object

Creates a plain object from a StartChildWorkflowExecution message. Also converts values to other types if specified.

Parameters​

message​

StartChildWorkflowExecution

StartChildWorkflowExecution

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object