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

Class MetadataConfiguration

java.lang.Object

com.sap.ai.sdk.grounding.model.MetadataConfiguration

All Implemented Interfaces:

CreatePipeline

public class MetadataConfiguration
extends Object
implements CreatePipeline

MetadataConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetadataConfiguration.Builder	Builder helper class.
static interface	MetadataConfiguration.Builder1	Builder helper class.
static enum	MetadataConfiguration.TypeEnum	Gets or Sets type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
MetadataConfiguration	_configuration(MetadataConfigurationStruct _configuration)	Set the _configuration of this MetadataConfiguration instance and return the same instance.
static MetadataConfiguration.Builder	create()	Create a type-safe, fluent-api builder object to construct a new MetadataConfiguration instance with all required arguments.
boolean	equals(Object o)
MetadataConfigurationStruct	getConfiguration()	Get _configuration
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the MetadataConfiguration.
MetadataConfigurationMetadata	getMetadata()	Get metadata
MetadataConfiguration.TypeEnum	getType()	Get type
int	hashCode()
MetadataConfiguration	metadata(MetadataConfigurationMetadata metadata)	Set the metadata of this MetadataConfiguration instance and return the same instance.
void	setConfiguration(MetadataConfigurationStruct _configuration)	Set the _configuration of this MetadataConfiguration instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this MetadataConfiguration instance.
void	setMetadata(MetadataConfigurationMetadata metadata)	Set the metadata of this MetadataConfiguration instance.
void	setType(MetadataConfiguration.TypeEnum type)	Set the type of this MetadataConfiguration instance.
Map<String,Object>	toMap()	Get the value of all properties of this MetadataConfiguration instance including unrecognized properties.
String	toString()
MetadataConfiguration	type(MetadataConfiguration.TypeEnum type)	Set the type of this MetadataConfiguration instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

MetadataConfiguration

protected MetadataConfiguration()

Default constructor for MetadataConfiguration.

Method Details

type

@Nonnull
public MetadataConfiguration type(@Nonnull
 MetadataConfiguration.TypeEnum type)

Set the type of this MetadataConfiguration instance and return the same instance.

Parameters:

type - The type of this MetadataConfiguration

Returns:

The same instance of this MetadataConfiguration class

getType

@Nonnull
public MetadataConfiguration.TypeEnum getType()

Get type

Specified by:

getType in interface CreatePipeline

Returns:

type The type of this MetadataConfiguration instance.

setType

public void setType(@Nonnull
 MetadataConfiguration.TypeEnum type)

Set the type of this MetadataConfiguration instance.

Parameters:

type - The type of this MetadataConfiguration

_configuration

@Nonnull
public MetadataConfiguration _configuration(@Nonnull
 MetadataConfigurationStruct _configuration)

Set the _configuration of this MetadataConfiguration instance and return the same instance.

Parameters:

_configuration - The _configuration of this MetadataConfiguration

Returns:

The same instance of this MetadataConfiguration class

getConfiguration

@Nonnull
public MetadataConfigurationStruct getConfiguration()

Get _configuration

Returns:

_configuration The _configuration of this MetadataConfiguration instance.

setConfiguration

public void setConfiguration(@Nonnull
 MetadataConfigurationStruct _configuration)

Set the _configuration of this MetadataConfiguration instance.

Parameters:

_configuration - The _configuration of this MetadataConfiguration

metadata

@Nonnull
public MetadataConfiguration metadata(@Nullable
 MetadataConfigurationMetadata metadata)

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

Parameters:

metadata - The metadata of this MetadataConfiguration

Returns:

The same instance of this MetadataConfiguration class

getMetadata

@Nonnull
public MetadataConfigurationMetadata getMetadata()

Get metadata

Returns:

metadata The metadata of this MetadataConfiguration instance.

setMetadata

public void setMetadata(@Nullable
 MetadataConfigurationMetadata metadata)

Set the metadata of this MetadataConfiguration instance.

Parameters:

metadata - The metadata of this MetadataConfiguration

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the MetadataConfiguration.

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

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