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

Class DataRepositorySearchResults

java.lang.Object

com.sap.ai.sdk.grounding.model.DataRepositorySearchResults

public class DataRepositorySearchResults
extends Object

DataRepositorySearchResults

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DataRepositorySearchResults.Builder	Builder helper class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DataRepositorySearchResults	addResultsItem(ResultsInner2 resultsItem)	Add one results instance to this DataRepositorySearchResults.
static DataRepositorySearchResults.Builder	create()	Create a type-safe, fluent-api builder object to construct a new DataRepositorySearchResults 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 DataRepositorySearchResults.
List<ResultsInner2>	getResults()	List of returned results.
int	hashCode()
DataRepositorySearchResults	results(List<ResultsInner2> results)	Set the results of this DataRepositorySearchResults instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this DataRepositorySearchResults instance.
void	setResults(List<ResultsInner2> results)	Set the results of this DataRepositorySearchResults instance.
Map<String,Object>	toMap()	Get the value of all properties of this DataRepositorySearchResults instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DataRepositorySearchResults

protected DataRepositorySearchResults()

Default constructor for DataRepositorySearchResults.

Method Details

results

@Nonnull
public DataRepositorySearchResults results(@Nonnull
 List<ResultsInner2> results)

Set the results of this DataRepositorySearchResults instance and return the same instance.

Parameters:

results - List of returned results.

Returns:

The same instance of this DataRepositorySearchResults class

addResultsItem

@Nonnull
public DataRepositorySearchResults addResultsItem(@Nonnull
 ResultsInner2 resultsItem)

Add one results instance to this DataRepositorySearchResults.

Parameters:

resultsItem - The results that should be added

Returns:

The same instance of type DataRepositorySearchResults

getResults

@Nonnull
public List<ResultsInner2> getResults()

List of returned results.

Returns:

results The results of this DataRepositorySearchResults instance.

setResults

public void setResults(@Nonnull
 List<ResultsInner2> results)

Set the results of this DataRepositorySearchResults instance.

Parameters:

results - List of returned results.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DataRepositorySearchResults.

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

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