Class: StartChildWorkflowExecution

coresdk.workflow_commands.StartChildWorkflowExecution

Start a child workflow execution

Implements

• IStartChildWorkflowExecution

Constructors

constructor

• new StartChildWorkflowExecution(properties?): StartChildWorkflowExecution

Constructs a new StartChildWorkflowExecution.

Parameters

Name	Type	Description
properties?	IStartChildWorkflowExecution	Properties to set

Returns

StartChildWorkflowExecution

Properties

cancellationType

• cancellationType: ChildWorkflowCancellationType

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

Implementation of

IStartChildWorkflowExecution.cancellationType

---

cronSchedule

• cronSchedule: string

StartChildWorkflowExecution cronSchedule.

Implementation of

IStartChildWorkflowExecution.cronSchedule

---

headers

• headers: Object

Header fields

Index signature

▪ [k: string]: IPayload

Implementation of

IStartChildWorkflowExecution.headers

---

input

• input: IPayload[]

StartChildWorkflowExecution input.

Implementation of

IStartChildWorkflowExecution.input

---

memo

• memo: Object

Memo fields

Index signature

▪ [k: string]: IPayload

Implementation of

IStartChildWorkflowExecution.memo

---

namespace

• namespace: string

StartChildWorkflowExecution namespace.

Implementation of

IStartChildWorkflowExecution.namespace

---

parentClosePolicy

• parentClosePolicy: ParentClosePolicy

Default: PARENT_CLOSE_POLICY_TERMINATE.

Implementation of

IStartChildWorkflowExecution.parentClosePolicy

---

retryPolicy

• Optional retryPolicy: null | IRetryPolicy

StartChildWorkflowExecution retryPolicy.

Implementation of

IStartChildWorkflowExecution.retryPolicy

---

searchAttributes

• searchAttributes: Object

Search attributes

Index signature

▪ [k: string]: IPayload

Implementation of

IStartChildWorkflowExecution.searchAttributes

---

seq

• seq: number

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

Implementation of

IStartChildWorkflowExecution.seq

---

taskQueue

• taskQueue: string

StartChildWorkflowExecution taskQueue.

Implementation of

IStartChildWorkflowExecution.taskQueue

---

versioningIntent

• versioningIntent: VersioningIntent

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

Implementation of

IStartChildWorkflowExecution.versioningIntent

---

workflowExecutionTimeout

• Optional workflowExecutionTimeout: null | IDuration

Total workflow execution timeout including retries and continue as new.

Implementation of

IStartChildWorkflowExecution.workflowExecutionTimeout

---

workflowId

• workflowId: string

StartChildWorkflowExecution workflowId.

Implementation of

IStartChildWorkflowExecution.workflowId

---

workflowIdReusePolicy

• workflowIdReusePolicy: WorkflowIdReusePolicy

string control = 11; (unused from StartChildWorkflowExecutionCommandAttributes) Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

Implementation of

IStartChildWorkflowExecution.workflowIdReusePolicy

---

workflowRunTimeout

• Optional workflowRunTimeout: null | IDuration

Timeout of a single workflow run.

Implementation of

IStartChildWorkflowExecution.workflowRunTimeout

---

workflowTaskTimeout

• Optional workflowTaskTimeout: null | IDuration

Timeout of a single workflow task.

Implementation of

IStartChildWorkflowExecution.workflowTaskTimeout

---

workflowType

• workflowType: string

StartChildWorkflowExecution workflowType.

Implementation of

IStartChildWorkflowExecution.workflowType

Methods

toJSON

▸ toJSON(): Object

Converts this StartChildWorkflowExecution to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): StartChildWorkflowExecution

Creates a new StartChildWorkflowExecution instance using the specified properties.

Parameters

Name	Type	Description
properties?	IStartChildWorkflowExecution	Properties to set

Returns

StartChildWorkflowExecution

StartChildWorkflowExecution instance

---

decode

▸ decode(reader, length?): StartChildWorkflowExecution

Decodes a StartChildWorkflowExecution message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

StartChildWorkflowExecution

StartChildWorkflowExecution

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): StartChildWorkflowExecution

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

StartChildWorkflowExecution

StartChildWorkflowExecution

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IStartChildWorkflowExecution	StartChildWorkflowExecution message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IStartChildWorkflowExecution	StartChildWorkflowExecution message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): StartChildWorkflowExecution

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

StartChildWorkflowExecution

StartChildWorkflowExecution

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for StartChildWorkflowExecution

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	StartChildWorkflowExecution	StartChildWorkflowExecution
options?	IConversionOptions	Conversion options

Returns

Object

Plain object