Package com.sap.ai.sdk.core.model

Class RTAExecutableParameter

java.lang.Object

com.sap.ai.sdk.core.model.RTAExecutableParameter

public class RTAExecutableParameter
extends Object

Argument of an executable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RTAExecutableParameter.Builder	Builder helper class.
static enum	RTAExecutableParameter.TypeEnum	Type of the signature argument

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
RTAExecutableParameter	_default(String _default)	Set the _default of this RTAExecutableParameter instance and return the same instance.
static RTAExecutableParameter.Builder	create()	Create a type-safe, fluent-api builder object to construct a new RTAExecutableParameter instance with all required arguments.
RTAExecutableParameter	description(String description)	Set the description of this RTAExecutableParameter instance and return the same instance.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the RTAExecutableParameter.
String	getDefault()	Default value of the signature argument
String	getDescription()	Description of the signature argument
String	getName()	Name of the signature argument
RTAExecutableParameter.TypeEnum	getType()	Type of the signature argument
int	hashCode()
RTAExecutableParameter	name(String name)	Set the name of this RTAExecutableParameter instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this RTAExecutableParameter instance.
void	setDefault(String _default)	Set the _default of this RTAExecutableParameter instance.
void	setDescription(String description)	Set the description of this RTAExecutableParameter instance.
void	setName(String name)	Set the name of this RTAExecutableParameter instance.
void	setType(RTAExecutableParameter.TypeEnum type)	Set the type of this RTAExecutableParameter instance.
Map<String,Object>	toMap()	Get the value of all properties of this RTAExecutableParameter instance including unrecognized properties.
String	toString()
RTAExecutableParameter	type(RTAExecutableParameter.TypeEnum type)	Set the type of this RTAExecutableParameter instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

RTAExecutableParameter

protected RTAExecutableParameter()

Default constructor for RTAExecutableParameter.

Method Details

name

@Nonnull
public RTAExecutableParameter name(@Nonnull
 String name)

Set the name of this RTAExecutableParameter instance and return the same instance.

Parameters:

name - Name of the signature argument

Returns:

The same instance of this RTAExecutableParameter class

getName

@Nonnull
public String getName()

Name of the signature argument

Returns:

name The name of this RTAExecutableParameter instance.

setName

public void setName(@Nonnull
 String name)

Set the name of this RTAExecutableParameter instance.

Parameters:

name - Name of the signature argument

description

@Nonnull
public RTAExecutableParameter description(@Nullable
 String description)

Set the description of this RTAExecutableParameter instance and return the same instance.

Parameters:

description - Description of the signature argument

Returns:

The same instance of this RTAExecutableParameter class

getDescription

@Nonnull
public String getDescription()

Description of the signature argument

Returns:

description The description of this RTAExecutableParameter instance.

setDescription

public void setDescription(@Nullable
 String description)

Set the description of this RTAExecutableParameter instance.

Parameters:

description - Description of the signature argument

_default

@Nonnull
public RTAExecutableParameter _default(@Nullable
 String _default)

Set the _default of this RTAExecutableParameter instance and return the same instance.

Parameters:

_default - Default value of the signature argument

Returns:

The same instance of this RTAExecutableParameter class

getDefault

@Nonnull
public String getDefault()

Default value of the signature argument

Returns:

_default The _default of this RTAExecutableParameter instance.

setDefault

public void setDefault(@Nullable
 String _default)

Set the _default of this RTAExecutableParameter instance.

Parameters:

_default - Default value of the signature argument

type

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

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

Parameters:

type - Type of the signature argument

Returns:

The same instance of this RTAExecutableParameter class

getType

@Nonnull
public RTAExecutableParameter.TypeEnum getType()

Type of the signature argument

Returns:

type The type of this RTAExecutableParameter instance.

setType

public void setType(@Nullable
 RTAExecutableParameter.TypeEnum type)

Set the type of this RTAExecutableParameter instance.

Parameters:

type - Type of the signature argument

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the RTAExecutableParameter.

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

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