Class: StartChildWorkflowExecutionCommandAttributes

command.v1.StartChildWorkflowExecutionCommandAttributes

Represents a StartChildWorkflowExecutionCommandAttributes.

Properties

control

• control: string

StartChildWorkflowExecutionCommandAttributes control.

---

cronSchedule

• cronSchedule: string

Establish a cron schedule for the child workflow.

---

header

• Optional header: null | $Properties

StartChildWorkflowExecutionCommandAttributes header.

---

inheritBuildId

• inheritBuildId: boolean

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: null | $Properties

StartChildWorkflowExecutionCommandAttributes input.

---

memo

• Optional memo: null | $Properties

StartChildWorkflowExecutionCommandAttributes memo.

---

namespace

• namespace: string

Deprecated. Cross-namespace operations are disabled by default as of server 1.30.1.

---

parentClosePolicy

• parentClosePolicy: ParentClosePolicy

Default: PARENT_CLOSE_POLICY_TERMINATE.

---

priority

• Optional priority: null | $Properties

Priority metadata. If this message is not present, or any fields are not present, they inherit the values from the workflow.

---

retryPolicy

• Optional retryPolicy: null | $Properties

StartChildWorkflowExecutionCommandAttributes retryPolicy.

---

searchAttributes

• Optional searchAttributes: null | $Properties

StartChildWorkflowExecutionCommandAttributes searchAttributes.

---

taskQueue

• Optional taskQueue: null | $Properties

StartChildWorkflowExecutionCommandAttributes taskQueue.

---

versioningOverride

• Optional versioningOverride: null | $Properties

Versioning override for the child workflow. If present, this explicit override takes precedence over versioning behavior inherited from the parent workflow.

---

workflowExecutionTimeout

• Optional workflowExecutionTimeout: null | $Properties

Total workflow execution timeout including retries and continue as new.

---

workflowId

• workflowId: string

StartChildWorkflowExecutionCommandAttributes workflowId.

---

workflowIdReusePolicy

• workflowIdReusePolicy: WorkflowIdReusePolicy

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

• Optional workflowType: null | $Properties

StartChildWorkflowExecutionCommandAttributes workflowType.

Methods

toJSON

▸ toJSON(): Object

Converts this StartChildWorkflowExecutionCommandAttributes to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): StartChildWorkflowExecutionCommandAttributes & $Shape

Creates a new StartChildWorkflowExecutionCommandAttributes instance using the specified properties.

Parameters

Name	Type	Description
properties?	$Shape	Properties to set

Returns

StartChildWorkflowExecutionCommandAttributes & $Shape

StartChildWorkflowExecutionCommandAttributes instance

▸ create(properties?): StartChildWorkflowExecutionCommandAttributes

Parameters

Name	Type
properties?	$Properties

Returns

StartChildWorkflowExecutionCommandAttributes

---

decode

▸ decode(reader, length?): StartChildWorkflowExecutionCommandAttributes & $Shape

Decodes a StartChildWorkflowExecutionCommandAttributes 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

StartChildWorkflowExecutionCommandAttributes & $Shape

StartChildWorkflowExecutionCommandAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): StartChildWorkflowExecutionCommandAttributes & $Shape

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

Parameters

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

Returns

StartChildWorkflowExecutionCommandAttributes & $Shape

StartChildWorkflowExecutionCommandAttributes

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 StartChildWorkflowExecutionCommandAttributes message. Does not implicitly temporal.api.command.v1.StartChildWorkflowExecutionCommandAttributes.verify|verify messages.

Parameters

Name	Type	Description
message	$Properties	StartChildWorkflowExecutionCommandAttributes message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

Encodes the specified StartChildWorkflowExecutionCommandAttributes message, length delimited. Does not implicitly temporal.api.command.v1.StartChildWorkflowExecutionCommandAttributes.verify|verify messages.

Parameters

Name	Type	Description
message	$Properties	StartChildWorkflowExecutionCommandAttributes message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): StartChildWorkflowExecutionCommandAttributes

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

StartChildWorkflowExecutionCommandAttributes

StartChildWorkflowExecutionCommandAttributes

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	StartChildWorkflowExecutionCommandAttributes	StartChildWorkflowExecutionCommandAttributes
options?	IConversionOptions	Conversion options

Returns

Object

Plain object