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

Class CollectionsListResponse

java.lang.Object

com.sap.ai.sdk.grounding.model.CollectionsListResponse

public class CollectionsListResponse
extends Object

A response containing collections retrieved from the server.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CollectionsListResponse	addResourcesItem(Collection resourcesItem)	Add one resources instance to this CollectionsListResponse.
CollectionsListResponse	count(Integer count)	Set the count of this CollectionsListResponse instance and return the same instance.
static CollectionsListResponse.Builder	create()	Create a type-safe, fluent-api builder object to construct a new CollectionsListResponse instance with all required arguments.
boolean	equals(Object o)
Integer	getCount()	Get count
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the CollectionsListResponse.
List<Collection>	getResources()	Get resources
int	hashCode()
CollectionsListResponse	resources(List<Collection> resources)	Set the resources of this CollectionsListResponse instance and return the same instance.
void	setCount(Integer count)	Set the count of this CollectionsListResponse instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this CollectionsListResponse instance.
void	setResources(List<Collection> resources)	Set the resources of this CollectionsListResponse instance.
Map<String,Object>	toMap()	Get the value of all properties of this CollectionsListResponse instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CollectionsListResponse

protected CollectionsListResponse()

Default constructor for CollectionsListResponse.

Method Details

count

@Nonnull
public CollectionsListResponse count(@Nullable
 Integer count)

Set the count of this CollectionsListResponse instance and return the same instance.

Parameters:

count - The count of this CollectionsListResponse

Returns:

The same instance of this CollectionsListResponse class

getCount

@Nonnull
public Integer getCount()

Get count

Returns:

count The count of this CollectionsListResponse instance.

setCount

public void setCount(@Nullable
 Integer count)

Set the count of this CollectionsListResponse instance.

Parameters:

count - The count of this CollectionsListResponse

resources

@Nonnull
public CollectionsListResponse resources(@Nonnull
 List<Collection> resources)

Set the resources of this CollectionsListResponse instance and return the same instance.

Parameters:

resources - The resources of this CollectionsListResponse

Returns:

The same instance of this CollectionsListResponse class

addResourcesItem

@Nonnull
public CollectionsListResponse addResourcesItem(@Nonnull
 Collection resourcesItem)

Add one resources instance to this CollectionsListResponse.

Parameters:

resourcesItem - The resources that should be added

Returns:

The same instance of type CollectionsListResponse

getResources

@Nonnull
public List<Collection> getResources()

Get resources

Returns:

resources The resources of this CollectionsListResponse instance.

setResources

public void setResources(@Nonnull
 List<Collection> resources)

Set the resources of this CollectionsListResponse instance.

Parameters:

resources - The resources of this CollectionsListResponse

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the CollectionsListResponse.

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

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