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

Class RetrievalPerFilterSearchResultWithError

java.lang.Object

com.sap.ai.sdk.grounding.model.RetrievalPerFilterSearchResultWithError

public class RetrievalPerFilterSearchResultWithError
extends Object

RetrievalPerFilterSearchResultWithError

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static RetrievalPerFilterSearchResultWithError.Builder	create()	Create a type-safe, fluent-api builder object to construct a new RetrievalPerFilterSearchResultWithError instance with all required arguments.
boolean	equals(Object o)
RetrievalPerFilterSearchResultWithError	error(RetrievalPerFilterSearchResultError error)	Set the error of this RetrievalPerFilterSearchResultWithError instance and return the same instance.
RetrievalPerFilterSearchResultWithError	filterId(String filterId)	Set the filterId of this RetrievalPerFilterSearchResultWithError instance and return the same instance.
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the RetrievalPerFilterSearchResultWithError.
RetrievalPerFilterSearchResultError	getError()	Get error
String	getFilterId()	Get filterId
int	hashCode()
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this RetrievalPerFilterSearchResultWithError instance.
void	setError(RetrievalPerFilterSearchResultError error)	Set the error of this RetrievalPerFilterSearchResultWithError instance.
void	setFilterId(String filterId)	Set the filterId of this RetrievalPerFilterSearchResultWithError instance.
Map<String,Object>	toMap()	Get the value of all properties of this RetrievalPerFilterSearchResultWithError instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievalPerFilterSearchResultWithError

protected RetrievalPerFilterSearchResultWithError()

Default constructor for RetrievalPerFilterSearchResultWithError.

Method Details

filterId

@Nonnull
public RetrievalPerFilterSearchResultWithError filterId(@Nonnull
 String filterId)

Set the filterId of this RetrievalPerFilterSearchResultWithError instance and return the same instance.

Parameters:

filterId - The filterId of this RetrievalPerFilterSearchResultWithError

Returns:

The same instance of this RetrievalPerFilterSearchResultWithError class

getFilterId

@Nonnull
public String getFilterId()

Get filterId

Returns:

filterId The filterId of this RetrievalPerFilterSearchResultWithError instance.

setFilterId

public void setFilterId(@Nonnull
 String filterId)

Set the filterId of this RetrievalPerFilterSearchResultWithError instance.

Parameters:

filterId - The filterId of this RetrievalPerFilterSearchResultWithError

error

@Nonnull
public RetrievalPerFilterSearchResultWithError error(@Nullable
 RetrievalPerFilterSearchResultError error)

Set the error of this RetrievalPerFilterSearchResultWithError instance and return the same instance.

Parameters:

error - The error of this RetrievalPerFilterSearchResultWithError

Returns:

The same instance of this RetrievalPerFilterSearchResultWithError class

getError

@Nonnull
public RetrievalPerFilterSearchResultError getError()

Get error

Returns:

error The error of this RetrievalPerFilterSearchResultWithError instance.

setError

public void setError(@Nullable
 RetrievalPerFilterSearchResultError error)

Set the error of this RetrievalPerFilterSearchResultWithError instance.

Parameters:

error - The error of this RetrievalPerFilterSearchResultWithError

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RetrievalPerFilterSearchResultWithError.

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

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