Package com.sap.ai.sdk.prompt.registry.model

Class DPIStandardEntity

java.lang.Object

com.sap.ai.sdk.prompt.registry.model.DPIStandardEntity

All Implemented Interfaces:

DPIEntityConfig

public class DPIStandardEntity
extends Object
implements DPIEntityConfig

DPIStandardEntity

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static DPIStandardEntity.Builder	create()	Create a type-safe, fluent-api builder object to construct a new DPIStandardEntity 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 DPIStandardEntity.
DPIStandardEntityReplacementStrategy	getReplacementStrategy()	Get replacementStrategy
DPIEntities	getType()	Get type
int	hashCode()
DPIStandardEntity	replacementStrategy(DPIStandardEntityReplacementStrategy replacementStrategy)	Set the replacementStrategy of this DPIStandardEntity instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this DPIStandardEntity instance.
void	setReplacementStrategy(DPIStandardEntityReplacementStrategy replacementStrategy)	Set the replacementStrategy of this DPIStandardEntity instance.
void	setType(DPIEntities type)	Set the type of this DPIStandardEntity instance.
Map<String,Object>	toMap()	Get the value of all properties of this DPIStandardEntity instance including unrecognized properties.
String	toString()
DPIStandardEntity	type(DPIEntities type)	Set the type of this DPIStandardEntity instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

DPIStandardEntity

protected DPIStandardEntity()

Default constructor for DPIStandardEntity.

Method Details

type

@Nonnull
public DPIStandardEntity type(@Nonnull
 DPIEntities type)

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

Parameters:

type - The type of this DPIStandardEntity

Returns:

The same instance of this DPIStandardEntity class

getType

@Nonnull
public DPIEntities getType()

Get type

Returns:

type The type of this DPIStandardEntity instance.

setType

public void setType(@Nonnull
 DPIEntities type)

Set the type of this DPIStandardEntity instance.

Parameters:

type - The type of this DPIStandardEntity

replacementStrategy

@Nonnull
public DPIStandardEntity replacementStrategy(@Nullable
 DPIStandardEntityReplacementStrategy replacementStrategy)

Set the replacementStrategy of this DPIStandardEntity instance and return the same instance.

Parameters:

replacementStrategy - The replacementStrategy of this DPIStandardEntity

Returns:

The same instance of this DPIStandardEntity class

getReplacementStrategy

@Nonnull
public DPIStandardEntityReplacementStrategy getReplacementStrategy()

Get replacementStrategy

Returns:

replacementStrategy The replacementStrategy of this DPIStandardEntity instance.

setReplacementStrategy

public void setReplacementStrategy(@Nullable
 DPIStandardEntityReplacementStrategy replacementStrategy)

Set the replacementStrategy of this DPIStandardEntity instance.

Parameters:

replacementStrategy - The replacementStrategy of this DPIStandardEntity

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the DPIStandardEntity.

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

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