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

Class RetrievalDocumentKeyValueListPair

java.lang.Object

com.sap.ai.sdk.grounding.model.RetrievalDocumentKeyValueListPair

public class RetrievalDocumentKeyValueListPair
extends Object

RetrievalDocumentKeyValueListPair

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievalDocumentKeyValueListPair

protected RetrievalDocumentKeyValueListPair()

Default constructor for RetrievalDocumentKeyValueListPair.

Method Details

key

@Nonnull
public RetrievalDocumentKeyValueListPair key(@Nonnull
 String key)

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

Parameters:

key - The key of this RetrievalDocumentKeyValueListPair

Returns:

The same instance of this RetrievalDocumentKeyValueListPair class

getKey

@Nonnull
public String getKey()

Get key

Returns:

key The key of this RetrievalDocumentKeyValueListPair instance.

setKey

public void setKey(@Nonnull
 String key)

Set the key of this RetrievalDocumentKeyValueListPair instance.

Parameters:

key - The key of this RetrievalDocumentKeyValueListPair

value

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

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

Parameters:

value - The value of this RetrievalDocumentKeyValueListPair

Returns:

The same instance of this RetrievalDocumentKeyValueListPair class

addValueItem

@Nonnull
public RetrievalDocumentKeyValueListPair addValueItem(@Nonnull
 String valueItem)

Add one value instance to this RetrievalDocumentKeyValueListPair.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type RetrievalDocumentKeyValueListPair

getValue

@Nonnull
public List<String> getValue()

Get value

Returns:

value The value of this RetrievalDocumentKeyValueListPair instance.

setValue

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

Set the value of this RetrievalDocumentKeyValueListPair instance.

Parameters:

value - The value of this RetrievalDocumentKeyValueListPair

matchMode

@Nonnull
public RetrievalDocumentKeyValueListPair matchMode(@Nullable
 FilterMatchModeEnum matchMode)

Set the matchMode of this RetrievalDocumentKeyValueListPair instance and return the same instance.

Parameters:

matchMode - The matchMode of this RetrievalDocumentKeyValueListPair

Returns:

The same instance of this RetrievalDocumentKeyValueListPair class

getMatchMode

@Nonnull
public FilterMatchModeEnum getMatchMode()

Get matchMode

Returns:

matchMode The matchMode of this RetrievalDocumentKeyValueListPair instance.

setMatchMode

public void setMatchMode(@Nullable
 FilterMatchModeEnum matchMode)

Set the matchMode of this RetrievalDocumentKeyValueListPair instance.

Parameters:

matchMode - The matchMode of this RetrievalDocumentKeyValueListPair

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RetrievalDocumentKeyValueListPair.

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

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