Package com.oracle.bmc.generativeaiagent.model

Class CreateToolDetails

java.lang.Object

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

com.oracle.bmc.generativeaiagent.model.CreateToolDetails

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

The data to create a Tool.
Note: Objects should always be created or deserialized using the CreateToolDetails.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 CreateToolDetails.Builder, which maintain a set of all explicitly set fields called CreateToolDetails.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	CreateToolDetails.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
CreateToolDetails(String displayName, String description, String agentId, String compartmentId, ToolConfig toolConfig, Map<String,String> metadata, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateToolDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAgentId()	The OCID of the agent that this Tool is attached to.
String	getCompartmentId()	The OCID of the compartment.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	Description about the Tool.
String	getDisplayName()	A user-friendly name.
Map<String,String>	getFreeformTags()	Free-form tags for this resource.
Map<String,String>	getMetadata()	Key-value pairs to allow additional configurations.
ToolConfig	getToolConfig()
int	hashCode()
CreateToolDetails.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

CreateToolDetails

@Deprecated
@ConstructorProperties({"displayName","description","agentId","compartmentId","toolConfig","metadata","freeformTags","definedTags"})
public CreateToolDetails(String displayName,
                         String description,
                         String agentId,
                         String compartmentId,
                         ToolConfig toolConfig,
                         Map<String,String> metadata,
                         Map<String,String> freeformTags,
                         Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static CreateToolDetails.Builder builder()

Create a new builder.

toBuilder

public CreateToolDetails.Builder toBuilder()

getDisplayName

public String getDisplayName()

A user-friendly name.

Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:

the value

getDescription

public String getDescription()

Description about the Tool.

Returns:

the value

getAgentId

public String getAgentId()

The OCID of the agent that this Tool is attached to.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

Returns:

the value

getToolConfig

public ToolConfig getToolConfig()

getMetadata

public Map<String,String> getMetadata()

Key-value pairs to allow additional configurations.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Free-form tags for this resource.

Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {"Department": "Finance"}

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource.

Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

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