Skip to main content

Class: ActivityTaskFailedEventAttributes

history.v1.ActivityTaskFailedEventAttributes

Represents an ActivityTaskFailedEventAttributes.

Properties​

cause​

• cause: ActivityTaskFailedCause

Why did the task fail? When unset, the failure is treated as an unspecified activity failure.


failure​

• Optional failure: null | $Properties

Failure details


identity​

• identity: string

id of the worker that failed this task


retryState​

• retryState: RetryState

ActivityTaskFailedEventAttributes retryState.


scheduledEventId​

• scheduledEventId: Long

The id of the ACTIVITY_TASK_SCHEDULED event this failure corresponds to


startedEventId​

• startedEventId: Long

The id of the ACTIVITY_TASK_STARTED event this failure corresponds to


workerVersion​

• Optional workerVersion: null | $Properties

Version info of the worker who processed this workflow task. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

Methods​

toJSON​

▸ toJSON(): Object

Converts this ActivityTaskFailedEventAttributes to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): ActivityTaskFailedEventAttributes & $Shape

Creates a new ActivityTaskFailedEventAttributes instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

ActivityTaskFailedEventAttributes & $Shape

ActivityTaskFailedEventAttributes instance

▸ create(properties?): ActivityTaskFailedEventAttributes

Parameters​

NameType
properties?$Properties

Returns​

ActivityTaskFailedEventAttributes


decode​

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

Decodes an ActivityTaskFailedEventAttributes message from the specified reader or buffer.

Parameters​

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

Returns​

ActivityTaskFailedEventAttributes & $Shape

ActivityTaskFailedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): ActivityTaskFailedEventAttributes & $Shape

Decodes an ActivityTaskFailedEventAttributes message from the specified reader or buffer, length delimited.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

ActivityTaskFailedEventAttributes & $Shape

ActivityTaskFailedEventAttributes

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): ActivityTaskFailedEventAttributes

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

ActivityTaskFailedEventAttributes

ActivityTaskFailedEventAttributes


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageActivityTaskFailedEventAttributesActivityTaskFailedEventAttributes
options?IConversionOptionsConversion options

Returns​

Object

Plain object