Package com.sap.ai.sdk.orchestration.model

Class GroundingModuleConfig

java.lang.Object

com.sap.ai.sdk.orchestration.model.GroundingModuleConfig

public class GroundingModuleConfig
extends Object

GroundingModuleConfig

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

GroundingModuleConfig

protected GroundingModuleConfig()

Default constructor for GroundingModuleConfig.

Method Details

type

@Nonnull
public GroundingModuleConfig type(@Nullable
 GroundingModuleConfig.TypeEnum type)

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

Parameters:

type - The type of this GroundingModuleConfig

Returns:

The same instance of this GroundingModuleConfig class

getType

@Nullable
public GroundingModuleConfig.TypeEnum getType()

Get type

Returns:

type The type of this GroundingModuleConfig instance.

setType

public void setType(@Nullable
 GroundingModuleConfig.TypeEnum type)

Set the type of this GroundingModuleConfig instance.

Parameters:

type - The type of this GroundingModuleConfig

config

@Nonnull
public GroundingModuleConfig config(@Nonnull
 GroundingModuleConfigConfig config)

Set the config of this GroundingModuleConfig instance and return the same instance.

Parameters:

config - The config of this GroundingModuleConfig

Returns:

The same instance of this GroundingModuleConfig class

getConfig

@Nonnull
public GroundingModuleConfigConfig getConfig()

Get config

Returns:

config The config of this GroundingModuleConfig instance.

setConfig

public void setConfig(@Nonnull
 GroundingModuleConfigConfig config)

Set the config of this GroundingModuleConfig instance.

Parameters:

config - The config of this GroundingModuleConfig

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the GroundingModuleConfig.

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

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