Skip to main content

Class: Failure

Represents a Failure.

Properties​

activityFailureInfo?​

optional activityFailureInfo?: $Properties | null

Failure activityFailureInfo.

applicationFailureInfo?​

optional applicationFailureInfo?: $Properties | null

Failure applicationFailureInfo.

canceledFailureInfo?​

optional canceledFailureInfo?: $Properties | null

Failure canceledFailureInfo.

cause?​

optional cause?: $Properties | null

Failure cause.

childWorkflowExecutionFailureInfo?​

optional childWorkflowExecutionFailureInfo?: $Properties | null

Failure childWorkflowExecutionFailureInfo.

encodedAttributes?​

optional encodedAttributes?: $Properties | null

Alternative way to supply message and stack_trace and possibly other attributes, used for encryption of errors originating in user code which might contain sensitive information. The encoded_attributes Payload could represent any serializable object, e.g. JSON object or a Failure proto message.

SDK authors:

  • The SDK should provide a default encodeFailureAttributes and decodeFailureAttributes implementation that:

  • Uses a JSON object to represent { message, stack_trace }.

  • Overwrites the original message with "Encoded failure" to indicate that more information could be extracted.

  • Overwrites the original stack_trace with an empty string.

  • The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed by the user-provided PayloadCodec

  • If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes. (-- api-linter: core::0203::optional=disabled --)

failureInfo?​

optional failureInfo?: "applicationFailureInfo" | "timeoutFailureInfo" | "canceledFailureInfo" | "terminatedFailureInfo" | "serverFailureInfo" | "resetWorkflowFailureInfo" | "activityFailureInfo" | "childWorkflowExecutionFailureInfo" | "nexusOperationExecutionFailureInfo" | "nexusHandlerFailureInfo"

Failure failureInfo.

message​

message: string

Failure message.

nexusHandlerFailureInfo?​

optional nexusHandlerFailureInfo?: $Properties | null

Failure nexusHandlerFailureInfo.

nexusOperationExecutionFailureInfo?​

optional nexusOperationExecutionFailureInfo?: $Properties | null

Failure nexusOperationExecutionFailureInfo.

resetWorkflowFailureInfo?​

optional resetWorkflowFailureInfo?: $Properties | null

Failure resetWorkflowFailureInfo.

serverFailureInfo?​

optional serverFailureInfo?: $Properties | null

Failure serverFailureInfo.

source​

source: string

The source this Failure originated in, e.g. TypeScriptSDK / JavaSDK In some SDKs this is used to rehydrate the stack trace into an exception object.

stackTrace​

stackTrace: string

Failure stackTrace.

terminatedFailureInfo?​

optional terminatedFailureInfo?: $Properties | null

Failure terminatedFailureInfo.

timeoutFailureInfo?​

optional timeoutFailureInfo?: $Properties | null

Failure timeoutFailureInfo.

Methods​

toJSON()​

toJSON(): object

Converts this Failure to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Failure & $Shape

Creates a new Failure instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Failure & $Shape

Failure instance

Call Signature​

static create(properties?): Failure

Creates a new Failure instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Failure

Failure instance

decode()​

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

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

Failure & $Shape

Failure

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Failure & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Failure & $Shape

Failure

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

Parameters​

message​

$Properties

Failure message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Failure message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Failure

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

Parameters​

object​

Plain object

Returns​

Failure

Failure

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Failure

Failure

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object