Console
    Start free

    Google Cloud Ces V1 Client - Class Tool (0.2.0)

    Reference documentation and code samples for the Google Cloud Ces V1 Client class Tool.

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

    Generated from protobuf message google.cloud.ces.v1.Tool

    Namespace

    Google \ Cloud \ Ces \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ client_function
    ClientFunction

    Optional. The client function.

    ↳ open_api_tool
    OpenApiTool

    Optional. The open API tool.

    ↳ google_search_tool
    GoogleSearchTool

    Optional. The google search tool.

    ↳ connector_tool
    ConnectorTool

    Optional. The Integration Connector tool.

    ↳ data_store_tool
    DataStoreTool

    Optional. The data store tool.

    ↳ python_function
    PythonFunction

    Optional. The python function tool.

    ↳ mcp_tool
    McpTool

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

    ↳ file_search_tool
    FileSearchTool

    Optional. The file search tool.

    ↳ system_tool
    SystemTool

    Optional. The system tool.

    ↳ agent_tool
    AgentTool

    Optional. The agent tool.

    ↳ widget_tool
    WidgetTool

    Optional. The widget tool.

    ↳ name
    string

    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.

    ↳ display_name
    string

    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.

    ↳ execution_type
    int

    Optional. The execution type of the tool.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. Timestamp when the tool was created.

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. Timestamp when the tool was last updated.

    ↳ etag
    string

    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.

    ↳ generated_summary
    string

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

    ↳ tool_fake_config
    ToolFakeConfig

    Optional. Configuration for tool behavior in fake mode.

    getClientFunction

    Optional. The client function.

    Returns
    Type
    Description
    ClientFunction |null

    hasClientFunction

    setClientFunction

    Optional. The client function.

    Parameter
    Name
    Description
    var
    ClientFunction
    Returns
    Type
    Description
    $this

    getOpenApiTool

    Optional. The open API tool.

    Returns
    Type
    Description
    OpenApiTool |null

    hasOpenApiTool

    setOpenApiTool

    Optional. The open API tool.

    Parameter
    Name
    Description
    var
    OpenApiTool
    Returns
    Type
    Description
    $this

    getGoogleSearchTool

    Optional. The google search tool.

    Returns
    Type
    Description
    GoogleSearchTool |null

    hasGoogleSearchTool

    setGoogleSearchTool

    Optional. The google search tool.

    Parameter
    Name
    Description
    var
    GoogleSearchTool
    Returns
    Type
    Description
    $this

    getConnectorTool

    Optional. The Integration Connector tool.

    Returns
    Type
    Description
    ConnectorTool |null

    hasConnectorTool

    setConnectorTool

    Optional. The Integration Connector tool.

    Parameter
    Name
    Description
    var
    ConnectorTool
    Returns
    Type
    Description
    $this

    getDataStoreTool

    Optional. The data store tool.

    Returns
    Type
    Description
    DataStoreTool |null

    hasDataStoreTool

    setDataStoreTool

    Optional. The data store tool.

    Parameter
    Name
    Description
    var
    DataStoreTool
    Returns
    Type
    Description
    $this

    getPythonFunction

    Optional. The python function tool.

    Returns
    Type
    Description
    PythonFunction |null

    hasPythonFunction

    setPythonFunction

    Optional. The python function tool.

    Parameter
    Name
    Description
    var
    PythonFunction
    Returns
    Type
    Description
    $this

    getMcpTool

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

    Returns
    Type
    Description
    McpTool |null

    hasMcpTool

    setMcpTool

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

    Parameter
    Name
    Description
    var
    McpTool
    Returns
    Type
    Description
    $this

    getFileSearchTool

    Optional. The file search tool.

    Returns
    Type
    Description
    FileSearchTool |null

    hasFileSearchTool

    setFileSearchTool

    Optional. The file search tool.

    Parameter
    Name
    Description
    var
    FileSearchTool
    Returns
    Type
    Description
    $this

    getSystemTool

    Optional. The system tool.

    Returns
    Type
    Description
    SystemTool |null

    hasSystemTool

    setSystemTool

    Optional. The system tool.

    Parameter
    Name
    Description
    var
    SystemTool
    Returns
    Type
    Description
    $this

    getAgentTool

    Optional. The agent tool.

    Returns
    Type
    Description
    AgentTool |null

    hasAgentTool

    setAgentTool

    Optional. The agent tool.

    Parameter
    Name
    Description
    var
    AgentTool
    Returns
    Type
    Description
    $this

    getWidgetTool

    Optional. The widget tool.

    Returns
    Type
    Description
    WidgetTool |null

    hasWidgetTool

    setWidgetTool

    Optional. The widget tool.

    Parameter
    Name
    Description
    var
    WidgetTool
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    setName

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    setDisplayName

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getExecutionType

    Optional. The execution type of the tool.

    Returns
    Type
    Description
    int
    Enum of type ExecutionType .

    setExecutionType

    Optional. The execution type of the tool.

    Parameter
    Name
    Description
    var
    int

    Enum of type ExecutionType .

    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. Timestamp when the tool was created.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. Timestamp when the tool was created.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. Timestamp when the tool was last updated.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. Timestamp when the tool was last updated.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    string

    setEtag

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getGeneratedSummary

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

    Returns
    Type
    Description
    string

    setGeneratedSummary

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getToolFakeConfig

    Optional. Configuration for tool behavior in fake mode.

    Returns
    Type
    Description
    ToolFakeConfig |null

    hasToolFakeConfig

    clearToolFakeConfig

    setToolFakeConfig

    Optional. Configuration for tool behavior in fake mode.

    Parameter
    Name
    Description
    var
    ToolFakeConfig
    Returns
    Type
    Description
    $this

    getToolType

    Returns
    Type
    Description
    string
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: