Package com.sap.ai.sdk.grounding.model
Class ConfigurationDocument
java.lang.Object
com.sap.ai.sdk.grounding.model.ConfigurationDocument
ConfigurationDocument
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDefault constructor for ConfigurationDocument. -
Method Summary
Modifier and TypeMethodDescriptionabsoluteFilePath(String absoluteFilePath) Set the absoluteFilePath of thisConfigurationDocumentinstance and return the same instance.addMetadataItem(DocumentMetadata metadataItem) Add one metadata instance to thisConfigurationDocument.static ConfigurationDocumentcreate()Create a newConfigurationDocumentinstance.createdTimestamp(OffsetDateTime createdTimestamp) Set the createdTimestamp of thisConfigurationDocumentinstance and return the same instance.booleanAbsolute file path of the document in the repository.UTC timestamp when the document was created (RFC 3339 format, e.g., 2025-08-28T06:15:30Z)getCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theConfigurationDocument.getId()Unique identifier for the document.Metadata key-value pairs associated with the document.getTitle()Title of the document.getType()Get typeinthashCode()Set the id of thisConfigurationDocumentinstance and return the same instance.metadata(List<DocumentMetadata> metadata) Set the metadata of thisConfigurationDocumentinstance and return the same instance.voidsetAbsoluteFilePath(String absoluteFilePath) Set the absoluteFilePath of thisConfigurationDocumentinstance.voidsetCreatedTimestamp(OffsetDateTime createdTimestamp) Set the createdTimestamp of thisConfigurationDocumentinstance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisConfigurationDocumentinstance.voidSet the id of thisConfigurationDocumentinstance.voidsetMetadata(List<DocumentMetadata> metadata) Set the metadata of thisConfigurationDocumentinstance.voidSet the title of thisConfigurationDocumentinstance.voidSet the type of thisConfigurationDocumentinstance.Set the title of thisConfigurationDocumentinstance and return the same instance.toMap()Get the value of all properties of thisConfigurationDocumentinstance including unrecognized properties.toString()Set the type of thisConfigurationDocumentinstance and return the same instance.
-
Constructor Details
-
ConfigurationDocument
protected ConfigurationDocument()Default constructor for ConfigurationDocument.
-
-
Method Details
-
id
Set the id of thisConfigurationDocumentinstance and return the same instance.- Parameters:
id- Unique identifier for the document.- Returns:
- The same instance of this
ConfigurationDocumentclass
-
getId
Unique identifier for the document.- Returns:
- id The id of this
ConfigurationDocumentinstance.
-
setId
Set the id of thisConfigurationDocumentinstance.- Parameters:
id- Unique identifier for the document.
-
title
Set the title of thisConfigurationDocumentinstance and return the same instance.- Parameters:
title- Title of the document.- Returns:
- The same instance of this
ConfigurationDocumentclass
-
getTitle
Title of the document.- Returns:
- title The title of this
ConfigurationDocumentinstance.
-
setTitle
Set the title of thisConfigurationDocumentinstance.- Parameters:
title- Title of the document.
-
absoluteFilePath
Set the absoluteFilePath of thisConfigurationDocumentinstance and return the same instance.- Parameters:
absoluteFilePath- Absolute file path of the document in the repository.- Returns:
- The same instance of this
ConfigurationDocumentclass
-
getAbsoluteFilePath
Absolute file path of the document in the repository.- Returns:
- absoluteFilePath The absoluteFilePath of this
ConfigurationDocumentinstance.
-
setAbsoluteFilePath
Set the absoluteFilePath of thisConfigurationDocumentinstance.- Parameters:
absoluteFilePath- Absolute file path of the document in the repository.
-
createdTimestamp
Set the createdTimestamp of thisConfigurationDocumentinstance and return the same instance.- Parameters:
createdTimestamp- UTC timestamp when the document was created (RFC 3339 format, e.g., 2025-08-28T06:15:30Z)- Returns:
- The same instance of this
ConfigurationDocumentclass
-
getCreatedTimestamp
UTC timestamp when the document was created (RFC 3339 format, e.g., 2025-08-28T06:15:30Z)- Returns:
- createdTimestamp The createdTimestamp of this
ConfigurationDocumentinstance.
-
setCreatedTimestamp
Set the createdTimestamp of thisConfigurationDocumentinstance.- Parameters:
createdTimestamp- UTC timestamp when the document was created (RFC 3339 format, e.g., 2025-08-28T06:15:30Z)
-
type
Set the type of thisConfigurationDocumentinstance and return the same instance.- Parameters:
type- The type of thisConfigurationDocument- Returns:
- The same instance of this
ConfigurationDocumentclass
-
getType
Get type- Returns:
- type The type of this
ConfigurationDocumentinstance.
-
setType
Set the type of thisConfigurationDocumentinstance.- Parameters:
type- The type of thisConfigurationDocument
-
metadata
Set the metadata of thisConfigurationDocumentinstance and return the same instance.- Parameters:
metadata- Metadata key-value pairs associated with the document.- Returns:
- The same instance of this
ConfigurationDocumentclass
-
addMetadataItem
Add one metadata instance to thisConfigurationDocument.- Parameters:
metadataItem- The metadata that should be added- Returns:
- The same instance of type
ConfigurationDocument
-
getMetadata
Metadata key-value pairs associated with the document.- Returns:
- metadata The metadata of this
ConfigurationDocumentinstance.
-
setMetadata
Set the metadata of thisConfigurationDocumentinstance.- Parameters:
metadata- Metadata key-value pairs associated with the document.
-
getCustomFieldNames
Get the names of the unrecognizable properties of theConfigurationDocument.- Returns:
- The set of properties names
-
getCustomField
@Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException Deprecated.UsetoMap()instead.Get the value of an unrecognizable property of thisConfigurationDocumentinstance.- 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
Get the value of all properties of thisConfigurationDocumentinstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisConfigurationDocumentinstance. 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 propertycustomFieldValue- The value of the property
-
equals
-
hashCode
public int hashCode() -
toString
-
create
Create a newConfigurationDocumentinstance. No arguments are required.
-
toMap()instead.