com.oracle.bmc.generativeaiinference.model

Class CohereParameterDefinition

java.lang.Object

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

com.oracle.bmc.generativeaiinference.model.CohereParameterDefinition

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

A definition of tool parameter.
Note: Objects should always be created or deserialized using the CohereParameterDefinition.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 CohereParameterDefinition.Builder, which maintain a set of all explicitly set fields called CohereParameterDefinition.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 and Description
static class	CohereParameterDefinition.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 and Description
CohereParameterDefinition(String description, String type, Boolean isRequired) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CohereParameterDefinition.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getDescription() The description of the parameter.
Boolean	getIsRequired() Denotes whether the parameter is always present (required) or not.
String	getType() The type of the parameter.
int	hashCode()
CohereParameterDefinition.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

CohereParameterDefinition

@Deprecated
 @ConstructorProperties(value={"description","type","isRequired"})
public CohereParameterDefinition(String description,
                                                                                                                String type,
                                                                                                                Boolean isRequired)

Deprecated.

Method Detail

builder

public static CohereParameterDefinition.Builder builder()

Create a new builder.

toBuilder

public CohereParameterDefinition.Builder toBuilder()

getDescription

public String getDescription()

The description of the parameter.

Returns:

the value

getType

public String getType()

The type of the parameter. Must be a valid Python type.

Returns:

the value

getIsRequired

public Boolean getIsRequired()

Denotes whether the parameter is always present (required) or not. Defaults to not required.

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