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

Class DocumentKeyValueListPair

java.lang.Object

com.sap.ai.sdk.grounding.model.DocumentKeyValueListPair

public class DocumentKeyValueListPair
extends Object

DocumentKeyValueListPair

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentKeyValueListPair

protected DocumentKeyValueListPair()

Default constructor for DocumentKeyValueListPair.

Method Details

key

@Nonnull
public DocumentKeyValueListPair key(@Nonnull
 String key)

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

Parameters:

key - The key of this DocumentKeyValueListPair

Returns:

The same instance of this DocumentKeyValueListPair class

getKey

@Nonnull
public String getKey()

Get key

Returns:

key The key of this DocumentKeyValueListPair instance.

setKey

public void setKey(@Nonnull
 String key)

Set the key of this DocumentKeyValueListPair instance.

Parameters:

key - The key of this DocumentKeyValueListPair

value

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

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

Parameters:

value - The value of this DocumentKeyValueListPair

Returns:

The same instance of this DocumentKeyValueListPair class

addValueItem

@Nonnull
public DocumentKeyValueListPair addValueItem(@Nonnull
 String valueItem)

Add one value instance to this DocumentKeyValueListPair.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type DocumentKeyValueListPair

getValue

@Nonnull
public List<String> getValue()

Get value

Returns:

value The value of this DocumentKeyValueListPair instance.

setValue

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

Set the value of this DocumentKeyValueListPair instance.

Parameters:

value - The value of this DocumentKeyValueListPair

matchMode

@Nonnull
public DocumentKeyValueListPair matchMode(@Nullable
 FilterMatchModeEnum matchMode)

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

Parameters:

matchMode - The matchMode of this DocumentKeyValueListPair

Returns:

The same instance of this DocumentKeyValueListPair class

getMatchMode

@Nonnull
public FilterMatchModeEnum getMatchMode()

Get matchMode

Returns:

matchMode The matchMode of this DocumentKeyValueListPair instance.

setMatchMode

public void setMatchMode(@Nullable
 FilterMatchModeEnum matchMode)

Set the matchMode of this DocumentKeyValueListPair instance.

Parameters:

matchMode - The matchMode of this DocumentKeyValueListPair

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DocumentKeyValueListPair.

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

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