Skip to main content

Class: ChildWorkflowExecutionFailedEventAttributes

history.v1.ChildWorkflowExecutionFailedEventAttributes

Represents a ChildWorkflowExecutionFailedEventAttributes.

Properties​

failure​

• Optional failure: null | $Properties

ChildWorkflowExecutionFailedEventAttributes failure.


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

ChildWorkflowExecutionFailedEventAttributes namespaceId.


retryState​

• retryState: RetryState

ChildWorkflowExecutionFailedEventAttributes retryState.


startedEventId​

• startedEventId: Long

Id of the CHILD_WORKFLOW_EXECUTION_STARTED event which this event corresponds to


workflowExecution​

• Optional workflowExecution: null | $Properties

ChildWorkflowExecutionFailedEventAttributes workflowExecution.


workflowType​

• Optional workflowType: null | $Properties

ChildWorkflowExecutionFailedEventAttributes workflowType.

Methods​

toJSON​

▸ toJSON(): Object

Converts this ChildWorkflowExecutionFailedEventAttributes to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): ChildWorkflowExecutionFailedEventAttributes & $Shape

Creates a new ChildWorkflowExecutionFailedEventAttributes instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

ChildWorkflowExecutionFailedEventAttributes & $Shape

ChildWorkflowExecutionFailedEventAttributes instance

▸ create(properties?): ChildWorkflowExecutionFailedEventAttributes

Parameters​

NameType
properties?$Properties

Returns​

ChildWorkflowExecutionFailedEventAttributes


decode​

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

Decodes a ChildWorkflowExecutionFailedEventAttributes message from the specified reader or buffer.

Parameters​

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

Returns​

ChildWorkflowExecutionFailedEventAttributes & $Shape

ChildWorkflowExecutionFailedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): ChildWorkflowExecutionFailedEventAttributes & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

ChildWorkflowExecutionFailedEventAttributes & $Shape

ChildWorkflowExecutionFailedEventAttributes

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): ChildWorkflowExecutionFailedEventAttributes

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

ChildWorkflowExecutionFailedEventAttributes

ChildWorkflowExecutionFailedEventAttributes


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageChildWorkflowExecutionFailedEventAttributesChildWorkflowExecutionFailedEventAttributes
options?IConversionOptionsConversion options

Returns​

Object

Plain object