Package com.sap.ai.sdk.grounding.model
Class RetrievalScopedKeyValueListPair
java.lang.Object
com.sap.ai.sdk.grounding.model.RetrievalScopedKeyValueListPair
RetrievalScopedKeyValueListPair
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceBuilder helper class.static interfaceBuilder helper class.static enumGets or Sets scope -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDefault constructor for RetrievalScopedKeyValueListPair. -
Method Summary
Modifier and TypeMethodDescriptionaddValueItem(String valueItem) Add one value instance to thisRetrievalScopedKeyValueListPair.create()Create a type-safe, fluent-api builder object to construct a newRetrievalScopedKeyValueListPairinstance with all required arguments.booleangetCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theRetrievalScopedKeyValueListPair.getKey()Get keygetScope()Get scopegetValue()Get valueinthashCode()Set the key of thisRetrievalScopedKeyValueListPairinstance and return the same instance.Set the scope of thisRetrievalScopedKeyValueListPairinstance and return the same instance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisRetrievalScopedKeyValueListPairinstance.voidSet the key of thisRetrievalScopedKeyValueListPairinstance.voidSet the scope of thisRetrievalScopedKeyValueListPairinstance.voidSet the value of thisRetrievalScopedKeyValueListPairinstance.toMap()Get the value of all properties of thisRetrievalScopedKeyValueListPairinstance including unrecognized properties.toString()Set the value of thisRetrievalScopedKeyValueListPairinstance and return the same instance.
-
Constructor Details
-
RetrievalScopedKeyValueListPair
protected RetrievalScopedKeyValueListPair()Default constructor for RetrievalScopedKeyValueListPair.
-
-
Method Details
-
key
Set the key of thisRetrievalScopedKeyValueListPairinstance and return the same instance.- Parameters:
key- The key of thisRetrievalScopedKeyValueListPair- Returns:
- The same instance of this
RetrievalScopedKeyValueListPairclass
-
getKey
Get key- Returns:
- key The key of this
RetrievalScopedKeyValueListPairinstance.
-
setKey
Set the key of thisRetrievalScopedKeyValueListPairinstance.- Parameters:
key- The key of thisRetrievalScopedKeyValueListPair
-
value
Set the value of thisRetrievalScopedKeyValueListPairinstance and return the same instance.- Parameters:
value- The value of thisRetrievalScopedKeyValueListPair- Returns:
- The same instance of this
RetrievalScopedKeyValueListPairclass
-
addValueItem
Add one value instance to thisRetrievalScopedKeyValueListPair.- Parameters:
valueItem- The value that should be added- Returns:
- The same instance of type
RetrievalScopedKeyValueListPair
-
getValue
Get value- Returns:
- value The value of this
RetrievalScopedKeyValueListPairinstance.
-
setValue
Set the value of thisRetrievalScopedKeyValueListPairinstance.- Parameters:
value- The value of thisRetrievalScopedKeyValueListPair
-
scope
@Nonnull public RetrievalScopedKeyValueListPair scope(@Nullable RetrievalScopedKeyValueListPair.ScopeEnum scope) Set the scope of thisRetrievalScopedKeyValueListPairinstance and return the same instance.- Parameters:
scope- The scope of thisRetrievalScopedKeyValueListPair- Returns:
- The same instance of this
RetrievalScopedKeyValueListPairclass
-
getScope
Get scope- Returns:
- scope The scope of this
RetrievalScopedKeyValueListPairinstance.
-
setScope
Set the scope of thisRetrievalScopedKeyValueListPairinstance.- Parameters:
scope- The scope of thisRetrievalScopedKeyValueListPair
-
getCustomFieldNames
Get the names of the unrecognizable properties of theRetrievalScopedKeyValueListPair.- Returns:
- The set of properties names
-
getCustomField
@Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException Deprecated.UsetoMap()instead.Get the value of an unrecognizable property of thisRetrievalScopedKeyValueListPairinstance.- 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
Get the value of all properties of thisRetrievalScopedKeyValueListPairinstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisRetrievalScopedKeyValueListPairinstance. 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 propertycustomFieldValue- The value of the property
-
equals
-
hashCode
public int hashCode() -
toString
-
create
Create a type-safe, fluent-api builder object to construct a newRetrievalScopedKeyValueListPairinstance with all required arguments.
-
toMap()instead.