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

Class DocumentMetadataUpdate

java.lang.Object

com.sap.ai.sdk.grounding.model.DocumentMetadataUpdate

All Implemented Interfaces:

BatchUpdateDocumentsResponseInner

public class DocumentMetadataUpdate
extends Object
implements BatchUpdateDocumentsResponseInner

DocumentMetadataUpdate

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentMetadataUpdate

protected DocumentMetadataUpdate()

Default constructor for DocumentMetadataUpdate.

Method Details

id

@Nonnull
public DocumentMetadataUpdate id(@Nonnull
 UUID id)

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

Parameters:

id - Unique identifier of the document to update.

Returns:

The same instance of this DocumentMetadataUpdate class

getId

@Nonnull
public UUID getId()

Unique identifier of the document to update.

Returns:

id The id of this DocumentMetadataUpdate instance.

setId

public void setId(@Nonnull
 UUID id)

Set the id of this DocumentMetadataUpdate instance.

Parameters:

id - Unique identifier of the document to update.

metadata

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

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

Parameters:

metadata - Metadata updates for this document.

Returns:

The same instance of this DocumentMetadataUpdate class

addMetadataItem

@Nonnull
public DocumentMetadataUpdate addMetadataItem(@Nonnull
 DocumentMetadata metadataItem)

Add one metadata instance to this DocumentMetadataUpdate.

Parameters:

metadataItem - The metadata that should be added

Returns:

The same instance of type DocumentMetadataUpdate

getMetadata

@Nonnull
public List<DocumentMetadata> getMetadata()

Metadata updates for this document.

Returns:

metadata The metadata of this DocumentMetadataUpdate instance.

setMetadata

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

Set the metadata of this DocumentMetadataUpdate instance.

Parameters:

metadata - Metadata updates for this document.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DocumentMetadataUpdate.

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

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