Package com.sap.ai.sdk.grounding.model

Enum Class ScopedKeyValueListPair.ScopeEnum

java.lang.Object

java.lang.Enum<ScopedKeyValueListPair.ScopeEnum>

com.sap.ai.sdk.grounding.model.ScopedKeyValueListPair.ScopeEnum

All Implemented Interfaces:

Serializable, Comparable<ScopedKeyValueListPair.ScopeEnum>, Constable

Enclosing class:

ScopedKeyValueListPair

public static enum ScopedKeyValueListPair.ScopeEnum
extends Enum<ScopedKeyValueListPair.ScopeEnum>

Scope of the metadata filter (e.g., collection, document, chunk)

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
CHUNK	The CHUNK option of this ScopedKeyValueListPair
COLLECTION	The COLLECTION option of this ScopedKeyValueListPair
DOCUMENT	The DOCUMENT option of this ScopedKeyValueListPair
UNKNOWN_DEFAULT_OPEN_API	The UNKNOWN_DEFAULT_OPEN_API option of this ScopedKeyValueListPair

Method Summary

Modifier and Type	Method	Description
static ScopedKeyValueListPair.ScopeEnum	fromValue(String value)	Get the enum value from a String value
String	getValue()	Get the value of the enum
String	toString()	Get the String value of the enum value.
static ScopedKeyValueListPair.ScopeEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScopedKeyValueListPair.ScopeEnum[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COLLECTION

public static final ScopedKeyValueListPair.ScopeEnum COLLECTION

The COLLECTION option of this ScopedKeyValueListPair

DOCUMENT

public static final ScopedKeyValueListPair.ScopeEnum DOCUMENT

The DOCUMENT option of this ScopedKeyValueListPair

CHUNK

public static final ScopedKeyValueListPair.ScopeEnum CHUNK

The CHUNK option of this ScopedKeyValueListPair

UNKNOWN_DEFAULT_OPEN_API

public static final ScopedKeyValueListPair.ScopeEnum UNKNOWN_DEFAULT_OPEN_API

The UNKNOWN_DEFAULT_OPEN_API option of this ScopedKeyValueListPair

Method Details

values

public static ScopedKeyValueListPair.ScopeEnum[] 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 ScopedKeyValueListPair.ScopeEnum 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

getValue

@Nonnull
public String getValue()

Get the value of the enum

Returns:

The enum value

toString

@Nonnull
public String toString()

Get the String value of the enum value.

Overrides:

toString in class Enum<ScopedKeyValueListPair.ScopeEnum>

Returns:

The enum value as String

fromValue

@Nonnull
public static ScopedKeyValueListPair.ScopeEnum fromValue(@Nonnull
 String value)

Get the enum value from a String value

Parameters:

value - The String value

Returns:

The enum value of type ScopedKeyValueListPair