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