Tool (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.generativeaiagent.model.Tool

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

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
Note: Objects should always be created or deserialized using the Tool.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 Tool.Builder, which maintain a set of all explicitly set fields called Tool.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 Tool.Builder

static class Tool.LifecycleState
The current state of the Tool.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Tool.Builder`
`static class`	`Tool.LifecycleState` The current state of the Tool.

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
`Tool(String id, Tool.LifecycleState lifecycleState, Date timeCreated, Date timeUpdated, String displayName, String description, String compartmentId, String agentId, ToolConfig toolConfig, Map<String,String> metadata, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Tool.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 of the Tool.
`String`	`getDisplayName()` A user-friendly name.
`Map<String,String>`	`getFreeformTags()` Free-form tags for this resource.
`String`	`getId()` The OCID of the Tool.
`Tool.LifecycleState`	`getLifecycleState()` The current state of the Tool.
`Map<String,String>`	`getMetadata()` Key-value pairs to allow additional configurations.
`Map<String,Map<String,Object>>`	`getSystemTags()` System tags for this resource.
`Date`	`getTimeCreated()` The date and time the Tool was created, in the format defined by RFC 3339.
`Date`	`getTimeUpdated()` The date and time the Tool was updated, in the format defined by RFC 3339.
`ToolConfig`	`getToolConfig()`
`int`	`hashCode()`
`Tool.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

Tool

@Deprecated
 @ConstructorProperties(value={"id","lifecycleState","timeCreated","timeUpdated","displayName","description","compartmentId","agentId","toolConfig","metadata","freeformTags","definedTags","systemTags"})
public Tool(String id,
                                                                                                                                                                                                                                   Tool.LifecycleState lifecycleState,
                                                                                                                                                                                                                                   Date timeCreated,
                                                                                                                                                                                                                                   Date timeUpdated,
                                                                                                                                                                                                                                   String displayName,
                                                                                                                                                                                                                                   String description,
                                                                                                                                                                                                                                   String compartmentId,
                                                                                                                                                                                                                                   String agentId,
                                                                                                                                                                                                                                   ToolConfig toolConfig,
                                                                                                                                                                                                                                   Map<String,String> metadata,
                                                                                                                                                                                                                                   Map<String,String> freeformTags,
                                                                                                                                                                                                                                   Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                   Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail
- builder
```
public static Tool.Builder builder()
```
  Create a new builder.
- toBuilder
```
public Tool.Builder toBuilder()
```
- getId
```
public String getId()
```
  The OCID of the Tool.
  
  Returns:
  
  the value
- getLifecycleState
```
public Tool.LifecycleState getLifecycleState()
```
  The current state of the Tool.
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  The date and time the Tool was created, in the format defined by RFC 3339.
  
  Example: 2016-08-25T21:10:29.600Z
  
  Returns:
  
  the value
- getTimeUpdated
```
public Date getTimeUpdated()
```
  The date and time the Tool was updated, in the format defined by RFC 3339.
  
  Example: 2016-08-25T21:10:29.600Z
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  A user-friendly name. Does not have to be unique, and it’s changeable.
  
  Returns:
  
  the value
- getDescription
```
public String getDescription()
```
  Description of the Tool.
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment.
  
  Returns:
  
  the value
- getAgentId
```
public String getAgentId()
```
  The OCID of the agent that this Tool is attached to.
  
  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
- getSystemTags
```
public Map<String,Map<String,Object>> getSystemTags()
```
  System tags for this resource. Each key is predefined and scoped to a namespace.
  
  Example: {"orcl-cloud": {"free-tier-retained": "true"}}
  
  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

Class Tool

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Tool

Method Detail

builder

toBuilder

getId

getLifecycleState

getTimeCreated

getTimeUpdated

getDisplayName

getDescription

getCompartmentId

getAgentId

getToolConfig

getMetadata

getFreeformTags

getDefinedTags

getSystemTags

toString

toString

equals

hashCode