Class Tool (0.1.0)

public final class Tool extends GeneratedMessage implements ToolOrBuilder

A tool represents an action that the CES agent can take to achieve certain goals.

Protobuf type google.cloud.ces.v1.Tool

Implements

ToolOrBuilder

Static Fields

CLIENT_FUNCTION_FIELD_NUMBER

public static final int CLIENT_FUNCTION_FIELD_NUMBER
Field Value
Type Description
int

CONNECTOR_TOOL_FIELD_NUMBER

public static final int CONNECTOR_TOOL_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATA_STORE_TOOL_FIELD_NUMBER

public static final int DATA_STORE_TOOL_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_TYPE_FIELD_NUMBER

public static final int EXECUTION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

FILE_SEARCH_TOOL_FIELD_NUMBER

public static final int FILE_SEARCH_TOOL_FIELD_NUMBER
Field Value
Type Description
int

GENERATED_SUMMARY_FIELD_NUMBER

public static final int GENERATED_SUMMARY_FIELD_NUMBER
Field Value
Type Description
int

GOOGLE_SEARCH_TOOL_FIELD_NUMBER

public static final int GOOGLE_SEARCH_TOOL_FIELD_NUMBER
Field Value
Type Description
int

MCP_TOOL_FIELD_NUMBER

public static final int MCP_TOOL_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPEN_API_TOOL_FIELD_NUMBER

public static final int OPEN_API_TOOL_FIELD_NUMBER
Field Value
Type Description
int

PYTHON_FUNCTION_FIELD_NUMBER

public static final int PYTHON_FUNCTION_FIELD_NUMBER
Field Value
Type Description
int

SYSTEM_TOOL_FIELD_NUMBER

public static final int SYSTEM_TOOL_FIELD_NUMBER
Field Value
Type Description
int

TOOL_FAKE_CONFIG_FIELD_NUMBER

public static final int TOOL_FAKE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

WIDGET_TOOL_FIELD_NUMBER

public static final int WIDGET_TOOL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Tool getDefaultInstance()
Returns
Type Description
Tool

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Tool.Builder newBuilder()
Returns
Type Description
Tool.Builder

newBuilder(Tool prototype)

public static Tool.Builder newBuilder(Tool prototype)
Parameter
Name Description
prototype Tool
Returns
Type Description
Tool.Builder

parseDelimitedFrom(InputStream input)

public static Tool parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Tool
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Tool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Tool parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Tool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Tool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Tool parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Tool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Tool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Tool parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Tool
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Tool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Tool parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Tool
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Tool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Tool parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Tool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Tool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Tool> parser()
Returns
Type Description
Parser<Tool>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getClientFunction()

public ClientFunction getClientFunction()

Optional. The client function.

.google.cloud.ces.v1.ClientFunction client_function = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientFunction

The clientFunction.

getClientFunctionOrBuilder()

public ClientFunctionOrBuilder getClientFunctionOrBuilder()

Optional. The client function.

.google.cloud.ces.v1.ClientFunction client_function = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientFunctionOrBuilder

getConnectorTool()

public ConnectorTool getConnectorTool()

Optional. The Integration Connector tool.

.google.cloud.ces.v1.ConnectorTool connector_tool = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConnectorTool

The connectorTool.

getConnectorToolOrBuilder()

public ConnectorToolOrBuilder getConnectorToolOrBuilder()

Optional. The Integration Connector tool.

.google.cloud.ces.v1.ConnectorTool connector_tool = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConnectorToolOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when the tool was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the tool was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDataStoreTool()

public DataStoreTool getDataStoreTool()

Optional. The data store tool.

.google.cloud.ces.v1.DataStoreTool data_store_tool = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreTool

The dataStoreTool.

getDataStoreToolOrBuilder()

public DataStoreToolOrBuilder getDataStoreToolOrBuilder()

Optional. The data store tool.

.google.cloud.ces.v1.DataStoreTool data_store_tool = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreToolOrBuilder

getDefaultInstanceForType()

public Tool getDefaultInstanceForType()
Returns
Type Description
Tool

getDisplayName()

public String getDisplayName()

Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its name property.

string display_name = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its name property.

string display_name = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 14;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 14;

Returns
Type Description
ByteString

The bytes for etag.

getExecutionType()

public ExecutionType getExecutionType()

Optional. The execution type of the tool.

.google.cloud.ces.v1.ExecutionType execution_type = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExecutionType

The executionType.

getExecutionTypeValue()

public int getExecutionTypeValue()

Optional. The execution type of the tool.

.google.cloud.ces.v1.ExecutionType execution_type = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for executionType.

getFileSearchTool()

public FileSearchTool getFileSearchTool()

Optional. The file search tool.

.google.cloud.ces.v1.FileSearchTool file_search_tool = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FileSearchTool

The fileSearchTool.

getFileSearchToolOrBuilder()

public FileSearchToolOrBuilder getFileSearchToolOrBuilder()

Optional. The file search tool.

.google.cloud.ces.v1.FileSearchTool file_search_tool = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FileSearchToolOrBuilder

getGeneratedSummary()

public String getGeneratedSummary()

Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.

string generated_summary = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The generatedSummary.

getGeneratedSummaryBytes()

public ByteString getGeneratedSummaryBytes()

Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.

string generated_summary = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for generatedSummary.

getGoogleSearchTool()

public GoogleSearchTool getGoogleSearchTool()

Optional. The google search tool.

.google.cloud.ces.v1.GoogleSearchTool google_search_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GoogleSearchTool

The googleSearchTool.

getGoogleSearchToolOrBuilder()

public GoogleSearchToolOrBuilder getGoogleSearchToolOrBuilder()

Optional. The google search tool.

.google.cloud.ces.v1.GoogleSearchTool google_search_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GoogleSearchToolOrBuilder

getMcpTool()

public McpTool getMcpTool()

Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.

.google.cloud.ces.v1.McpTool mcp_tool = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
McpTool

The mcpTool.

getMcpToolOrBuilder()

public McpToolOrBuilder getMcpToolOrBuilder()

Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.

.google.cloud.ces.v1.McpTool mcp_tool = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
McpToolOrBuilder

getName()

public String getName()

Identifier. The unique identifier of the tool. Format:

  • projects/{project}/locations/{location}/apps/{app}/tools/{tool} for

    standalone tools.

    projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The unique identifier of the tool. Format:

  • projects/{project}/locations/{location}/apps/{app}/tools/{tool} for

    standalone tools.

    projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getOpenApiTool()

public OpenApiTool getOpenApiTool()

Optional. The open API tool.

.google.cloud.ces.v1.OpenApiTool open_api_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OpenApiTool

The openApiTool.

getOpenApiToolOrBuilder()

public OpenApiToolOrBuilder getOpenApiToolOrBuilder()

Optional. The open API tool.

.google.cloud.ces.v1.OpenApiTool open_api_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OpenApiToolOrBuilder

getParserForType()

public Parser<Tool> getParserForType()
Returns
Type Description
Parser<Tool>
Overrides

getPythonFunction()

public PythonFunction getPythonFunction()

Optional. The python function tool.

.google.cloud.ces.v1.PythonFunction python_function = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PythonFunction

The pythonFunction.

getPythonFunctionOrBuilder()

public PythonFunctionOrBuilder getPythonFunctionOrBuilder()

Optional. The python function tool.

.google.cloud.ces.v1.PythonFunction python_function = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PythonFunctionOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSystemTool()

public SystemTool getSystemTool()

Optional. The system tool.

.google.cloud.ces.v1.SystemTool system_tool = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SystemTool

The systemTool.

getSystemToolOrBuilder()

public SystemToolOrBuilder getSystemToolOrBuilder()

Optional. The system tool.

.google.cloud.ces.v1.SystemTool system_tool = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SystemToolOrBuilder

getToolFakeConfig()

public ToolFakeConfig getToolFakeConfig()

Optional. Configuration for tool behavior in fake mode.

.google.cloud.ces.v1.ToolFakeConfig tool_fake_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolFakeConfig

The toolFakeConfig.

getToolFakeConfigOrBuilder()

public ToolFakeConfigOrBuilder getToolFakeConfigOrBuilder()

Optional. Configuration for tool behavior in fake mode.

.google.cloud.ces.v1.ToolFakeConfig tool_fake_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolFakeConfigOrBuilder

getToolTypeCase()

public Tool.ToolTypeCase getToolTypeCase()
Returns
Type Description
Tool.ToolTypeCase

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when the tool was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when the tool was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getWidgetTool()

public WidgetTool getWidgetTool()

Optional. The widget tool.

.google.cloud.ces.v1.WidgetTool widget_tool = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WidgetTool

The widgetTool.

getWidgetToolOrBuilder()

public WidgetToolOrBuilder getWidgetToolOrBuilder()

Optional. The widget tool.

.google.cloud.ces.v1.WidgetTool widget_tool = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WidgetToolOrBuilder

hasClientFunction()

public boolean hasClientFunction()

Optional. The client function.

.google.cloud.ces.v1.ClientFunction client_function = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the clientFunction field is set.

hasConnectorTool()

public boolean hasConnectorTool()

Optional. The Integration Connector tool.

.google.cloud.ces.v1.ConnectorTool connector_tool = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the connectorTool field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when the tool was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDataStoreTool()

public boolean hasDataStoreTool()

Optional. The data store tool.

.google.cloud.ces.v1.DataStoreTool data_store_tool = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataStoreTool field is set.

hasFileSearchTool()

public boolean hasFileSearchTool()

Optional. The file search tool.

.google.cloud.ces.v1.FileSearchTool file_search_tool = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the fileSearchTool field is set.

hasGoogleSearchTool()

public boolean hasGoogleSearchTool()

Optional. The google search tool.

.google.cloud.ces.v1.GoogleSearchTool google_search_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the googleSearchTool field is set.

hasMcpTool()

public boolean hasMcpTool()

Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.

.google.cloud.ces.v1.McpTool mcp_tool = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the mcpTool field is set.

hasOpenApiTool()

public boolean hasOpenApiTool()

Optional. The open API tool.

.google.cloud.ces.v1.OpenApiTool open_api_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the openApiTool field is set.

hasPythonFunction()

public boolean hasPythonFunction()

Optional. The python function tool.

.google.cloud.ces.v1.PythonFunction python_function = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the pythonFunction field is set.

hasSystemTool()

public boolean hasSystemTool()

Optional. The system tool.

.google.cloud.ces.v1.SystemTool system_tool = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the systemTool field is set.

hasToolFakeConfig()

public boolean hasToolFakeConfig()

Optional. Configuration for tool behavior in fake mode.

.google.cloud.ces.v1.ToolFakeConfig tool_fake_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the toolFakeConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when the tool was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hasWidgetTool()

public boolean hasWidgetTool()

Optional. The widget tool.

.google.cloud.ces.v1.WidgetTool widget_tool = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the widgetTool field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Tool.Builder newBuilderForType()
Returns
Type Description
Tool.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Tool.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Tool.Builder
Overrides

toBuilder()

public Tool.Builder toBuilder()
Returns
Type Description
Tool.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException