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

Class DocumentMetadataBatchRequest

java.lang.Object

com.sap.ai.sdk.grounding.model.DocumentMetadataBatchRequest

public class DocumentMetadataBatchRequest
extends Object

DocumentMetadataBatchRequest

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DocumentMetadataBatchRequest	addValueItem(DocumentMetadataUpdate valueItem)	Add one value instance to this DocumentMetadataBatchRequest.
static DocumentMetadataBatchRequest.Builder	create()	Create a type-safe, fluent-api builder object to construct a new DocumentMetadataBatchRequest 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 DocumentMetadataBatchRequest.
List<DocumentMetadataUpdate>	getValue()	List of document metadata updates to be applied in batch.
int	hashCode()
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this DocumentMetadataBatchRequest instance.
void	setValue(List<DocumentMetadataUpdate> value)	Set the value of this DocumentMetadataBatchRequest instance.
Map<String,Object>	toMap()	Get the value of all properties of this DocumentMetadataBatchRequest instance including unrecognized properties.
String	toString()
DocumentMetadataBatchRequest	value(List<DocumentMetadataUpdate> value)	Set the value of this DocumentMetadataBatchRequest instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentMetadataBatchRequest

protected DocumentMetadataBatchRequest()

Default constructor for DocumentMetadataBatchRequest.

Method Details

value

@Nonnull
public DocumentMetadataBatchRequest value(@Nonnull
 List<DocumentMetadataUpdate> value)

Set the value of this DocumentMetadataBatchRequest instance and return the same instance.

Parameters:

value - List of document metadata updates to be applied in batch.

Returns:

The same instance of this DocumentMetadataBatchRequest class

addValueItem

@Nonnull
public DocumentMetadataBatchRequest addValueItem(@Nonnull
 DocumentMetadataUpdate valueItem)

Add one value instance to this DocumentMetadataBatchRequest.

Parameters:

valueItem - The value that should be added

Returns:

The same instance of type DocumentMetadataBatchRequest

getValue

@Nonnull
public List<DocumentMetadataUpdate> getValue()

List of document metadata updates to be applied in batch.

Returns:

value The value of this DocumentMetadataBatchRequest instance.

setValue

public void setValue(@Nonnull
 List<DocumentMetadataUpdate> value)

Set the value of this DocumentMetadataBatchRequest instance.

Parameters:

value - List of document metadata updates to be applied in batch.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DocumentMetadataBatchRequest.

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

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