Class Tool.Builder (0.1.0)

public static final class Tool.Builder extends GeneratedMessage.Builder<Tool.Builder> 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 Methods

getDescriptor()

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

Methods

build()

public Tool build()
Returns
Type Description
Tool

buildPartial()

public Tool buildPartial()
Returns
Type Description
Tool

clear()

public Tool.Builder clear()
Returns
Type Description
Tool.Builder
Overrides

clearClientFunction()

public Tool.Builder clearClientFunction()

Optional. The client function.

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

Returns
Type Description
Tool.Builder

clearConnectorTool()

public Tool.Builder clearConnectorTool()

Optional. The Integration Connector tool.

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

Returns
Type Description
Tool.Builder

clearCreateTime()

public Tool.Builder clearCreateTime()

Output only. Timestamp when the tool was created.

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

Returns
Type Description
Tool.Builder

clearDataStoreTool()

public Tool.Builder clearDataStoreTool()

Optional. The data store tool.

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

Returns
Type Description
Tool.Builder

clearDisplayName()

public Tool.Builder clearDisplayName()

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
Tool.Builder

This builder for chaining.

clearEtag()

public Tool.Builder clearEtag()

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
Tool.Builder

This builder for chaining.

clearExecutionType()

public Tool.Builder clearExecutionType()

Optional. The execution type of the tool.

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

Returns
Type Description
Tool.Builder

This builder for chaining.

clearFileSearchTool()

public Tool.Builder clearFileSearchTool()

Optional. The file search tool.

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

Returns
Type Description
Tool.Builder

clearGeneratedSummary()

public Tool.Builder clearGeneratedSummary()

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
Tool.Builder

This builder for chaining.

clearGoogleSearchTool()

public Tool.Builder clearGoogleSearchTool()

Optional. The google search tool.

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

Returns
Type Description
Tool.Builder

clearMcpTool()

public Tool.Builder clearMcpTool()

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
Tool.Builder

clearName()

public Tool.Builder clearName()

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
Tool.Builder

This builder for chaining.

clearOpenApiTool()

public Tool.Builder clearOpenApiTool()

Optional. The open API tool.

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

Returns
Type Description
Tool.Builder

clearPythonFunction()

public Tool.Builder clearPythonFunction()

Optional. The python function tool.

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

Returns
Type Description
Tool.Builder

clearSystemTool()

public Tool.Builder clearSystemTool()

Optional. The system tool.

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

Returns
Type Description
Tool.Builder

clearToolFakeConfig()

public Tool.Builder clearToolFakeConfig()

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
Tool.Builder

clearToolType()

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

clearUpdateTime()

public Tool.Builder clearUpdateTime()

Output only. Timestamp when the tool was last updated.

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

Returns
Type Description
Tool.Builder

clearWidgetTool()

public Tool.Builder clearWidgetTool()

Optional. The widget tool.

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

Returns
Type Description
Tool.Builder

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.

getClientFunctionBuilder()

public ClientFunction.Builder getClientFunctionBuilder()

Optional. The client function.

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

Returns
Type Description
ClientFunction.Builder

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.

getConnectorToolBuilder()

public ConnectorTool.Builder getConnectorToolBuilder()

Optional. The Integration Connector tool.

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

Returns
Type Description
ConnectorTool.Builder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when the tool was created.

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

Returns
Type Description
Builder

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.

getDataStoreToolBuilder()

public DataStoreTool.Builder getDataStoreToolBuilder()

Optional. The data store tool.

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

Returns
Type Description
DataStoreTool.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getFileSearchToolBuilder()

public FileSearchTool.Builder getFileSearchToolBuilder()

Optional. The file search tool.

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

Returns
Type Description
FileSearchTool.Builder

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.

getGoogleSearchToolBuilder()

public GoogleSearchTool.Builder getGoogleSearchToolBuilder()

Optional. The google search tool.

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

Returns
Type Description
GoogleSearchTool.Builder

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.

getMcpToolBuilder()

public McpTool.Builder getMcpToolBuilder()

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.Builder

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.

getOpenApiToolBuilder()

public OpenApiTool.Builder getOpenApiToolBuilder()

Optional. The open API tool.

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

Returns
Type Description
OpenApiTool.Builder

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

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.

getPythonFunctionBuilder()

public PythonFunction.Builder getPythonFunctionBuilder()

Optional. The python function tool.

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

Returns
Type Description
PythonFunction.Builder

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

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.

getSystemToolBuilder()

public SystemTool.Builder getSystemToolBuilder()

Optional. The system tool.

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

Returns
Type Description
SystemTool.Builder

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.

getToolFakeConfigBuilder()

public ToolFakeConfig.Builder getToolFakeConfigBuilder()

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.Builder

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when the tool was last updated.

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

Returns
Type Description
Builder

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.

getWidgetToolBuilder()

public WidgetTool.Builder getWidgetToolBuilder()

Optional. The widget tool.

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

Returns
Type Description
WidgetTool.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeClientFunction(ClientFunction value)

public Tool.Builder mergeClientFunction(ClientFunction value)

Optional. The client function.

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

Parameter
Name Description
value ClientFunction
Returns
Type Description
Tool.Builder

mergeConnectorTool(ConnectorTool value)

public Tool.Builder mergeConnectorTool(ConnectorTool value)

Optional. The Integration Connector tool.

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

Parameter
Name Description
value ConnectorTool
Returns
Type Description
Tool.Builder

mergeCreateTime(Timestamp value)

public Tool.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when the tool was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Tool.Builder

mergeDataStoreTool(DataStoreTool value)

public Tool.Builder mergeDataStoreTool(DataStoreTool value)

Optional. The data store tool.

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

Parameter
Name Description
value DataStoreTool
Returns
Type Description
Tool.Builder

mergeFileSearchTool(FileSearchTool value)

public Tool.Builder mergeFileSearchTool(FileSearchTool value)

Optional. The file search tool.

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

Parameter
Name Description
value FileSearchTool
Returns
Type Description
Tool.Builder

mergeFrom(Tool other)

public Tool.Builder mergeFrom(Tool other)
Parameter
Name Description
other Tool
Returns
Type Description
Tool.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Tool.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Tool.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Tool.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Tool.Builder
Overrides

mergeGoogleSearchTool(GoogleSearchTool value)

public Tool.Builder mergeGoogleSearchTool(GoogleSearchTool value)

Optional. The google search tool.

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

Parameter
Name Description
value GoogleSearchTool
Returns
Type Description
Tool.Builder

mergeMcpTool(McpTool value)

public Tool.Builder mergeMcpTool(McpTool value)

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];

Parameter
Name Description
value McpTool
Returns
Type Description
Tool.Builder

mergeOpenApiTool(OpenApiTool value)

public Tool.Builder mergeOpenApiTool(OpenApiTool value)

Optional. The open API tool.

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

Parameter
Name Description
value OpenApiTool
Returns
Type Description
Tool.Builder

mergePythonFunction(PythonFunction value)

public Tool.Builder mergePythonFunction(PythonFunction value)

Optional. The python function tool.

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

Parameter
Name Description
value PythonFunction
Returns
Type Description
Tool.Builder

mergeSystemTool(SystemTool value)

public Tool.Builder mergeSystemTool(SystemTool value)

Optional. The system tool.

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

Parameter
Name Description
value SystemTool
Returns
Type Description
Tool.Builder

mergeToolFakeConfig(ToolFakeConfig value)

public Tool.Builder mergeToolFakeConfig(ToolFakeConfig value)

Optional. Configuration for tool behavior in fake mode.

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

Parameter
Name Description
value ToolFakeConfig
Returns
Type Description
Tool.Builder

mergeUpdateTime(Timestamp value)

public Tool.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when the tool was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Tool.Builder

mergeWidgetTool(WidgetTool value)

public Tool.Builder mergeWidgetTool(WidgetTool value)

Optional. The widget tool.

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

Parameter
Name Description
value WidgetTool
Returns
Type Description
Tool.Builder

setClientFunction(ClientFunction value)

public Tool.Builder setClientFunction(ClientFunction value)

Optional. The client function.

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

Parameter
Name Description
value ClientFunction
Returns
Type Description
Tool.Builder

setClientFunction(ClientFunction.Builder builderForValue)

public Tool.Builder setClientFunction(ClientFunction.Builder builderForValue)

Optional. The client function.

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

Parameter
Name Description
builderForValue ClientFunction.Builder
Returns
Type Description
Tool.Builder

setConnectorTool(ConnectorTool value)

public Tool.Builder setConnectorTool(ConnectorTool value)

Optional. The Integration Connector tool.

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

Parameter
Name Description
value ConnectorTool
Returns
Type Description
Tool.Builder

setConnectorTool(ConnectorTool.Builder builderForValue)

public Tool.Builder setConnectorTool(ConnectorTool.Builder builderForValue)

Optional. The Integration Connector tool.

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

Parameter
Name Description
builderForValue ConnectorTool.Builder
Returns
Type Description
Tool.Builder

setCreateTime(Timestamp value)

public Tool.Builder setCreateTime(Timestamp value)

Output only. Timestamp when the tool was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Tool.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Tool.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the tool was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Tool.Builder

setDataStoreTool(DataStoreTool value)

public Tool.Builder setDataStoreTool(DataStoreTool value)

Optional. The data store tool.

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

Parameter
Name Description
value DataStoreTool
Returns
Type Description
Tool.Builder

setDataStoreTool(DataStoreTool.Builder builderForValue)

public Tool.Builder setDataStoreTool(DataStoreTool.Builder builderForValue)

Optional. The data store tool.

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

Parameter
Name Description
builderForValue DataStoreTool.Builder
Returns
Type Description
Tool.Builder

setDisplayName(String value)

public Tool.Builder setDisplayName(String value)

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];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Tool.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Tool.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Tool.Builder

This builder for chaining.

setEtag(String value)

public Tool.Builder setEtag(String value)

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;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
Tool.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Tool.Builder setEtagBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
Tool.Builder

This builder for chaining.

setExecutionType(ExecutionType value)

public Tool.Builder setExecutionType(ExecutionType value)

Optional. The execution type of the tool.

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

Parameter
Name Description
value ExecutionType

The executionType to set.

Returns
Type Description
Tool.Builder

This builder for chaining.

setExecutionTypeValue(int value)

public Tool.Builder setExecutionTypeValue(int value)

Optional. The execution type of the tool.

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

Parameter
Name Description
value int

The enum numeric value on the wire for executionType to set.

Returns
Type Description
Tool.Builder

This builder for chaining.

setFileSearchTool(FileSearchTool value)

public Tool.Builder setFileSearchTool(FileSearchTool value)

Optional. The file search tool.

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

Parameter
Name Description
value FileSearchTool
Returns
Type Description
Tool.Builder

setFileSearchTool(FileSearchTool.Builder builderForValue)

public Tool.Builder setFileSearchTool(FileSearchTool.Builder builderForValue)

Optional. The file search tool.

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

Parameter
Name Description
builderForValue FileSearchTool.Builder
Returns
Type Description
Tool.Builder

setGeneratedSummary(String value)

public Tool.Builder setGeneratedSummary(String value)

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];

Parameter
Name Description
value String

The generatedSummary to set.

Returns
Type Description
Tool.Builder

This builder for chaining.

setGeneratedSummaryBytes(ByteString value)

public Tool.Builder setGeneratedSummaryBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for generatedSummary to set.

Returns
Type Description
Tool.Builder

This builder for chaining.

setGoogleSearchTool(GoogleSearchTool value)

public Tool.Builder setGoogleSearchTool(GoogleSearchTool value)

Optional. The google search tool.

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

Parameter
Name Description
value GoogleSearchTool
Returns
Type Description
Tool.Builder

setGoogleSearchTool(GoogleSearchTool.Builder builderForValue)

public Tool.Builder setGoogleSearchTool(GoogleSearchTool.Builder builderForValue)

Optional. The google search tool.

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

Parameter
Name Description
builderForValue GoogleSearchTool.Builder
Returns
Type Description
Tool.Builder

setMcpTool(McpTool value)

public Tool.Builder setMcpTool(McpTool value)

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];

Parameter
Name Description
value McpTool
Returns
Type Description
Tool.Builder

setMcpTool(McpTool.Builder builderForValue)

public Tool.Builder setMcpTool(McpTool.Builder builderForValue)

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];

Parameter
Name Description
builderForValue McpTool.Builder
Returns
Type Description
Tool.Builder

setName(String value)

public Tool.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Tool.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Tool.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Tool.Builder

This builder for chaining.

setOpenApiTool(OpenApiTool value)

public Tool.Builder setOpenApiTool(OpenApiTool value)

Optional. The open API tool.

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

Parameter
Name Description
value OpenApiTool
Returns
Type Description
Tool.Builder

setOpenApiTool(OpenApiTool.Builder builderForValue)

public Tool.Builder setOpenApiTool(OpenApiTool.Builder builderForValue)

Optional. The open API tool.

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

Parameter
Name Description
builderForValue OpenApiTool.Builder
Returns
Type Description
Tool.Builder

setPythonFunction(PythonFunction value)

public Tool.Builder setPythonFunction(PythonFunction value)

Optional. The python function tool.

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

Parameter
Name Description
value PythonFunction
Returns
Type Description
Tool.Builder

setPythonFunction(PythonFunction.Builder builderForValue)

public Tool.Builder setPythonFunction(PythonFunction.Builder builderForValue)

Optional. The python function tool.

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

Parameter
Name Description
builderForValue PythonFunction.Builder
Returns
Type Description
Tool.Builder

setSystemTool(SystemTool value)

public Tool.Builder setSystemTool(SystemTool value)

Optional. The system tool.

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

Parameter
Name Description
value SystemTool
Returns
Type Description
Tool.Builder

setSystemTool(SystemTool.Builder builderForValue)

public Tool.Builder setSystemTool(SystemTool.Builder builderForValue)

Optional. The system tool.

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

Parameter
Name Description
builderForValue SystemTool.Builder
Returns
Type Description
Tool.Builder

setToolFakeConfig(ToolFakeConfig value)

public Tool.Builder setToolFakeConfig(ToolFakeConfig value)

Optional. Configuration for tool behavior in fake mode.

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

Parameter
Name Description
value ToolFakeConfig
Returns
Type Description
Tool.Builder

setToolFakeConfig(ToolFakeConfig.Builder builderForValue)

public Tool.Builder setToolFakeConfig(ToolFakeConfig.Builder builderForValue)

Optional. Configuration for tool behavior in fake mode.

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

Parameter
Name Description
builderForValue ToolFakeConfig.Builder
Returns
Type Description
Tool.Builder

setUpdateTime(Timestamp value)

public Tool.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when the tool was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Tool.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Tool.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the tool was last updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Tool.Builder

setWidgetTool(WidgetTool value)

public Tool.Builder setWidgetTool(WidgetTool value)

Optional. The widget tool.

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

Parameter
Name Description
value WidgetTool
Returns
Type Description
Tool.Builder

setWidgetTool(WidgetTool.Builder builderForValue)

public Tool.Builder setWidgetTool(WidgetTool.Builder builderForValue)

Optional. The widget tool.

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

Parameter
Name Description
builderForValue WidgetTool.Builder
Returns
Type Description
Tool.Builder