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

Class RetrievalKeyValueListPair

java.lang.Object

com.sap.ai.sdk.grounding.model.RetrievalKeyValueListPair

public class RetrievalKeyValueListPair
extends Object

RetrievalKeyValueListPair

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrievalKeyValueListPair.Builder	Builder helper class.
static interface	RetrievalKeyValueListPair.Builder1	Builder helper class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RetrievalKeyValueListPair	addValueItem(String valueItem)	Add one value instance to this RetrievalKeyValueListPair.
static RetrievalKeyValueListPair.Builder	create()	Create a type-safe, fluent-api builder object to construct a new RetrievalKeyValueListPair 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 RetrievalKeyValueListPair.
String	getKey()	Get key
List<String>	getValue()	Get value
int	hashCode()
RetrievalKeyValueListPair	key(String key)	Set the key of this RetrievalKeyValueListPair instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this RetrievalKeyValueListPair instance.
void	setKey(String key)	Set the key of this RetrievalKeyValueListPair instance.
void	setValue(List<String> value)	Set the value of this RetrievalKeyValueListPair instance.
Map<String,Object>	toMap()	Get the value of all properties of this RetrievalKeyValueListPair instance including unrecognized properties.
String	toString()
RetrievalKeyValueListPair	value(List<String> value)	Set the value of this RetrievalKeyValueListPair instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievalKeyValueListPair

protected RetrievalKeyValueListPair()

Default constructor for RetrievalKeyValueListPair.

Method Details

key

@Nonnull
public RetrievalKeyValueListPair key(@Nonnull
 String key)

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

Parameters:

key - The key of this RetrievalKeyValueListPair

Returns:

The same instance of this RetrievalKeyValueListPair class

getKey

@Nonnull
public String getKey()

Get key

Returns:

key The key of this RetrievalKeyValueListPair instance.

setKey

public void setKey(@Nonnull
 String key)

Set the key of this RetrievalKeyValueListPair instance.

Parameters:

key - The key of this RetrievalKeyValueListPair

value

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

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

Parameters:

value - The value of this RetrievalKeyValueListPair

Returns:

The same instance of this RetrievalKeyValueListPair class

addValueItem

@Nonnull
public RetrievalKeyValueListPair addValueItem(@Nonnull
 String valueItem)

Add one value instance to this RetrievalKeyValueListPair.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type RetrievalKeyValueListPair

getValue

@Nonnull
public List<String> getValue()

Get value

Returns:

value The value of this RetrievalKeyValueListPair instance.

setValue

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

Set the value of this RetrievalKeyValueListPair instance.

Parameters:

value - The value of this RetrievalKeyValueListPair

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RetrievalKeyValueListPair.

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 RetrievalKeyValueListPair 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 RetrievalKeyValueListPair 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 RetrievalKeyValueListPair 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 RetrievalKeyValueListPair.Builder create()

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