Skip to main content

Class: WorkflowExecutionFailedEventAttributes

Represents a WorkflowExecutionFailedEventAttributes.

Properties​

failure?​

optional failure?: $Properties | null

Serialized result of workflow failure (ex: An exception thrown, or error returned)

newExecutionRunId​

newExecutionRunId: string

If another run is started by cron or retry, this contains the new run id.

retryState​

retryState: RetryState

WorkflowExecutionFailedEventAttributes retryState.

workflowTaskCompletedEventId​

workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowExecutionFailedEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowExecutionFailedEventAttributes & $Shape

Creates a new WorkflowExecutionFailedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

WorkflowExecutionFailedEventAttributes & $Shape

WorkflowExecutionFailedEventAttributes instance

Call Signature​

static create(properties?): WorkflowExecutionFailedEventAttributes

Creates a new WorkflowExecutionFailedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionFailedEventAttributes

WorkflowExecutionFailedEventAttributes instance

decode()​

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

Decodes a WorkflowExecutionFailedEventAttributes 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​

WorkflowExecutionFailedEventAttributes & $Shape

WorkflowExecutionFailedEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowExecutionFailedEventAttributes & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowExecutionFailedEventAttributes & $Shape

WorkflowExecutionFailedEventAttributes

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

Parameters​

message​

$Properties

WorkflowExecutionFailedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowExecutionFailedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowExecutionFailedEventAttributes

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

Parameters​

object​

Plain object

Returns​

WorkflowExecutionFailedEventAttributes

WorkflowExecutionFailedEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowExecutionFailedEventAttributes

WorkflowExecutionFailedEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object