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

Class RetrievalScopedKeyValueListPair

java.lang.Object

com.sap.ai.sdk.grounding.model.RetrievalScopedKeyValueListPair

public class RetrievalScopedKeyValueListPair
extends Object

RetrievalScopedKeyValueListPair

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrievalScopedKeyValueListPair.Builder	Builder helper class.
static interface	RetrievalScopedKeyValueListPair.Builder1	Builder helper class.
static enum	RetrievalScopedKeyValueListPair.ScopeEnum	Gets or Sets scope

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievalScopedKeyValueListPair

protected RetrievalScopedKeyValueListPair()

Default constructor for RetrievalScopedKeyValueListPair.

Method Details

key

@Nonnull
public RetrievalScopedKeyValueListPair key(@Nonnull
 String key)

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

Parameters:

key - The key of this RetrievalScopedKeyValueListPair

Returns:

The same instance of this RetrievalScopedKeyValueListPair class

getKey

@Nonnull
public String getKey()

Get key

Returns:

key The key of this RetrievalScopedKeyValueListPair instance.

setKey

public void setKey(@Nonnull
 String key)

Set the key of this RetrievalScopedKeyValueListPair instance.

Parameters:

key - The key of this RetrievalScopedKeyValueListPair

value

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

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

Parameters:

value - The value of this RetrievalScopedKeyValueListPair

Returns:

The same instance of this RetrievalScopedKeyValueListPair class

addValueItem

@Nonnull
public RetrievalScopedKeyValueListPair addValueItem(@Nonnull
 String valueItem)

Add one value instance to this RetrievalScopedKeyValueListPair.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type RetrievalScopedKeyValueListPair

getValue

@Nonnull
public List<String> getValue()

Get value

Returns:

value The value of this RetrievalScopedKeyValueListPair instance.

setValue

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

Set the value of this RetrievalScopedKeyValueListPair instance.

Parameters:

value - The value of this RetrievalScopedKeyValueListPair

scope

@Nonnull
public RetrievalScopedKeyValueListPair scope(@Nullable
 RetrievalScopedKeyValueListPair.ScopeEnum scope)

Set the scope of this RetrievalScopedKeyValueListPair instance and return the same instance.

Parameters:

scope - The scope of this RetrievalScopedKeyValueListPair

Returns:

The same instance of this RetrievalScopedKeyValueListPair class

getScope

@Nonnull
public RetrievalScopedKeyValueListPair.ScopeEnum getScope()

Get scope

Returns:

scope The scope of this RetrievalScopedKeyValueListPair instance.

setScope

public void setScope(@Nullable
 RetrievalScopedKeyValueListPair.ScopeEnum scope)

Set the scope of this RetrievalScopedKeyValueListPair instance.

Parameters:

scope - The scope of this RetrievalScopedKeyValueListPair

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RetrievalScopedKeyValueListPair.

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

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