Class: StartChildWorkflowExecutionInitiatedEventAttributes

history.v1.StartChildWorkflowExecutionInitiatedEventAttributes

Represents a StartChildWorkflowExecutionInitiatedEventAttributes.

Properties

control

• control: string

Deprecated.

---

cronSchedule

• cronSchedule: string

If this child runs on a cron schedule, it will appear here

---

header

• Optional header: null | $Properties

StartChildWorkflowExecutionInitiatedEventAttributes 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

StartChildWorkflowExecutionInitiatedEventAttributes input.

---

memo

• Optional memo: null | $Properties

StartChildWorkflowExecutionInitiatedEventAttributes memo.

---

namespace

• namespace: string

Namespace of the child workflow. SDKs and UI tools should use namespace field but server must use namespace_id only.

---

namespaceId

• namespaceId: string

StartChildWorkflowExecutionInitiatedEventAttributes namespaceId.

---

parentClosePolicy

• parentClosePolicy: ParentClosePolicy

Default: PARENT_CLOSE_POLICY_TERMINATE.

---

priority

• Optional priority: null | $Properties

Priority metadata

---

retryPolicy

• Optional retryPolicy: null | $Properties

StartChildWorkflowExecutionInitiatedEventAttributes retryPolicy.

---

searchAttributes

• Optional searchAttributes: null | $Properties

StartChildWorkflowExecutionInitiatedEventAttributes searchAttributes.

---

taskQueue

• Optional taskQueue: null | $Properties

StartChildWorkflowExecutionInitiatedEventAttributes taskQueue.

---

timeSkippingConfig

• Optional timeSkippingConfig: null | $Properties

The propagated time-skipping configuration for the child workflow.

---

timeSkippingStatePropagation

• Optional timeSkippingStatePropagation: null | $Properties

The time-skipping state propagated from the parent workflow. This can be nil if no time skipping has occurred or there is no previous run.

---

versioningOverride

• Optional versioningOverride: null | $Properties

Versioning override requested 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

StartChildWorkflowExecutionInitiatedEventAttributes workflowId.

---

workflowIdReusePolicy

• workflowIdReusePolicy: WorkflowIdReusePolicy

Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

---

workflowRunTimeout

• Optional workflowRunTimeout: null | $Properties

Timeout of a single workflow run.

---

workflowTaskCompletedEventId

• workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

---

workflowTaskTimeout

• Optional workflowTaskTimeout: null | $Properties

Timeout of a single workflow task.

---

workflowType

• Optional workflowType: null | $Properties

StartChildWorkflowExecutionInitiatedEventAttributes workflowType.

Methods

toJSON

▸ toJSON(): Object

Converts this StartChildWorkflowExecutionInitiatedEventAttributes to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): StartChildWorkflowExecutionInitiatedEventAttributes & $Shape

Creates a new StartChildWorkflowExecutionInitiatedEventAttributes instance using the specified properties.

Parameters

Name	Type	Description
properties?	$Shape	Properties to set

Returns

StartChildWorkflowExecutionInitiatedEventAttributes & $Shape

StartChildWorkflowExecutionInitiatedEventAttributes instance

▸ create(properties?): StartChildWorkflowExecutionInitiatedEventAttributes

Parameters

Name	Type
properties?	$Properties

Returns

StartChildWorkflowExecutionInitiatedEventAttributes

---

decode

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

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

StartChildWorkflowExecutionInitiatedEventAttributes & $Shape

StartChildWorkflowExecutionInitiatedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): StartChildWorkflowExecutionInitiatedEventAttributes & $Shape

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

Parameters

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

Returns

StartChildWorkflowExecutionInitiatedEventAttributes & $Shape

StartChildWorkflowExecutionInitiatedEventAttributes

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

Parameters

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

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): StartChildWorkflowExecutionInitiatedEventAttributes

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

StartChildWorkflowExecutionInitiatedEventAttributes

StartChildWorkflowExecutionInitiatedEventAttributes

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	StartChildWorkflowExecutionInitiatedEventAttributes	StartChildWorkflowExecutionInitiatedEventAttributes
options?	IConversionOptions	Conversion options

Returns

Object

Plain object