Skip to main content

Class: StartChildWorkflowExecution

coresdk.workflow_commands.StartChildWorkflowExecution

Start a child workflow execution

Implements#

Constructors#

constructor#

new StartChildWorkflowExecution(properties?)

Constructs a new StartChildWorkflowExecution.

Parameters#

NameType
properties?IStartChildWorkflowExecution

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


header#

header: Object

Header fields

Index signature#

▪ [k: string]: IPayload

Implementation of#

IStartChildWorkflowExecution.header


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


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

StartChildWorkflowExecution workflowIdReusePolicy.

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


decode#

Static decode(reader, length?): StartChildWorkflowExecution

Decodes a StartChildWorkflowExecution message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

StartChildWorkflowExecution

StartChildWorkflowExecution


decodeDelimited#

Static decodeDelimited(reader): StartChildWorkflowExecution

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

StartChildWorkflowExecution

StartChildWorkflowExecution


encode#

Static encode(message, writer?): Writer

Encodes the specified StartChildWorkflowExecution message. Does not implicitly {@link coresdk.workflow_commands.StartChildWorkflowExecution.verify|verify} messages.

Parameters#

NameTypeDescription
messageIStartChildWorkflowExecutionStartChildWorkflowExecution message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

NameTypeDescription
messageIStartChildWorkflowExecutionStartChildWorkflowExecution message or plain object to encode
writer?Writer-

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#

NameTypeDescription
objectObjectPlain 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#

NameTypeDescription
messageStartChildWorkflowExecutionStartChildWorkflowExecution
options?IConversionOptions-

Returns#

Object

Plain object