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

Class PerFilterSearchResultWithError

java.lang.Object

com.sap.ai.sdk.grounding.model.PerFilterSearchResultWithError

public class PerFilterSearchResultWithError
extends Object

PerFilterSearchResultWithError

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

PerFilterSearchResultWithError

protected PerFilterSearchResultWithError()

Default constructor for PerFilterSearchResultWithError.

Method Details

filterId

@Nonnull
public PerFilterSearchResultWithError filterId(@Nonnull
 String filterId)

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

Parameters:

filterId - The filterId of this PerFilterSearchResultWithError

Returns:

The same instance of this PerFilterSearchResultWithError class

getFilterId

@Nonnull
public String getFilterId()

Get filterId

Returns:

filterId The filterId of this PerFilterSearchResultWithError instance.

setFilterId

public void setFilterId(@Nonnull
 String filterId)

Set the filterId of this PerFilterSearchResultWithError instance.

Parameters:

filterId - The filterId of this PerFilterSearchResultWithError

error

@Nonnull
public PerFilterSearchResultWithError error(@Nullable
 PerFilterSearchResultError error)

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

Parameters:

error - The error of this PerFilterSearchResultWithError

Returns:

The same instance of this PerFilterSearchResultWithError class

getError

@Nonnull
public PerFilterSearchResultError getError()

Get error

Returns:

error The error of this PerFilterSearchResultWithError instance.

setError

public void setError(@Nullable
 PerFilterSearchResultError error)

Set the error of this PerFilterSearchResultWithError instance.

Parameters:

error - The error of this PerFilterSearchResultWithError

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the PerFilterSearchResultWithError.

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

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