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

Class ScopedKeyValueListPair

java.lang.Object

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

public class ScopedKeyValueListPair
extends Object

ScopedKeyValueListPair

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScopedKeyValueListPair.Builder	Builder helper class.
static interface	ScopedKeyValueListPair.Builder1	Builder helper class.
static enum	ScopedKeyValueListPair.ScopeEnum	Scope of the metadata filter (e.g., collection, document, chunk)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ScopedKeyValueListPair()	Default constructor for ScopedKeyValueListPair.

Method Summary

Modifier and Type	Method	Description
ScopedKeyValueListPair	addValueItem(String valueItem)	Add one value instance to this ScopedKeyValueListPair.
static ScopedKeyValueListPair.Builder	create()	Create a type-safe, fluent-api builder object to construct a new ScopedKeyValueListPair instance with all required arguments.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ScopedKeyValueListPair.
String	getKey()	Get key
ScopedKeyValueListPair.ScopeEnum	getScope()	Scope of the metadata filter (e.g., collection, document, chunk)
List<String>	getValue()	Get value
int	hashCode()
ScopedKeyValueListPair	key(String key)	Set the key of this ScopedKeyValueListPair instance and return the same instance.
ScopedKeyValueListPair	scope(ScopedKeyValueListPair.ScopeEnum scope)	Set the scope of this ScopedKeyValueListPair instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ScopedKeyValueListPair instance.
void	setKey(String key)	Set the key of this ScopedKeyValueListPair instance.
void	setScope(ScopedKeyValueListPair.ScopeEnum scope)	Set the scope of this ScopedKeyValueListPair instance.
void	setValue(List<String> value)	Set the value of this ScopedKeyValueListPair instance.
Map<String,Object>	toMap()	Get the value of all properties of this ScopedKeyValueListPair instance including unrecognized properties.
String	toString()
ScopedKeyValueListPair	value(List<String> value)	Set the value of this ScopedKeyValueListPair instance and return the same instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ScopedKeyValueListPair

protected ScopedKeyValueListPair()

Default constructor for ScopedKeyValueListPair.

Method Details

key

@Nonnull
public ScopedKeyValueListPair key(@Nonnull
 String key)

Set the key of this ScopedKeyValueListPair instance and return the same instance.

Parameters:

key - The key of this ScopedKeyValueListPair

Returns:

The same instance of this ScopedKeyValueListPair class

getKey

@Nonnull
public String getKey()

Get key

Returns:

key The key of this ScopedKeyValueListPair instance.

setKey

public void setKey(@Nonnull
 String key)

Set the key of this ScopedKeyValueListPair instance.

Parameters:

key - The key of this ScopedKeyValueListPair

value

@Nonnull
public ScopedKeyValueListPair value(@Nonnull
 List<String> value)

Set the value of this ScopedKeyValueListPair instance and return the same instance.

Parameters:

value - The value of this ScopedKeyValueListPair

Returns:

The same instance of this ScopedKeyValueListPair class

addValueItem

@Nonnull
public ScopedKeyValueListPair addValueItem(@Nonnull
 String valueItem)

Add one value instance to this ScopedKeyValueListPair.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type ScopedKeyValueListPair

getValue

@Nonnull
public List<String> getValue()

Get value

Returns:

value The value of this ScopedKeyValueListPair instance.

setValue

public void setValue(@Nonnull
 List<String> value)

Set the value of this ScopedKeyValueListPair instance.

Parameters:

value - The value of this ScopedKeyValueListPair

scope

@Nonnull
public ScopedKeyValueListPair scope(@Nullable
 ScopedKeyValueListPair.ScopeEnum scope)

Set the scope of this ScopedKeyValueListPair instance and return the same instance.

Parameters:

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

Returns:

The same instance of this ScopedKeyValueListPair class

getScope

@Nonnull
public ScopedKeyValueListPair.ScopeEnum getScope()

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

Returns:

scope The scope of this ScopedKeyValueListPair instance.

setScope

public void setScope(@Nullable
 ScopedKeyValueListPair.ScopeEnum scope)

Set the scope of this ScopedKeyValueListPair instance.

Parameters:

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

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ScopedKeyValueListPair.

Returns:

The set of properties names

getCustomField

@Nullable
@Deprecated
public Object getCustomField(@Nonnull
 String name)
                      throws NoSuchElementException

Deprecated.

Use toMap() instead.

Get the value of an unrecognizable property of this ScopedKeyValueListPair instance.

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

NoSuchElementException - If no property with the given name could be found.

toMap

@Nonnull
public Map<String,Object> toMap()

Get the value of all properties of this ScopedKeyValueListPair instance including unrecognized properties.

Returns:

The map of all properties

setCustomField

public void setCustomField(@Nonnull
 String customFieldName,
 @Nullable
 Object customFieldValue)

Set an unrecognizable property of this ScopedKeyValueListPair instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

customFieldName - The name of the property

customFieldValue - The value of the property

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

create

public static ScopedKeyValueListPair.Builder create()

Create a type-safe, fluent-api builder object to construct a new ScopedKeyValueListPair instance with all required arguments.