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

Class ListConfigurationDocuments

java.lang.Object

com.sap.ai.sdk.grounding.model.ListConfigurationDocuments

public class ListConfigurationDocuments
extends Object

ListConfigurationDocuments

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ListConfigurationDocuments	addResourcesItem(ConfigurationDocument resourcesItem)	Add one resources instance to this ListConfigurationDocuments.
ListConfigurationDocuments	count(Integer count)	Set the count of this ListConfigurationDocuments instance and return the same instance.
static ListConfigurationDocuments	create()	Create a new ListConfigurationDocuments instance.
boolean	equals(Object o)
Integer	getCount()	Total number of documents returned.
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ListConfigurationDocuments.
List<ConfigurationDocument>	getResources()	List of document objects.
int	hashCode()
ListConfigurationDocuments	resources(List<ConfigurationDocument> resources)	Set the resources of this ListConfigurationDocuments instance and return the same instance.
void	setCount(Integer count)	Set the count of this ListConfigurationDocuments instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ListConfigurationDocuments instance.
void	setResources(List<ConfigurationDocument> resources)	Set the resources of this ListConfigurationDocuments instance.
Map<String,Object>	toMap()	Get the value of all properties of this ListConfigurationDocuments instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ListConfigurationDocuments

protected ListConfigurationDocuments()

Default constructor for ListConfigurationDocuments.

Method Details

count

@Nonnull
public ListConfigurationDocuments count(@Nullable
 Integer count)

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

Parameters:

count - Total number of documents returned.

Returns:

The same instance of this ListConfigurationDocuments class

getCount

@Nonnull
public Integer getCount()

Total number of documents returned.

Returns:

count The count of this ListConfigurationDocuments instance.

setCount

public void setCount(@Nullable
 Integer count)

Set the count of this ListConfigurationDocuments instance.

Parameters:

count - Total number of documents returned.

resources

@Nonnull
public ListConfigurationDocuments resources(@Nullable
 List<ConfigurationDocument> resources)

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

Parameters:

resources - List of document objects. It will be empty array if no records found.

Returns:

The same instance of this ListConfigurationDocuments class

addResourcesItem

@Nonnull
public ListConfigurationDocuments addResourcesItem(@Nonnull
 ConfigurationDocument resourcesItem)

Add one resources instance to this ListConfigurationDocuments.

Parameters:

resourcesItem - The resources that should be added

Returns:

The same instance of type ListConfigurationDocuments

getResources

@Nonnull
public List<ConfigurationDocument> getResources()

List of document objects. It will be empty array if no records found.

Returns:

resources The resources of this ListConfigurationDocuments instance.

setResources

public void setResources(@Nullable
 List<ConfigurationDocument> resources)

Set the resources of this ListConfigurationDocuments instance.

Parameters:

resources - List of document objects. It will be empty array if no records found.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ListConfigurationDocuments.

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 ListConfigurationDocuments 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 ListConfigurationDocuments 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 ListConfigurationDocuments 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 ListConfigurationDocuments create()

Create a new ListConfigurationDocuments instance. No arguments are required.