Package com.sap.ai.sdk.grounding.model
Class RetrievalSearchDocumentKeyValueListPair
java.lang.Object
com.sap.ai.sdk.grounding.model.RetrievalSearchDocumentKeyValueListPair
RetrievalSearchDocumentKeyValueListPair
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceBuilder helper class.static interfaceBuilder helper class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDefault constructor for RetrievalSearchDocumentKeyValueListPair. -
Method Summary
Modifier and TypeMethodDescriptionaddSelectModeItem(RetrievalSearchSelectOptionEnum selectModeItem) Add one selectMode instance to thisRetrievalSearchDocumentKeyValueListPair.addValueItem(String valueItem) Add one value instance to thisRetrievalSearchDocumentKeyValueListPair.create()Create a type-safe, fluent-api builder object to construct a newRetrievalSearchDocumentKeyValueListPairinstance with all required arguments.booleangetCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theRetrievalSearchDocumentKeyValueListPair.getKey()Get keySelect mode for search filtersgetValue()Get valueinthashCode()Set the key of thisRetrievalSearchDocumentKeyValueListPairinstance and return the same instance.selectMode(List<RetrievalSearchSelectOptionEnum> selectMode) Set the selectMode of thisRetrievalSearchDocumentKeyValueListPairinstance and return the same instance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisRetrievalSearchDocumentKeyValueListPairinstance.voidSet the key of thisRetrievalSearchDocumentKeyValueListPairinstance.voidsetSelectMode(List<RetrievalSearchSelectOptionEnum> selectMode) Set the selectMode of thisRetrievalSearchDocumentKeyValueListPairinstance.voidSet the value of thisRetrievalSearchDocumentKeyValueListPairinstance.toMap()Get the value of all properties of thisRetrievalSearchDocumentKeyValueListPairinstance including unrecognized properties.toString()Set the value of thisRetrievalSearchDocumentKeyValueListPairinstance and return the same instance.
-
Constructor Details
-
RetrievalSearchDocumentKeyValueListPair
protected RetrievalSearchDocumentKeyValueListPair()Default constructor for RetrievalSearchDocumentKeyValueListPair.
-
-
Method Details
-
key
Set the key of thisRetrievalSearchDocumentKeyValueListPairinstance and return the same instance.- Parameters:
key- The key of thisRetrievalSearchDocumentKeyValueListPair- Returns:
- The same instance of this
RetrievalSearchDocumentKeyValueListPairclass
-
getKey
Get key- Returns:
- key The key of this
RetrievalSearchDocumentKeyValueListPairinstance.
-
setKey
Set the key of thisRetrievalSearchDocumentKeyValueListPairinstance.- Parameters:
key- The key of thisRetrievalSearchDocumentKeyValueListPair
-
value
Set the value of thisRetrievalSearchDocumentKeyValueListPairinstance and return the same instance.- Parameters:
value- The value of thisRetrievalSearchDocumentKeyValueListPair- Returns:
- The same instance of this
RetrievalSearchDocumentKeyValueListPairclass
-
addValueItem
Add one value instance to thisRetrievalSearchDocumentKeyValueListPair.- Parameters:
valueItem- The value that should be added- Returns:
- The same instance of type
RetrievalSearchDocumentKeyValueListPair
-
getValue
Get value- Returns:
- value The value of this
RetrievalSearchDocumentKeyValueListPairinstance.
-
setValue
Set the value of thisRetrievalSearchDocumentKeyValueListPairinstance.- Parameters:
value- The value of thisRetrievalSearchDocumentKeyValueListPair
-
selectMode
@Nonnull public RetrievalSearchDocumentKeyValueListPair selectMode(@Nullable List<RetrievalSearchSelectOptionEnum> selectMode) Set the selectMode of thisRetrievalSearchDocumentKeyValueListPairinstance and return the same instance.- Parameters:
selectMode- Select mode for search filters- Returns:
- The same instance of this
RetrievalSearchDocumentKeyValueListPairclass
-
addSelectModeItem
@Nonnull public RetrievalSearchDocumentKeyValueListPair addSelectModeItem(@Nonnull RetrievalSearchSelectOptionEnum selectModeItem) Add one selectMode instance to thisRetrievalSearchDocumentKeyValueListPair.- Parameters:
selectModeItem- The selectMode that should be added- Returns:
- The same instance of type
RetrievalSearchDocumentKeyValueListPair
-
getSelectMode
Select mode for search filters- Returns:
- selectMode The selectMode of this
RetrievalSearchDocumentKeyValueListPairinstance.
-
setSelectMode
Set the selectMode of thisRetrievalSearchDocumentKeyValueListPairinstance.- Parameters:
selectMode- Select mode for search filters
-
getCustomFieldNames
Get the names of the unrecognizable properties of theRetrievalSearchDocumentKeyValueListPair.- 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 thisRetrievalSearchDocumentKeyValueListPairinstance.- 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 thisRetrievalSearchDocumentKeyValueListPairinstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisRetrievalSearchDocumentKeyValueListPairinstance. 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 newRetrievalSearchDocumentKeyValueListPairinstance with all required arguments.
-
toMap()instead.