Package com.sap.ai.sdk.prompt.registry.model

Class SearchDocumentKeyValueListPair

java.lang.Object

com.sap.ai.sdk.prompt.registry.model.SearchDocumentKeyValueListPair

public class SearchDocumentKeyValueListPair
extends Object

SearchDocumentKeyValueListPair

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

SearchDocumentKeyValueListPair

protected SearchDocumentKeyValueListPair()

Default constructor for SearchDocumentKeyValueListPair.

Method Details

key

@Nonnull
public SearchDocumentKeyValueListPair key(@Nonnull
 String key)

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

Parameters:

key - The key of this SearchDocumentKeyValueListPair

Returns:

The same instance of this SearchDocumentKeyValueListPair class

getKey

@Nonnull
public String getKey()

Get key

Returns:

key The key of this SearchDocumentKeyValueListPair instance.

setKey

public void setKey(@Nonnull
 String key)

Set the key of this SearchDocumentKeyValueListPair instance.

Parameters:

key - The key of this SearchDocumentKeyValueListPair

value

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

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

Parameters:

value - The value of this SearchDocumentKeyValueListPair

Returns:

The same instance of this SearchDocumentKeyValueListPair class

addValueItem

@Nonnull
public SearchDocumentKeyValueListPair addValueItem(@Nonnull
 String valueItem)

Add one value instance to this SearchDocumentKeyValueListPair.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type SearchDocumentKeyValueListPair

getValue

@Nonnull
public List<String> getValue()

Get value

Returns:

value The value of this SearchDocumentKeyValueListPair instance.

setValue

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

Set the value of this SearchDocumentKeyValueListPair instance.

Parameters:

value - The value of this SearchDocumentKeyValueListPair

selectMode

@Nonnull
public SearchDocumentKeyValueListPair selectMode(@Nullable
 List<SearchSelectOptionEnum> selectMode)

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

Parameters:

selectMode - Select mode for search filters

Returns:

The same instance of this SearchDocumentKeyValueListPair class

addSelectModeItem

@Nonnull
public SearchDocumentKeyValueListPair addSelectModeItem(@Nonnull
 SearchSelectOptionEnum selectModeItem)

Add one selectMode instance to this SearchDocumentKeyValueListPair.

Parameters:

selectModeItem - The selectMode that should be added

Returns:

The same instance of type SearchDocumentKeyValueListPair

getSelectMode

@Nonnull
public List<SearchSelectOptionEnum> getSelectMode()

Select mode for search filters

Returns:

selectMode The selectMode of this SearchDocumentKeyValueListPair instance.

setSelectMode

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

Set the selectMode of this SearchDocumentKeyValueListPair instance.

Parameters:

selectMode - Select mode for search filters

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the SearchDocumentKeyValueListPair.

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

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