Package com.oracle.bmc.generativeaiagentruntime.model

Class SqlToolOutput

java.lang.Object

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

com.oracle.bmc.generativeaiagentruntime.model.ToolOutput

com.oracle.bmc.generativeaiagentruntime.model.SqlToolOutput

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class SqlToolOutput
extends ToolOutput

Specifies the output format for SQL tools, including the generated SQL statement and an optional preview of the query result.
Note: Objects should always be created or deserialized using the SqlToolOutput.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 SqlToolOutput.Builder, which maintain a set of all explicitly set fields called SqlToolOutput.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	SqlToolOutput.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.generativeaiagentruntime.model.ToolOutput

ToolOutput.ToolOutputType

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
SqlToolOutput(String toolId, String toolName, String generatedSql, List<Object> result, SqlResultFiles resultFiles, String additionalInfo)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SqlToolOutput.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAdditionalInfo()	Specifies optional metadata content.
String	getGeneratedSql()	Specifies the generated SQL query.
List<Object>	getResult()	Represents preview rows from the SQL query.
SqlResultFiles	getResultFiles()
int	hashCode()
SqlToolOutput.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.generativeaiagentruntime.model.ToolOutput

getToolId, getToolName

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

SqlToolOutput

@Deprecated
public SqlToolOutput(String toolId,
                     String toolName,
                     String generatedSql,
                     List<Object> result,
                     SqlResultFiles resultFiles,
                     String additionalInfo)

Deprecated.

Method Detail

builder

public static SqlToolOutput.Builder builder()

Create a new builder.

toBuilder

public SqlToolOutput.Builder toBuilder()

getGeneratedSql

public String getGeneratedSql()

Specifies the generated SQL query.

Returns:

the value

getResult

public List<Object> getResult()

Represents preview rows from the SQL query.

Returns:

the value

getResultFiles

public SqlResultFiles getResultFiles()

getAdditionalInfo

public String getAdditionalInfo()

Specifies optional metadata content.

Returns:

the value

toString

public String toString()

Overrides:

toString in class ToolOutput

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class ToolOutput

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class ToolOutput

hashCode

public int hashCode()

Overrides:

hashCode in class ToolOutput