Class: StartChildWorkflowExecution
coresdk.workflow_commands.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: null | $Properties
The Priority to use for this activity
retryPolicy
• Optional retryPolicy: null | $Properties
StartChildWorkflowExecution retryPolicy.
searchAttributes
• Optional searchAttributes: null | $Properties
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.
workflowExecutionTimeout
• Optional workflowExecutionTimeout: null | $Properties
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: null | $Properties
Timeout of a single workflow run.
workflowTaskTimeout
• Optional workflowTaskTimeout: null | $Properties
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
▸ create(properties?): StartChildWorkflowExecution & $Properties
Creates a new StartChildWorkflowExecution instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
StartChildWorkflowExecution & $Properties
StartChildWorkflowExecution instance
▸ create(properties?): StartChildWorkflowExecution
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): StartChildWorkflowExecution & $Properties
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 & $Properties
StartChildWorkflowExecution
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): StartChildWorkflowExecution & $Properties
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 & $Properties
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 | $Properties | 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 | $Properties | 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
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