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

Class DocumentUpdateRequest

java.lang.Object

com.sap.ai.sdk.grounding.model.DocumentUpdateRequest

public class DocumentUpdateRequest
extends Object

An update request containing one or more documents to update existing documents in a collection by ID.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DocumentUpdateRequest	addDocumentsItem(DocumentInput documentsItem)	Add one documents instance to this DocumentUpdateRequest.
static DocumentUpdateRequest.Builder	create()	Create a type-safe, fluent-api builder object to construct a new DocumentUpdateRequest instance with all required arguments.
DocumentUpdateRequest	documents(List<DocumentInput> documents)	Set the documents of this DocumentUpdateRequest instance and return the same instance.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the DocumentUpdateRequest.
List<DocumentInput>	getDocuments()	Get documents
int	hashCode()
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this DocumentUpdateRequest instance.
void	setDocuments(List<DocumentInput> documents)	Set the documents of this DocumentUpdateRequest instance.
Map<String,Object>	toMap()	Get the value of all properties of this DocumentUpdateRequest instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentUpdateRequest

protected DocumentUpdateRequest()

Default constructor for DocumentUpdateRequest.

Method Details

documents

@Nonnull
public DocumentUpdateRequest documents(@Nonnull
 List<DocumentInput> documents)

Set the documents of this DocumentUpdateRequest instance and return the same instance.

Parameters:

documents - The documents of this DocumentUpdateRequest

Returns:

The same instance of this DocumentUpdateRequest class

addDocumentsItem

@Nonnull
public DocumentUpdateRequest addDocumentsItem(@Nonnull
 DocumentInput documentsItem)

Add one documents instance to this DocumentUpdateRequest.

Parameters:

documentsItem - The documents that should be added

Returns:

The same instance of type DocumentUpdateRequest

getDocuments

@Nonnull
public List<DocumentInput> getDocuments()

Get documents

Returns:

documents The documents of this DocumentUpdateRequest instance.

setDocuments

public void setDocuments(@Nonnull
 List<DocumentInput> documents)

Set the documents of this DocumentUpdateRequest instance.

Parameters:

documents - The documents of this DocumentUpdateRequest

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DocumentUpdateRequest.

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

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