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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ToolImplements
ToolOrBuilderStatic Fields
AGENT_TOOL_FIELD_NUMBER
public
static
final
int
AGENT_TOOL_FIELD_NUMBER
CLIENT_FUNCTION_FIELD_NUMBER
public
static
final
int
CLIENT_FUNCTION_FIELD_NUMBER
CONNECTOR_TOOL_FIELD_NUMBER
public
static
final
int
CONNECTOR_TOOL_FIELD_NUMBER
CREATE_TIME_FIELD_NUMBER
public
static
final
int
CREATE_TIME_FIELD_NUMBER
DATA_STORE_TOOL_FIELD_NUMBER
public
static
final
int
DATA_STORE_TOOL_FIELD_NUMBER
DISPLAY_NAME_FIELD_NUMBER
public
static
final
int
DISPLAY_NAME_FIELD_NUMBER
ETAG_FIELD_NUMBER
public
static
final
int
ETAG_FIELD_NUMBER
EXECUTION_TYPE_FIELD_NUMBER
public
static
final
int
EXECUTION_TYPE_FIELD_NUMBER
FILE_SEARCH_TOOL_FIELD_NUMBER
public
static
final
int
FILE_SEARCH_TOOL_FIELD_NUMBER
GENERATED_SUMMARY_FIELD_NUMBER
public
static
final
int
GENERATED_SUMMARY_FIELD_NUMBER
GOOGLE_SEARCH_TOOL_FIELD_NUMBER
public
static
final
int
GOOGLE_SEARCH_TOOL_FIELD_NUMBER
MCP_TOOL_FIELD_NUMBER
public
static
final
int
MCP_TOOL_FIELD_NUMBER
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
OPEN_API_TOOL_FIELD_NUMBER
public
static
final
int
OPEN_API_TOOL_FIELD_NUMBER
PYTHON_FUNCTION_FIELD_NUMBER
public
static
final
int
PYTHON_FUNCTION_FIELD_NUMBER
SYSTEM_TOOL_FIELD_NUMBER
public
static
final
int
SYSTEM_TOOL_FIELD_NUMBER
TOOL_FAKE_CONFIG_FIELD_NUMBER
public
static
final
int
TOOL_FAKE_CONFIG_FIELD_NUMBER
UPDATE_TIME_FIELD_NUMBER
public
static
final
int
UPDATE_TIME_FIELD_NUMBER
WIDGET_TOOL_FIELD_NUMBER
public
static
final
int
WIDGET_TOOL_FIELD_NUMBER
Static Methods
getDefaultInstance()
public
static
Tool
getDefaultInstance
()
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
newBuilder()
public
static
Tool
.
Builder
newBuilder
()
newBuilder(Tool prototype)
public
static
Tool
.
Builder
newBuilder
(
Tool
prototype
)
parseDelimitedFrom(InputStream input)
public
static
Tool
parseDelimitedFrom
(
InputStream
input
)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Tool
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(byte[] data)
public
static
Tool
parseFrom
(
byte
[]
data
)
data
byte
[]
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Tool
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteString data)
public
static
Tool
parseFrom
(
ByteString
data
)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Tool
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(CodedInputStream input)
public
static
Tool
parseFrom
(
CodedInputStream
input
)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Tool
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(InputStream input)
public
static
Tool
parseFrom
(
InputStream
input
)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Tool
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteBuffer data)
public
static
Tool
parseFrom
(
ByteBuffer
data
)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Tool
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
parser()
public
static
Parser<Tool>
parser
()
Methods
equals(Object obj)
public
boolean
equals
(
Object
obj
)
getAgentTool()
public
AgentTool
getAgentTool
()
Optional. The agent tool.
.google.cloud.ces.v1.AgentTool agent_tool = 23 [(.google.api.field_behavior) = OPTIONAL];
getAgentToolOrBuilder()
public
AgentToolOrBuilder
getAgentToolOrBuilder
()
Optional. The agent tool.
.google.cloud.ces.v1.AgentTool agent_tool = 23 [(.google.api.field_behavior) = OPTIONAL];
getClientFunction()
public
ClientFunction
getClientFunction
()
Optional. The client function.
.google.cloud.ces.v1.ClientFunction client_function = 2 [(.google.api.field_behavior) = OPTIONAL];
getClientFunctionOrBuilder()
public
ClientFunctionOrBuilder
getClientFunctionOrBuilder
()
Optional. The client function.
.google.cloud.ces.v1.ClientFunction client_function = 2 [(.google.api.field_behavior) = OPTIONAL];
getConnectorTool()
public
ConnectorTool
getConnectorTool
()
Optional. The Integration Connector tool.
.google.cloud.ces.v1.ConnectorTool connector_tool = 8 [(.google.api.field_behavior) = OPTIONAL];
getConnectorToolOrBuilder()
public
ConnectorToolOrBuilder
getConnectorToolOrBuilder
()
Optional. The Integration Connector tool.
.google.cloud.ces.v1.ConnectorTool connector_tool = 8 [(.google.api.field_behavior) = OPTIONAL];
getCreateTime()
public
Timestamp
getCreateTime
()
Output only. Timestamp when the tool was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public
TimestampOrBuilder
getCreateTimeOrBuilder
()
Output only. Timestamp when the tool was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDataStoreTool()
public
DataStoreTool
getDataStoreTool
()
Optional. The data store tool.
.google.cloud.ces.v1.DataStoreTool data_store_tool = 10 [(.google.api.field_behavior) = OPTIONAL];
getDataStoreToolOrBuilder()
public
DataStoreToolOrBuilder
getDataStoreToolOrBuilder
()
Optional. The data store tool.
.google.cloud.ces.v1.DataStoreTool data_store_tool = 10 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public
Tool
getDefaultInstanceForType
()
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];
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];
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;
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;
getExecutionType()
public
ExecutionType
getExecutionType
()
Optional. The execution type of the tool.
.google.cloud.ces.v1.ExecutionType execution_type = 12 [(.google.api.field_behavior) = OPTIONAL];
getExecutionTypeValue()
public
int
getExecutionTypeValue
()
Optional. The execution type of the tool.
.google.cloud.ces.v1.ExecutionType execution_type = 12 [(.google.api.field_behavior) = OPTIONAL];
getFileSearchTool()
public
FileSearchTool
getFileSearchTool
()
Optional. The file search tool.
.google.cloud.ces.v1.FileSearchTool file_search_tool = 17 [(.google.api.field_behavior) = OPTIONAL];
getFileSearchToolOrBuilder()
public
FileSearchToolOrBuilder
getFileSearchToolOrBuilder
()
Optional. The file search tool.
.google.cloud.ces.v1.FileSearchTool file_search_tool = 17 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
getGoogleSearchTool()
public
GoogleSearchTool
getGoogleSearchTool
()
Optional. The google search tool.
.google.cloud.ces.v1.GoogleSearchTool google_search_tool = 5 [(.google.api.field_behavior) = OPTIONAL];
getGoogleSearchToolOrBuilder()
public
GoogleSearchToolOrBuilder
getGoogleSearchToolOrBuilder
()
Optional. The google search tool.
.google.cloud.ces.v1.GoogleSearchTool google_search_tool = 5 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
getName()
public
String
getName
()
Identifier. The resource name 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];
getNameBytes()
public
ByteString
getNameBytes
()
Identifier. The resource name 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];
getOpenApiTool()
public
OpenApiTool
getOpenApiTool
()
Optional. The open API tool.
.google.cloud.ces.v1.OpenApiTool open_api_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
getOpenApiToolOrBuilder()
public
OpenApiToolOrBuilder
getOpenApiToolOrBuilder
()
Optional. The open API tool.
.google.cloud.ces.v1.OpenApiTool open_api_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public
Parser<Tool>
getParserForType
()
getPythonFunction()
public
PythonFunction
getPythonFunction
()
Optional. The python function tool.
.google.cloud.ces.v1.PythonFunction python_function = 11 [(.google.api.field_behavior) = OPTIONAL];
getPythonFunctionOrBuilder()
public
PythonFunctionOrBuilder
getPythonFunctionOrBuilder
()
Optional. The python function tool.
.google.cloud.ces.v1.PythonFunction python_function = 11 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public
int
getSerializedSize
()
getSystemTool()
public
SystemTool
getSystemTool
()
Optional. The system tool.
.google.cloud.ces.v1.SystemTool system_tool = 18 [(.google.api.field_behavior) = OPTIONAL];
getSystemToolOrBuilder()
public
SystemToolOrBuilder
getSystemToolOrBuilder
()
Optional. The system tool.
.google.cloud.ces.v1.SystemTool system_tool = 18 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
getToolTypeCase()
public
Tool
.
ToolTypeCase
getToolTypeCase
()
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];
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];
getWidgetTool()
public
WidgetTool
getWidgetTool
()
Optional. The widget tool.
.google.cloud.ces.v1.WidgetTool widget_tool = 24 [(.google.api.field_behavior) = OPTIONAL];
getWidgetToolOrBuilder()
public
WidgetToolOrBuilder
getWidgetToolOrBuilder
()
Optional. The widget tool.
.google.cloud.ces.v1.WidgetTool widget_tool = 24 [(.google.api.field_behavior) = OPTIONAL];
hasAgentTool()
public
boolean
hasAgentTool
()
Optional. The agent tool.
.google.cloud.ces.v1.AgentTool agent_tool = 23 [(.google.api.field_behavior) = OPTIONAL];
hasClientFunction()
public
boolean
hasClientFunction
()
Optional. The client function.
.google.cloud.ces.v1.ClientFunction client_function = 2 [(.google.api.field_behavior) = OPTIONAL];
hasConnectorTool()
public
boolean
hasConnectorTool
()
Optional. The Integration Connector tool.
.google.cloud.ces.v1.ConnectorTool connector_tool = 8 [(.google.api.field_behavior) = OPTIONAL];
hasCreateTime()
public
boolean
hasCreateTime
()
Output only. Timestamp when the tool was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasDataStoreTool()
public
boolean
hasDataStoreTool
()
Optional. The data store tool.
.google.cloud.ces.v1.DataStoreTool data_store_tool = 10 [(.google.api.field_behavior) = OPTIONAL];
hasFileSearchTool()
public
boolean
hasFileSearchTool
()
Optional. The file search tool.
.google.cloud.ces.v1.FileSearchTool file_search_tool = 17 [(.google.api.field_behavior) = OPTIONAL];
hasGoogleSearchTool()
public
boolean
hasGoogleSearchTool
()
Optional. The google search tool.
.google.cloud.ces.v1.GoogleSearchTool google_search_tool = 5 [(.google.api.field_behavior) = OPTIONAL];
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];
hasOpenApiTool()
public
boolean
hasOpenApiTool
()
Optional. The open API tool.
.google.cloud.ces.v1.OpenApiTool open_api_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
hasPythonFunction()
public
boolean
hasPythonFunction
()
Optional. The python function tool.
.google.cloud.ces.v1.PythonFunction python_function = 11 [(.google.api.field_behavior) = OPTIONAL];
hasSystemTool()
public
boolean
hasSystemTool
()
Optional. The system tool.
.google.cloud.ces.v1.SystemTool system_tool = 18 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
hasWidgetTool()
public
boolean
hasWidgetTool
()
Optional. The widget tool.
.google.cloud.ces.v1.WidgetTool widget_tool = 24 [(.google.api.field_behavior) = OPTIONAL];
hashCode()
public
int
hashCode
()
internalGetFieldAccessorTable()
protected
GeneratedMessage
.
FieldAccessorTable
internalGetFieldAccessorTable
()
isInitialized()
public
final
boolean
isInitialized
()
newBuilderForType()
public
Tool
.
Builder
newBuilderForType
()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected
Tool
.
Builder
newBuilderForType
(
AbstractMessage
.
BuilderParent
parent
)
toBuilder()
public
Tool
.
Builder
toBuilder
()
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
