Package akka.javasdk.ledger

Enum Class Failure.FailureReason

Object

Enum<Failure.FailureReason>

akka.javasdk.ledger.Failure.FailureReason

All Implemented Interfaces:

Serializable, Comparable<Failure.FailureReason>, Constable

Enclosing class:

Failure

public static enum Failure.FailureReason
extends Enum<Failure.FailureReason>

Why an interaction failed. A later SDK version can add values.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTENT_LOADING	Referenced content (for example an image or PDF) could not be loaded.
GUARDRAIL	A guardrail rejected the interaction.
INTERNAL	An internal error occurred.
MCP_TOOL_CALL	An MCP tool call failed.
MODEL	The model call itself failed.
OUTPUT_PARSING	The model output could not be parsed into the expected result type.
RATE_LIMIT	The model provider rate-limited the call.
TIMEOUT	The model call timed out.
TOOL_CALL	A tool call failed.
UNSPECIFIED	The runtime did not report the reason, or this version of the SDK does not know it.
UNSUPPORTED_FEATURE	The interaction used a feature the model does not support.

Method Summary

Modifier and Type	Method	Description
static Failure.FailureReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Failure.FailureReason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNSPECIFIED

public static final Failure.FailureReason UNSPECIFIED

The runtime did not report the reason, or this version of the SDK does not know it.

MODEL

public static final Failure.FailureReason MODEL

The model call itself failed.

RATE_LIMIT

public static final Failure.FailureReason RATE_LIMIT

The model provider rate-limited the call.

TIMEOUT

public static final Failure.FailureReason TIMEOUT

The model call timed out.

UNSUPPORTED_FEATURE

public static final Failure.FailureReason UNSUPPORTED_FEATURE

The interaction used a feature the model does not support.

INTERNAL

public static final Failure.FailureReason INTERNAL

An internal error occurred.

OUTPUT_PARSING

public static final Failure.FailureReason OUTPUT_PARSING

The model output could not be parsed into the expected result type.

TOOL_CALL

public static final Failure.FailureReason TOOL_CALL

A tool call failed.

MCP_TOOL_CALL

public static final Failure.FailureReason MCP_TOOL_CALL

An MCP tool call failed.

GUARDRAIL

public static final Failure.FailureReason GUARDRAIL

A guardrail rejected the interaction.

CONTENT_LOADING

public static final Failure.FailureReason CONTENT_LOADING

Referenced content (for example an image or PDF) could not be loaded.

Method Details

values

public static Failure.FailureReason[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Failure.FailureReason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null