Package com.oracle.bmc.generativeai.model

Class Parameter

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeai.model.Parameter

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class Parameter
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Defines a configurable parameter supported by a model.
Note: Objects should always be created or deserialized using the Parameter.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Parameter.Builder, which maintain a set of all explicitly set fields called Parameter.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Parameter.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
Parameter(String name, String type, Double minimum, Double maximum, String defaultValue, String description)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Parameter.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDefaultValue()	The default value used when this parameter is not supplied.
String	getDescription()	A human-readable description of this parameter.
Double	getMaximum()	The maximum allowed value for this parameter.
Double	getMinimum()	The minimum allowed value for this parameter.
String	getName()	The name of this parameter.
String	getType()	The data type of the parameter (e.g., float, integer, string).
int	hashCode()
Parameter.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

@Deprecated
@ConstructorProperties({"name","type","minimum","maximum","defaultValue","description"})
public Parameter(String name,
                 String type,
                 Double minimum,
                 Double maximum,
                 String defaultValue,
                 String description)

Deprecated.

Method Detail

builder

public static Parameter.Builder builder()

Create a new builder.

toBuilder

public Parameter.Builder toBuilder()

getName

public String getName()

The name of this parameter.

Returns:

the value

getType

public String getType()

The data type of the parameter (e.g., float, integer, string).

Returns:

the value

getMinimum

public Double getMinimum()

The minimum allowed value for this parameter.

Applicable only when type is FLOAT or INTEGER.

Returns:

the value

getMaximum

public Double getMaximum()

The maximum allowed value for this parameter.

Applicable only when type is FLOAT or INTEGER.

Returns:

the value

getDefaultValue

public String getDefaultValue()

The default value used when this parameter is not supplied.

Returns:

the value

getDescription

public String getDescription()

A human-readable description of this parameter.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel