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

Class RetrievalSearchDocumentKeyValueListPair

java.lang.Object

com.sap.ai.sdk.grounding.model.RetrievalSearchDocumentKeyValueListPair

public class RetrievalSearchDocumentKeyValueListPair
extends Object

RetrievalSearchDocumentKeyValueListPair

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievalSearchDocumentKeyValueListPair

protected RetrievalSearchDocumentKeyValueListPair()

Default constructor for RetrievalSearchDocumentKeyValueListPair.

Method Details

key

@Nonnull
public RetrievalSearchDocumentKeyValueListPair key(@Nonnull
 String key)

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

Parameters:

key - The key of this RetrievalSearchDocumentKeyValueListPair

Returns:

The same instance of this RetrievalSearchDocumentKeyValueListPair class

getKey

@Nonnull
public String getKey()

Get key

Returns:

key The key of this RetrievalSearchDocumentKeyValueListPair instance.

setKey

public void setKey(@Nonnull
 String key)

Set the key of this RetrievalSearchDocumentKeyValueListPair instance.

Parameters:

key - The key of this RetrievalSearchDocumentKeyValueListPair

value

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

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

Parameters:

value - The value of this RetrievalSearchDocumentKeyValueListPair

Returns:

The same instance of this RetrievalSearchDocumentKeyValueListPair class

addValueItem

@Nonnull
public RetrievalSearchDocumentKeyValueListPair addValueItem(@Nonnull
 String valueItem)

Add one value instance to this RetrievalSearchDocumentKeyValueListPair.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type RetrievalSearchDocumentKeyValueListPair

getValue

@Nonnull
public List<String> getValue()

Get value

Returns:

value The value of this RetrievalSearchDocumentKeyValueListPair instance.

setValue

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

Set the value of this RetrievalSearchDocumentKeyValueListPair instance.

Parameters:

value - The value of this RetrievalSearchDocumentKeyValueListPair

selectMode

@Nonnull
public RetrievalSearchDocumentKeyValueListPair selectMode(@Nullable
 List<RetrievalSearchSelectOptionEnum> selectMode)

Set the selectMode of this RetrievalSearchDocumentKeyValueListPair instance and return the same instance.

Parameters:

selectMode - Select mode for search filters

Returns:

The same instance of this RetrievalSearchDocumentKeyValueListPair class

addSelectModeItem

@Nonnull
public RetrievalSearchDocumentKeyValueListPair addSelectModeItem(@Nonnull
 RetrievalSearchSelectOptionEnum selectModeItem)

Add one selectMode instance to this RetrievalSearchDocumentKeyValueListPair.

Parameters:

selectModeItem - The selectMode that should be added

Returns:

The same instance of type RetrievalSearchDocumentKeyValueListPair

getSelectMode

@Nullable
public List<RetrievalSearchSelectOptionEnum> getSelectMode()

Select mode for search filters

Returns:

selectMode The selectMode of this RetrievalSearchDocumentKeyValueListPair instance.

setSelectMode

public void setSelectMode(@Nullable
 List<RetrievalSearchSelectOptionEnum> selectMode)

Set the selectMode of this RetrievalSearchDocumentKeyValueListPair instance.

Parameters:

selectMode - Select mode for search filters

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RetrievalSearchDocumentKeyValueListPair.

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

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