Package com.microsoft.semantickernel.memory

Enum MemoryException.ErrorCodes

java.lang.Object

java.lang.Enum<MemoryException.ErrorCodes>

com.microsoft.semantickernel.memory.MemoryException.ErrorCodes

All Implemented Interfaces:

Serializable, Comparable<MemoryException.ErrorCodes>

Enclosing class:

MemoryException

public static enum MemoryException.ErrorCodes
extends Enum<MemoryException.ErrorCodes>

Semantic kernel memory error codes.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTEMPTED_TO_ACCESS_NONEXISTENT_COLLECTION	Attempted to access a memory collection that does not exist.
FAILED_TO_CREATE_COLLECTION	Failed to create collection.
FAILED_TO_DELETE_COLLECTION	Failed to delete collection.
MEMORY_NOT_FOUND	Attempted to access a memory that does not exist.
UNABLE_TO_BUILD_MEMORY	Unable to build memory.
UNABLE_TO_DESERIALIZE_MEMORY	Unable to construct memory from serialized metadata.
UNABLE_TO_SERIALIZE_MEMORY	Unable to serialize a memory .
UNKNOWN	Unknown error.

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Gets the error message.
static MemoryException.ErrorCodes	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MemoryException.ErrorCodes[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final MemoryException.ErrorCodes UNKNOWN

Unknown error.

FAILED_TO_CREATE_COLLECTION

public static final MemoryException.ErrorCodes FAILED_TO_CREATE_COLLECTION

Failed to create collection.

FAILED_TO_DELETE_COLLECTION

public static final MemoryException.ErrorCodes FAILED_TO_DELETE_COLLECTION

Failed to delete collection.

UNABLE_TO_DESERIALIZE_MEMORY

public static final MemoryException.ErrorCodes UNABLE_TO_DESERIALIZE_MEMORY

Unable to construct memory from serialized metadata.

UNABLE_TO_SERIALIZE_MEMORY

public static final MemoryException.ErrorCodes UNABLE_TO_SERIALIZE_MEMORY

Unable to serialize a memory .

UNABLE_TO_BUILD_MEMORY

public static final MemoryException.ErrorCodes UNABLE_TO_BUILD_MEMORY

Unable to build memory.

ATTEMPTED_TO_ACCESS_NONEXISTENT_COLLECTION

public static final MemoryException.ErrorCodes ATTEMPTED_TO_ACCESS_NONEXISTENT_COLLECTION

Attempted to access a memory collection that does not exist.

MEMORY_NOT_FOUND

public static final MemoryException.ErrorCodes MEMORY_NOT_FOUND

Attempted to access a memory that does not exist.

Method Detail

values

public static MemoryException.ErrorCodes[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MemoryException.ErrorCodes c : MemoryException.ErrorCodes.values())
    System.out.println(c);

Returns:

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

valueOf

public static MemoryException.ErrorCodes valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getMessage

public String getMessage()

Gets the error message.

Returns:

The error message.