Skip to main content

Interface: $Properties

Properties of a Failure.

Extended by​

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?​

optional message?: string | null

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?​

optional source?: string | null

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?​

optional stackTrace?: string | null

Failure stackTrace

terminatedFailureInfo?​

optional terminatedFailureInfo?: $Properties | null

Failure terminatedFailureInfo

timeoutFailureInfo?​

optional timeoutFailureInfo?: $Properties | null

Failure timeoutFailureInfo