Skip to main content

Class: StartChildWorkflowExecutionFailedEventAttributes

history.v1.StartChildWorkflowExecutionFailedEventAttributes

Represents a StartChildWorkflowExecutionFailedEventAttributes.

Properties​

cause​

• cause: StartChildWorkflowExecutionFailedCause

StartChildWorkflowExecutionFailedEventAttributes cause.


control​

• control: string

Deprecated.


initiatedEventId​

• initiatedEventId: Long

Id of the START_CHILD_WORKFLOW_EXECUTION_INITIATED event which this event corresponds to


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

StartChildWorkflowExecutionFailedEventAttributes namespaceId.


workflowId​

• workflowId: string

StartChildWorkflowExecutionFailedEventAttributes workflowId.


workflowTaskCompletedEventId​

• workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with


workflowType​

• Optional workflowType: null | $Properties

StartChildWorkflowExecutionFailedEventAttributes workflowType.

Methods​

toJSON​

▸ toJSON(): Object

Converts this StartChildWorkflowExecutionFailedEventAttributes to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): StartChildWorkflowExecutionFailedEventAttributes & $Properties

Creates a new StartChildWorkflowExecutionFailedEventAttributes instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

StartChildWorkflowExecutionFailedEventAttributes & $Properties

StartChildWorkflowExecutionFailedEventAttributes instance

▸ create(properties?): StartChildWorkflowExecutionFailedEventAttributes

Parameters​

NameType
properties?$Properties

Returns​

StartChildWorkflowExecutionFailedEventAttributes


decode​

▸ decode(reader, length?): StartChildWorkflowExecutionFailedEventAttributes & $Properties

Decodes a StartChildWorkflowExecutionFailedEventAttributes message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

StartChildWorkflowExecutionFailedEventAttributes & $Properties

StartChildWorkflowExecutionFailedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): StartChildWorkflowExecutionFailedEventAttributes & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

StartChildWorkflowExecutionFailedEventAttributes & $Properties

StartChildWorkflowExecutionFailedEventAttributes

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

Parameters​

NameTypeDescription
message$PropertiesStartChildWorkflowExecutionFailedEventAttributes message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesStartChildWorkflowExecutionFailedEventAttributes message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): StartChildWorkflowExecutionFailedEventAttributes

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

StartChildWorkflowExecutionFailedEventAttributes

StartChildWorkflowExecutionFailedEventAttributes


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageStartChildWorkflowExecutionFailedEventAttributesStartChildWorkflowExecutionFailedEventAttributes
options?IConversionOptionsConversion options

Returns​

Object

Plain object