Package com.sap.ai.sdk.grounding.model
Class RetrievalDocumentKeyValueListPair
java.lang.Object
com.sap.ai.sdk.grounding.model.RetrievalDocumentKeyValueListPair
RetrievalDocumentKeyValueListPair
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceBuilder helper class.static interfaceBuilder helper class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDefault constructor for RetrievalDocumentKeyValueListPair. -
Method Summary
Modifier and TypeMethodDescriptionaddValueItem(String valueItem) Add one value instance to thisRetrievalDocumentKeyValueListPair.create()Create a type-safe, fluent-api builder object to construct a newRetrievalDocumentKeyValueListPairinstance with all required arguments.booleangetCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theRetrievalDocumentKeyValueListPair.getKey()Get keyGet matchModegetValue()Get valueinthashCode()Set the key of thisRetrievalDocumentKeyValueListPairinstance and return the same instance.matchMode(FilterMatchModeEnum matchMode) Set the matchMode of thisRetrievalDocumentKeyValueListPairinstance and return the same instance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisRetrievalDocumentKeyValueListPairinstance.voidSet the key of thisRetrievalDocumentKeyValueListPairinstance.voidsetMatchMode(FilterMatchModeEnum matchMode) Set the matchMode of thisRetrievalDocumentKeyValueListPairinstance.voidSet the value of thisRetrievalDocumentKeyValueListPairinstance.toMap()Get the value of all properties of thisRetrievalDocumentKeyValueListPairinstance including unrecognized properties.toString()Set the value of thisRetrievalDocumentKeyValueListPairinstance and return the same instance.
-
Constructor Details
-
RetrievalDocumentKeyValueListPair
protected RetrievalDocumentKeyValueListPair()Default constructor for RetrievalDocumentKeyValueListPair.
-
-
Method Details
-
key
Set the key of thisRetrievalDocumentKeyValueListPairinstance and return the same instance.- Parameters:
key- The key of thisRetrievalDocumentKeyValueListPair- Returns:
- The same instance of this
RetrievalDocumentKeyValueListPairclass
-
getKey
Get key- Returns:
- key The key of this
RetrievalDocumentKeyValueListPairinstance.
-
setKey
Set the key of thisRetrievalDocumentKeyValueListPairinstance.- Parameters:
key- The key of thisRetrievalDocumentKeyValueListPair
-
value
Set the value of thisRetrievalDocumentKeyValueListPairinstance and return the same instance.- Parameters:
value- The value of thisRetrievalDocumentKeyValueListPair- Returns:
- The same instance of this
RetrievalDocumentKeyValueListPairclass
-
addValueItem
Add one value instance to thisRetrievalDocumentKeyValueListPair.- Parameters:
valueItem- The value that should be added- Returns:
- The same instance of type
RetrievalDocumentKeyValueListPair
-
getValue
Get value- Returns:
- value The value of this
RetrievalDocumentKeyValueListPairinstance.
-
setValue
Set the value of thisRetrievalDocumentKeyValueListPairinstance.- Parameters:
value- The value of thisRetrievalDocumentKeyValueListPair
-
matchMode
@Nonnull public RetrievalDocumentKeyValueListPair matchMode(@Nullable FilterMatchModeEnum matchMode) Set the matchMode of thisRetrievalDocumentKeyValueListPairinstance and return the same instance.- Parameters:
matchMode- The matchMode of thisRetrievalDocumentKeyValueListPair- Returns:
- The same instance of this
RetrievalDocumentKeyValueListPairclass
-
getMatchMode
Get matchMode- Returns:
- matchMode The matchMode of this
RetrievalDocumentKeyValueListPairinstance.
-
setMatchMode
Set the matchMode of thisRetrievalDocumentKeyValueListPairinstance.- Parameters:
matchMode- The matchMode of thisRetrievalDocumentKeyValueListPair
-
getCustomFieldNames
Get the names of the unrecognizable properties of theRetrievalDocumentKeyValueListPair.- 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 thisRetrievalDocumentKeyValueListPairinstance.- 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 thisRetrievalDocumentKeyValueListPairinstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisRetrievalDocumentKeyValueListPairinstance. 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 newRetrievalDocumentKeyValueListPairinstance with all required arguments.
-
toMap()instead.