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

Class BatchUpdateDocumentSuccess

java.lang.Object

com.sap.ai.sdk.grounding.model.BatchUpdateDocumentSuccess

public class BatchUpdateDocumentSuccess
extends Object

BatchUpdateDocumentSuccess

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchUpdateDocumentSuccess.Builder	Builder helper class.
static interface	BatchUpdateDocumentSuccess.Builder1	Builder helper class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BatchUpdateDocumentSuccess	addMetadataItem(DocumentMetadata metadataItem)	Add one metadata instance to this BatchUpdateDocumentSuccess.
static BatchUpdateDocumentSuccess.Builder	create()	Create a type-safe, fluent-api builder object to construct a new BatchUpdateDocumentSuccess 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 BatchUpdateDocumentSuccess.
UUID	getId()	Unique identifier of the document.
List<DocumentMetadata>	getMetadata()	Metadata updates for this document.
int	hashCode()
BatchUpdateDocumentSuccess	id(UUID id)	Set the id of this BatchUpdateDocumentSuccess instance and return the same instance.
BatchUpdateDocumentSuccess	metadata(List<DocumentMetadata> metadata)	Set the metadata of this BatchUpdateDocumentSuccess instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this BatchUpdateDocumentSuccess instance.
void	setId(UUID id)	Set the id of this BatchUpdateDocumentSuccess instance.
void	setMetadata(List<DocumentMetadata> metadata)	Set the metadata of this BatchUpdateDocumentSuccess instance.
Map<String,Object>	toMap()	Get the value of all properties of this BatchUpdateDocumentSuccess instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

BatchUpdateDocumentSuccess

protected BatchUpdateDocumentSuccess()

Default constructor for BatchUpdateDocumentSuccess.

Method Details

id

@Nonnull
public BatchUpdateDocumentSuccess id(@Nonnull
 UUID id)

Set the id of this BatchUpdateDocumentSuccess instance and return the same instance.

Parameters:

id - Unique identifier of the document.

Returns:

The same instance of this BatchUpdateDocumentSuccess class

getId

@Nonnull
public UUID getId()

Unique identifier of the document.

Returns:

id The id of this BatchUpdateDocumentSuccess instance.

setId

public void setId(@Nonnull
 UUID id)

Set the id of this BatchUpdateDocumentSuccess instance.

Parameters:

id - Unique identifier of the document.

metadata

@Nonnull
public BatchUpdateDocumentSuccess metadata(@Nonnull
 List<DocumentMetadata> metadata)

Set the metadata of this BatchUpdateDocumentSuccess instance and return the same instance.

Parameters:

metadata - Metadata updates for this document.

Returns:

The same instance of this BatchUpdateDocumentSuccess class

addMetadataItem

@Nonnull
public BatchUpdateDocumentSuccess addMetadataItem(@Nonnull
 DocumentMetadata metadataItem)

Add one metadata instance to this BatchUpdateDocumentSuccess.

Parameters:

metadataItem - The metadata that should be added

Returns:

The same instance of type BatchUpdateDocumentSuccess

getMetadata

@Nonnull
public List<DocumentMetadata> getMetadata()

Metadata updates for this document.

Returns:

metadata The metadata of this BatchUpdateDocumentSuccess instance.

setMetadata

public void setMetadata(@Nonnull
 List<DocumentMetadata> metadata)

Set the metadata of this BatchUpdateDocumentSuccess instance.

Parameters:

metadata - Metadata updates for this document.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the BatchUpdateDocumentSuccess.

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

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