Skip to main content

Class: StartChildWorkflowExecutionInitiatedEventAttributes

Represents a StartChildWorkflowExecutionInitiatedEventAttributes.

Properties​

control​

control: string

Deprecated.

cronSchedule​

cronSchedule: string

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

optional header?: $Properties | null

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

StartChildWorkflowExecutionInitiatedEventAttributes input.

memo?​

optional memo?: $Properties | null

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

Priority metadata

retryPolicy?​

optional retryPolicy?: $Properties | null

StartChildWorkflowExecutionInitiatedEventAttributes retryPolicy.

searchAttributes?​

optional searchAttributes?: $Properties | null

StartChildWorkflowExecutionInitiatedEventAttributes searchAttributes.

taskQueue?​

optional taskQueue?: $Properties | null

StartChildWorkflowExecutionInitiatedEventAttributes taskQueue.

timeSkippingConfig?​

optional timeSkippingConfig?: $Properties | null

The propagated time-skipping configuration for the child workflow.

timeSkippingStatePropagation?​

optional timeSkippingStatePropagation?: $Properties | null

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

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

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

Timeout of a single workflow run.

workflowTaskCompletedEventId​

workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

workflowTaskTimeout?​

optional workflowTaskTimeout?: $Properties | null

Timeout of a single workflow task.

workflowType?​

optional workflowType?: $Properties | null

StartChildWorkflowExecutionInitiatedEventAttributes workflowType.

Methods​

toJSON()​

toJSON(): object

Converts this StartChildWorkflowExecutionInitiatedEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): StartChildWorkflowExecutionInitiatedEventAttributes & $Shape

Creates a new StartChildWorkflowExecutionInitiatedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

StartChildWorkflowExecutionInitiatedEventAttributes & $Shape

StartChildWorkflowExecutionInitiatedEventAttributes instance

Call Signature​

static create(properties?): StartChildWorkflowExecutionInitiatedEventAttributes

Creates a new StartChildWorkflowExecutionInitiatedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StartChildWorkflowExecutionInitiatedEventAttributes

StartChildWorkflowExecutionInitiatedEventAttributes instance

decode()​

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

Decodes a StartChildWorkflowExecutionInitiatedEventAttributes message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static decodeDelimited(reader): StartChildWorkflowExecutionInitiatedEventAttributes & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

StartChildWorkflowExecutionInitiatedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

StartChildWorkflowExecutionInitiatedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): StartChildWorkflowExecutionInitiatedEventAttributes

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

Parameters​

object​

Plain object

Returns​

StartChildWorkflowExecutionInitiatedEventAttributes

StartChildWorkflowExecutionInitiatedEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

StartChildWorkflowExecutionInitiatedEventAttributes

StartChildWorkflowExecutionInitiatedEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object