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

Class DocumentBulkDeleteRequest

java.lang.Object

com.sap.ai.sdk.grounding.model.DocumentBulkDeleteRequest

public class DocumentBulkDeleteRequest
extends Object

A request to delete documents by their IDs.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DocumentBulkDeleteRequest	addIdsItem(UUID idsItem)	Add one ids instance to this DocumentBulkDeleteRequest.
static DocumentBulkDeleteRequest.Builder	create()	Create a type-safe, fluent-api builder object to construct a new DocumentBulkDeleteRequest 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 DocumentBulkDeleteRequest.
List<UUID>	getIds()	List of document IDs to delete
int	hashCode()
DocumentBulkDeleteRequest	ids(List<UUID> ids)	Set the ids of this DocumentBulkDeleteRequest instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this DocumentBulkDeleteRequest instance.
void	setIds(List<UUID> ids)	Set the ids of this DocumentBulkDeleteRequest instance.
Map<String,Object>	toMap()	Get the value of all properties of this DocumentBulkDeleteRequest instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentBulkDeleteRequest

protected DocumentBulkDeleteRequest()

Default constructor for DocumentBulkDeleteRequest.

Method Details

ids

@Nonnull
public DocumentBulkDeleteRequest ids(@Nonnull
 List<UUID> ids)

Set the ids of this DocumentBulkDeleteRequest instance and return the same instance.

Parameters:

ids - List of document IDs to delete

Returns:

The same instance of this DocumentBulkDeleteRequest class

addIdsItem

@Nonnull
public DocumentBulkDeleteRequest addIdsItem(@Nonnull
 UUID idsItem)

Add one ids instance to this DocumentBulkDeleteRequest.

Parameters:

idsItem - The ids that should be added

Returns:

The same instance of type DocumentBulkDeleteRequest

getIds

@Nonnull
public List<UUID> getIds()

List of document IDs to delete

Returns:

ids The ids of this DocumentBulkDeleteRequest instance.

setIds

public void setIds(@Nonnull
 List<UUID> ids)

Set the ids of this DocumentBulkDeleteRequest instance.

Parameters:

ids - List of document IDs to delete

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DocumentBulkDeleteRequest.

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

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