ToolState class

Input properties used for looking up and filtering Tool resources.

Constructors

ToolState({Input<ToolAgentTool?>? agentTool, Input<String?>? app, Input<ToolClientFunction?>? clientFunction, Input<List<ToolConnectorTool>?>? connectorTools, Input<String?>? createTime, Input<ToolDataStoreTool?>? dataStoreTool, Input<String?>? deletionPolicy, Input<String?>? displayName, Input<String?>? etag, Input<String?>? executionType, Input<ToolFileSearchTool?>? fileSearchTool, Input<String?>? generatedSummary, Input<ToolGoogleSearchTool?>? googleSearchTool, Input<String?>? location, Input<List<ToolMcpTool>?>? mcpTools, Input<String?>? name, Input<List<ToolOpenApiTool>?>? openApiTools, Input<String?>? project, Input<ToolPythonFunction?>? pythonFunction, Input<List<ToolRemoteAgentTool>?>? remoteAgentTools, Input<List<ToolSystemTool>?>? systemTools, Input<String?>? timeout, Input<ToolToolFakeConfig?>? toolFakeConfig, Input<String?>? toolId, Input<String?>? updateTime, Input<ToolWidgetTool?>? widgetTool})
Creates a new ToolState. agentTool Represents a tool that allows the agent to call another agent. app Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. clientFunction Represents a client-side function that the agent can invoke. When the connectorTools A ConnectorTool allows connections to different integrations. createTime Timestamp when the tool was created. dataStoreTool Tool to retrieve from Vertex AI Search datastore or engine for grounding. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. displayName (Output) etag Etag used to ensure the object hasn't changed during a read-modify-write executionType Possible values: fileSearchTool The file search tool allows the agent to search across the files uploaded by the generatedSummary If the tool is generated by the LLM assistant, this field contains a googleSearchTool Represents a tool to perform Google web searches for grounding. location Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. mcpTools An MCP tool. name (Output) openApiTools A remote API tool defined by an OpenAPI schema. project The ID of the project in which the resource belongs. pythonFunction A Python function tool. remoteAgentTools Represents a tool that allows the agent to call another remote agent. systemTools The system tool. timeout The timeout for the tool execution. If not set, the default timeout is 30 toolFakeConfig Configuration for tool behavior in fake mode. toolId The ID to use for the tool, which will become the final component of updateTime Timestamp when the tool was last updated. widgetTool Represents a widget tool that the agent can invoke.
const
ToolState.fromMap(Map<String, dynamic> map)
factory

Properties

agentTool → Input<ToolAgentTool?>?
Represents a tool that allows the agent to call another agent. Structure is documented below.
final
app → Input<String?>?
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
final
clientFunction → Input<ToolClientFunction?>?
Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. Structure is documented below.
final
connectorTools → Input<List<ToolConnectorTool>?>?
A ConnectorTool allows connections to different integrations. Structure is documented below.
final
createTime → Input<String?>?
Timestamp when the tool was created.
final
dataStoreTool → Input<ToolDataStoreTool?>?
Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. Structure is documented below.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
displayName → Input<String?>?
(Output) The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
final
etag → Input<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.
final
executionType → Input<String?>?
Possible values: SYNCHRONOUS ASYNCHRONOUS
final
fileSearchTool → Input<ToolFileSearchTool?>?
The file search tool allows the agent to search across the files uploaded by the app/agent developer. Structure is documented below.
final
generatedSummary → Input<String?>?
If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
final
googleSearchTool → Input<ToolGoogleSearchTool?>?
Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/grounding-with-google-search. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
location → Input<String?>?
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
final
mcpTools → Input<List<ToolMcpTool>?>?
An MCP tool. Structure is documented below.
final
name → Input<String?>?
(Output) The name of the system tool.
final
openApiTools → Input<List<ToolOpenApiTool>?>?
A remote API tool defined by an OpenAPI schema. Structure is documented below.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
pythonFunction → Input<ToolPythonFunction?>?
A Python function tool. Structure is documented below.
final
remoteAgentTools → Input<List<ToolRemoteAgentTool>?>?
Represents a tool that allows the agent to call another remote agent. Structure is documented below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
systemTools → Input<List<ToolSystemTool>?>?
The system tool. Structure is documented below.
final
timeout → Input<String?>?
The timeout for the tool execution. If not set, the default timeout is 30 seconds for SYNCHRONOUS tools and 60 seconds for ASYNCHRONOUS tools.
final
toolFakeConfig → Input<ToolToolFakeConfig?>?
Configuration for tool behavior in fake mode. Structure is documented below.
final
toolId → Input<String?>?
The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
final
updateTime → Input<String?>?
Timestamp when the tool was last updated.
final
widgetTool → Input<ToolWidgetTool?>?
Represents a widget tool that the agent can invoke. Structure is documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited