ToolOutput (Oracle Cloud Infrastructure Java SDK - 3.69.0)

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.generativeaiagentruntime.model.ToolOutput

Direct Known Subclasses:

GenericToolOutput, RagToolOutput, SqlToolOutput
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public class ToolOutput
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
Base schema for tool outputs.
Identified by toolOutputType, which determines the format of the output content.
Note: Objects should always be created or deserialized using the 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 Builder, which maintain a set of all explicitly set fields called 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 ToolOutput.ToolOutputType
Specifies the type of tool output (e.g., GENERIC_TOOL_OUTPUT, SQL_TOOL_OUTPUT).

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Modifier Constructor Description

protected ToolOutput(String toolId, String toolName)
Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`String`	`getToolId()`	Specifies the unique OCID of the tool.
`String`	`getToolName()`	Specifies the display name of the tool.
`int`	`hashCode()`
`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
  - ToolOutput
```
@Deprecated
@ConstructorProperties({"toolId","toolName"})
protected ToolOutput(String toolId,
                     String toolName)
```
    Deprecated.
- Method Detail
  - getToolId
```
public String getToolId()
```
    Specifies the unique OCID of the tool.
    
    Returns:
    
    the value
  - getToolName
```
public String getToolName()
```
    Specifies the display name of the tool.
    
    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