public interface ToolOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAgentTool()
public abstract AgentTool getAgentTool()Optional. The agent tool.
.google.cloud.ces.v1beta.AgentTool agent_tool = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AgentTool |
The agentTool. |
getAgentToolOrBuilder()
public abstract AgentToolOrBuilder getAgentToolOrBuilder()Optional. The agent tool.
.google.cloud.ces.v1beta.AgentTool agent_tool = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AgentToolOrBuilder |
|
getClientFunction()
public abstract ClientFunction getClientFunction()Optional. The client function.
.google.cloud.ces.v1beta.ClientFunction client_function = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ClientFunction |
The clientFunction. |
getClientFunctionOrBuilder()
public abstract ClientFunctionOrBuilder getClientFunctionOrBuilder()Optional. The client function.
.google.cloud.ces.v1beta.ClientFunction client_function = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ClientFunctionOrBuilder |
|
getConnectorTool()
public abstract ConnectorTool getConnectorTool()Optional. The Integration Connector tool.
.google.cloud.ces.v1beta.ConnectorTool connector_tool = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConnectorTool |
The connectorTool. |
getConnectorToolOrBuilder()
public abstract ConnectorToolOrBuilder getConnectorToolOrBuilder()Optional. The Integration Connector tool.
.google.cloud.ces.v1beta.ConnectorTool connector_tool = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConnectorToolOrBuilder |
|
getCreateTime()
public abstract 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 abstract 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 abstract DataStoreTool getDataStoreTool()Optional. The data store tool.
.google.cloud.ces.v1beta.DataStoreTool data_store_tool = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreTool |
The dataStoreTool. |
getDataStoreToolOrBuilder()
public abstract DataStoreToolOrBuilder getDataStoreToolOrBuilder()Optional. The data store tool.
.google.cloud.ces.v1beta.DataStoreTool data_store_tool = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStoreToolOrBuilder |
|
getDisplayName()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract ExecutionType getExecutionType()Optional. The execution type of the tool.
.google.cloud.ces.v1beta.ExecutionType execution_type = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ExecutionType |
The executionType. |
getExecutionTypeValue()
public abstract int getExecutionTypeValue()Optional. The execution type of the tool.
.google.cloud.ces.v1beta.ExecutionType execution_type = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for executionType. |
getFileSearchTool()
public abstract FileSearchTool getFileSearchTool()Optional. The file search tool.
.google.cloud.ces.v1beta.FileSearchTool file_search_tool = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FileSearchTool |
The fileSearchTool. |
getFileSearchToolOrBuilder()
public abstract FileSearchToolOrBuilder getFileSearchToolOrBuilder()Optional. The file search tool.
.google.cloud.ces.v1beta.FileSearchTool file_search_tool = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FileSearchToolOrBuilder |
|
getGeneratedSummary()
public abstract 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 abstract 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 abstract GoogleSearchTool getGoogleSearchTool()Optional. The google search tool.
.google.cloud.ces.v1beta.GoogleSearchTool google_search_tool = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GoogleSearchTool |
The googleSearchTool. |
getGoogleSearchToolOrBuilder()
public abstract GoogleSearchToolOrBuilder getGoogleSearchToolOrBuilder()Optional. The google search tool.
.google.cloud.ces.v1beta.GoogleSearchTool google_search_tool = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GoogleSearchToolOrBuilder |
|
getMcpTool()
public abstract 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.v1beta.McpTool mcp_tool = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
McpTool |
The mcpTool. |
getMcpToolOrBuilder()
public abstract 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.v1beta.McpTool mcp_tool = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
McpToolOrBuilder |
|
getName()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getOpenApiTool()
public abstract OpenApiTool getOpenApiTool()Optional. The open API tool.
.google.cloud.ces.v1beta.OpenApiTool open_api_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
OpenApiTool |
The openApiTool. |
getOpenApiToolOrBuilder()
public abstract OpenApiToolOrBuilder getOpenApiToolOrBuilder()Optional. The open API tool.
.google.cloud.ces.v1beta.OpenApiTool open_api_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
OpenApiToolOrBuilder |
|
getPythonFunction()
public abstract PythonFunction getPythonFunction()Optional. The python function tool.
.google.cloud.ces.v1beta.PythonFunction python_function = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PythonFunction |
The pythonFunction. |
getPythonFunctionOrBuilder()
public abstract PythonFunctionOrBuilder getPythonFunctionOrBuilder()Optional. The python function tool.
.google.cloud.ces.v1beta.PythonFunction python_function = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PythonFunctionOrBuilder |
|
getRemoteAgentTool()
public abstract RemoteAgentTool getRemoteAgentTool()Optional. The remote agent tool.
.google.cloud.ces.v1beta.RemoteAgentTool remote_agent_tool = 25 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RemoteAgentTool |
The remoteAgentTool. |
getRemoteAgentToolOrBuilder()
public abstract RemoteAgentToolOrBuilder getRemoteAgentToolOrBuilder()Optional. The remote agent tool.
.google.cloud.ces.v1beta.RemoteAgentTool remote_agent_tool = 25 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RemoteAgentToolOrBuilder |
|
getSystemTool()
public abstract SystemTool getSystemTool()Optional. The system tool.
.google.cloud.ces.v1beta.SystemTool system_tool = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SystemTool |
The systemTool. |
getSystemToolOrBuilder()
public abstract SystemToolOrBuilder getSystemToolOrBuilder()Optional. The system tool.
.google.cloud.ces.v1beta.SystemTool system_tool = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SystemToolOrBuilder |
|
getTimeout()
public abstract Duration getTimeout() Optional. The timeout for the tool execution. If not set, the default
timeout is 30 seconds for SYNCHRONOUS tools and 60 seconds for
ASYNCHRONOUS tools.
.google.protobuf.Duration timeout = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration |
The timeout. |
getTimeoutOrBuilder()
public abstract DurationOrBuilder getTimeoutOrBuilder() Optional. The timeout for the tool execution. If not set, the default
timeout is 30 seconds for SYNCHRONOUS tools and 60 seconds for
ASYNCHRONOUS tools.
.google.protobuf.Duration timeout = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getToolFakeConfig()
public abstract ToolFakeConfig getToolFakeConfig()Optional. Configuration for tool behavior in fake mode.
.google.cloud.ces.v1beta.ToolFakeConfig tool_fake_config = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ToolFakeConfig |
The toolFakeConfig. |
getToolFakeConfigOrBuilder()
public abstract ToolFakeConfigOrBuilder getToolFakeConfigOrBuilder()Optional. Configuration for tool behavior in fake mode.
.google.cloud.ces.v1beta.ToolFakeConfig tool_fake_config = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ToolFakeConfigOrBuilder |
|
getToolTypeCase()
public abstract Tool.ToolTypeCase getToolTypeCase()| Returns | |
|---|---|
| Type | Description |
Tool.ToolTypeCase |
|
getUpdateTime()
public abstract 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 abstract 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 abstract WidgetTool getWidgetTool()Optional. The widget tool.
.google.cloud.ces.v1beta.WidgetTool widget_tool = 24 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WidgetTool |
The widgetTool. |
getWidgetToolOrBuilder()
public abstract WidgetToolOrBuilder getWidgetToolOrBuilder()Optional. The widget tool.
.google.cloud.ces.v1beta.WidgetTool widget_tool = 24 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WidgetToolOrBuilder |
|
hasAgentTool()
public abstract boolean hasAgentTool()Optional. The agent tool.
.google.cloud.ces.v1beta.AgentTool agent_tool = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the agentTool field is set. |
hasClientFunction()
public abstract boolean hasClientFunction()Optional. The client function.
.google.cloud.ces.v1beta.ClientFunction client_function = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the clientFunction field is set. |
hasConnectorTool()
public abstract boolean hasConnectorTool()Optional. The Integration Connector tool.
.google.cloud.ces.v1beta.ConnectorTool connector_tool = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the connectorTool field is set. |
hasCreateTime()
public abstract 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 abstract boolean hasDataStoreTool()Optional. The data store tool.
.google.cloud.ces.v1beta.DataStoreTool data_store_tool = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the dataStoreTool field is set. |
hasFileSearchTool()
public abstract boolean hasFileSearchTool()Optional. The file search tool.
.google.cloud.ces.v1beta.FileSearchTool file_search_tool = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the fileSearchTool field is set. |
hasGoogleSearchTool()
public abstract boolean hasGoogleSearchTool()Optional. The google search tool.
.google.cloud.ces.v1beta.GoogleSearchTool google_search_tool = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the googleSearchTool field is set. |
hasMcpTool()
public abstract 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.v1beta.McpTool mcp_tool = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the mcpTool field is set. |
hasOpenApiTool()
public abstract boolean hasOpenApiTool()Optional. The open API tool.
.google.cloud.ces.v1beta.OpenApiTool open_api_tool = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the openApiTool field is set. |
hasPythonFunction()
public abstract boolean hasPythonFunction()Optional. The python function tool.
.google.cloud.ces.v1beta.PythonFunction python_function = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pythonFunction field is set. |
hasRemoteAgentTool()
public abstract boolean hasRemoteAgentTool()Optional. The remote agent tool.
.google.cloud.ces.v1beta.RemoteAgentTool remote_agent_tool = 25 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the remoteAgentTool field is set. |
hasSystemTool()
public abstract boolean hasSystemTool()Optional. The system tool.
.google.cloud.ces.v1beta.SystemTool system_tool = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the systemTool field is set. |
hasTimeout()
public abstract boolean hasTimeout() Optional. The timeout for the tool execution. If not set, the default
timeout is 30 seconds for SYNCHRONOUS tools and 60 seconds for
ASYNCHRONOUS tools.
.google.protobuf.Duration timeout = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the timeout field is set. |
hasToolFakeConfig()
public abstract boolean hasToolFakeConfig()Optional. Configuration for tool behavior in fake mode.
.google.cloud.ces.v1beta.ToolFakeConfig tool_fake_config = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the toolFakeConfig field is set. |
hasUpdateTime()
public abstract 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 abstract boolean hasWidgetTool()Optional. The widget tool.
.google.cloud.ces.v1beta.WidgetTool widget_tool = 24 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the widgetTool field is set. |