+ projects()
+
Returns the projects Resource.
+ +
+ close()
Close httplib2 connections.
+ +Create a BatchHttpRequest object based on the discovery document.
+close()
+ Close httplib2 connections.+
new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document. + + Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. ++
+ locations()
+
Returns the locations Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
+ close()
Close httplib2 connections.
+ +Gets details of a single Agent.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Agents in a given project and location.
+ +Retrieves the next page of results.
+
+ search(parent, body=None, x__xgafv=None)
Searches Agents in a given project and location.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(name, x__xgafv=None)
+ Gets details of a single Agent.
+
+Args:
+ name: string, Required. Name of the resource (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.
+ "agentId": "A String", # Output only. A stable, globally unique identifier for agents.
+ "attributes": { # Output only. Attributes of the Agent. Valid values: * `agentregistry.googleapis.com/system/Framework`: {"framework": "google-adk"} - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom". * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."} - the runtime identity associated with the Agent. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
+ "a_key": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "card": { # Full Agent Card payload, often obtained from the A2A Agent Card. # Output only. Full Agent Card payload, when available.
+ "content": { # Output only. The content of the agent card.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Output only. The type of agent card.
+ },
+ "createTime": "A String", # Output only. Create time.
+ "description": "A String", # Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
+ "displayName": "A String", # Output only. The display name of the agent, often obtained from the A2A Agent Card.
+ "location": "A String", # Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
+ "name": "A String", # Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "protocols": [ # Output only. The connection details for the Agent.
+ { # Represents the protocol of an Agent.
+ "interfaces": [ # Output only. The connection details for the Agent.
+ { # Represents the connection details for an Agent or MCP Server.
+ "protocolBinding": "A String", # Required. The protocol binding of the interface.
+ "url": "A String", # Required. The destination URL.
+ },
+ ],
+ "protocolVersion": "A String", # Output only. The version of the protocol, for example, the A2A Agent Card version.
+ "type": "A String", # Output only. The type of the protocol.
+ },
+ ],
+ "skills": [ # Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
+ { # Represents the skills of an Agent.
+ "description": "A String", # Output only. A more detailed description of the skill.
+ "examples": [ # Output only. Example prompts or scenarios this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Output only. A unique identifier for the agent's skill.
+ "name": "A String", # Output only. A human-readable name for the agent's skill.
+ "tags": [ # Output only. Keywords describing the skill.
+ "A String",
+ ],
+ },
+ ],
+ "uid": "A String", # Output only. A universally unique identifier for the Agent.
+ "updateTime": "A String", # Output only. Update time.
+ "version": "A String", # Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists Agents in a given project and location.
+
+Args:
+ parent: string, Required. Parent value for ListAgentsRequest (required)
+ filter: string, Optional. Filtering results
+ orderBy: string, Optional. Hint for how to order the results
+ pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+ pageToken: string, Optional. A token identifying a page of results the server should return.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to listing Agents
+ "agents": [ # The list of Agents.
+ { # Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.
+ "agentId": "A String", # Output only. A stable, globally unique identifier for agents.
+ "attributes": { # Output only. Attributes of the Agent. Valid values: * `agentregistry.googleapis.com/system/Framework`: {"framework": "google-adk"} - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom". * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."} - the runtime identity associated with the Agent. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
+ "a_key": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "card": { # Full Agent Card payload, often obtained from the A2A Agent Card. # Output only. Full Agent Card payload, when available.
+ "content": { # Output only. The content of the agent card.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Output only. The type of agent card.
+ },
+ "createTime": "A String", # Output only. Create time.
+ "description": "A String", # Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
+ "displayName": "A String", # Output only. The display name of the agent, often obtained from the A2A Agent Card.
+ "location": "A String", # Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
+ "name": "A String", # Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "protocols": [ # Output only. The connection details for the Agent.
+ { # Represents the protocol of an Agent.
+ "interfaces": [ # Output only. The connection details for the Agent.
+ { # Represents the connection details for an Agent or MCP Server.
+ "protocolBinding": "A String", # Required. The protocol binding of the interface.
+ "url": "A String", # Required. The destination URL.
+ },
+ ],
+ "protocolVersion": "A String", # Output only. The version of the protocol, for example, the A2A Agent Card version.
+ "type": "A String", # Output only. The type of the protocol.
+ },
+ ],
+ "skills": [ # Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
+ { # Represents the skills of an Agent.
+ "description": "A String", # Output only. A more detailed description of the skill.
+ "examples": [ # Output only. Example prompts or scenarios this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Output only. A unique identifier for the agent's skill.
+ "name": "A String", # Output only. A human-readable name for the agent's skill.
+ "tags": [ # Output only. Keywords describing the skill.
+ "A String",
+ ],
+ },
+ ],
+ "uid": "A String", # Output only. A universally unique identifier for the Agent.
+ "updateTime": "A String", # Output only. Update time.
+ "version": "A String", # Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.
+ },
+ ],
+ "nextPageToken": "A String", # A token identifying a page of results the server should return.
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
search(parent, body=None, x__xgafv=None)
+ Searches Agents in a given project and location.
+
+Args:
+ parent: string, Required. Parent value for SearchAgentsRequest. Format: `projects/{project}/locations/{location}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Message for searching Agents
+ "pageSize": 42, # Optional. The maximum number of search results to return per page. The page size is capped at `100`, even if a larger value is specified. A negative value will result in an `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. The server may return fewer results than requested.
+ "pageToken": "A String", # Optional. If present, retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call.
+ "searchString": "A String", # Optional. Search criteria used to select the Agents to return. If no search criteria is specified then all accessible Agents will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |--------------------|-----|-----|-----|----------------| | agentId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | skills | No | Yes | No | Included | | skills.id | No | Yes | No | Included | | skills.name | No | Yes | No | Included | | skills.description | No | Yes | No | Included | | skills.tags | No | Yes | No | Included | | skills.examples | No | Yes | No | Included | Examples: * `agentId="urn:agent:projects-123:projects:123:locations:us-central1:reasoningEngines:1234"` to find the agent with the specified agent ID. * `name:important` to find agents whose name contains `important` as a word. * `displayName:works*` to find agents whose display name contains words that start with `works`. * `skills.tags:test` to find agents whose skills tags contain `test`. * `planner OR booking` to find agents whose metadata contains the words `planner` or `booking`.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to searching Agents
+ "agents": [ # A list of Agents that match the `search_string`.
+ { # Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.
+ "agentId": "A String", # Output only. A stable, globally unique identifier for agents.
+ "attributes": { # Output only. Attributes of the Agent. Valid values: * `agentregistry.googleapis.com/system/Framework`: {"framework": "google-adk"} - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom". * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."} - the runtime identity associated with the Agent. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
+ "a_key": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "card": { # Full Agent Card payload, often obtained from the A2A Agent Card. # Output only. Full Agent Card payload, when available.
+ "content": { # Output only. The content of the agent card.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Output only. The type of agent card.
+ },
+ "createTime": "A String", # Output only. Create time.
+ "description": "A String", # Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
+ "displayName": "A String", # Output only. The display name of the agent, often obtained from the A2A Agent Card.
+ "location": "A String", # Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
+ "name": "A String", # Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "protocols": [ # Output only. The connection details for the Agent.
+ { # Represents the protocol of an Agent.
+ "interfaces": [ # Output only. The connection details for the Agent.
+ { # Represents the connection details for an Agent or MCP Server.
+ "protocolBinding": "A String", # Required. The protocol binding of the interface.
+ "url": "A String", # Required. The destination URL.
+ },
+ ],
+ "protocolVersion": "A String", # Output only. The version of the protocol, for example, the A2A Agent Card version.
+ "type": "A String", # Output only. The type of the protocol.
+ },
+ ],
+ "skills": [ # Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
+ { # Represents the skills of an Agent.
+ "description": "A String", # Output only. A more detailed description of the skill.
+ "examples": [ # Output only. Example prompts or scenarios this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Output only. A unique identifier for the agent's skill.
+ "name": "A String", # Output only. A human-readable name for the agent's skill.
+ "tags": [ # Output only. Keywords describing the skill.
+ "A String",
+ ],
+ },
+ ],
+ "uid": "A String", # Output only. A universally unique identifier for the Agent.
+ "updateTime": "A String", # Output only. Update time.
+ "version": "A String", # Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.
+ },
+ ],
+ "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
+}
+search_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ close()
Close httplib2 connections.
+
+ create(parent, bindingId=None, body=None, requestId=None, x__xgafv=None)
Creates a new Binding in a given project and location.
+
+ delete(name, requestId=None, x__xgafv=None)
Deletes a single Binding.
+ +Fetches available Bindings.
+ +Retrieves the next page of results.
+ +Gets details of a single Binding.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Bindings in a given project and location.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single Binding.
+close()
+ Close httplib2 connections.+
create(parent, bindingId=None, body=None, requestId=None, x__xgafv=None)
+ Creates a new Binding in a given project and location.
+
+Args:
+ parent: string, Required. The project and location to create the Binding in. Expected format: `projects/{project}/locations/{location}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a user-defined Binding.
+ "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+ "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+ "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+ "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+ "A String",
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when this binding was created.
+ "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+ "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+ "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+ "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+ },
+ "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+ "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+ },
+ "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+}
+
+ bindingId: string, Required. The ID to use for the binding, which will become the final component of the binding's resource name. This value should be 4-63 characters, and must conform to RFC-1034. Specifically, it must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
+ requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+delete(name, requestId=None, x__xgafv=None)
+ Deletes a single Binding.
+
+Args:
+ name: string, Required. The name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`. (required)
+ requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+fetchAvailable(parent, pageSize=None, pageToken=None, sourceIdentifier=None, targetIdentifier=None, x__xgafv=None)
+ Fetches available Bindings.
+
+Args:
+ parent: string, Required. The parent, in the format `projects/{project}/locations/{location}`. (required)
+ pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. Page size is 500 if unspecified and is capped at `500` even if a larger value is given.
+ pageToken: string, Optional. A token identifying a page of results the server should return.
+ sourceIdentifier: string, The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+ targetIdentifier: string, Optional. The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to fetching available Bindings.
+ "bindings": [ # The list of Bindings.
+ { # Represents a user-defined Binding.
+ "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+ "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+ "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+ "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+ "A String",
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when this binding was created.
+ "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+ "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+ "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+ "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+ },
+ "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+ "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+ },
+ "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token identifying a page of results the server should return.
+}
+fetchAvailable_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
get(name, x__xgafv=None)
+ Gets details of a single Binding.
+
+Args:
+ name: string, Required. The name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a user-defined Binding.
+ "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+ "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+ "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+ "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+ "A String",
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when this binding was created.
+ "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+ "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+ "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+ "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+ },
+ "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+ "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+ },
+ "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists Bindings in a given project and location.
+
+Args:
+ parent: string, Required. The project and location to list bindings in. Expected format: `projects/{project}/locations/{location}`. (required)
+ filter: string, Optional. A query string used to filter the list of bindings returned. The filter expression must follow AIP-160 syntax.
+ orderBy: string, Optional. Hint for how to order the results
+ pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. Page size is 500 if unspecified and is capped at `500` even if a larger value is given.
+ pageToken: string, Optional. A token identifying a page of results the server should return.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to listing Bindings
+ "bindings": [ # The list of Binding resources matching the parent and filter criteria in the request. Each Binding resource follows the format: `projects/{project}/locations/{location}/bindings/{binding}`.
+ { # Represents a user-defined Binding.
+ "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+ "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+ "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+ "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+ "A String",
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when this binding was created.
+ "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+ "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+ "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+ "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+ },
+ "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+ "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+ },
+ "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token identifying a page of results the server should return. Used in page_token.
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
+ Updates the parameters of a single Binding.
+
+Args:
+ name: string, Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a user-defined Binding.
+ "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+ "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+ "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+ "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+ "A String",
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when this binding was created.
+ "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+ "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+ "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+ "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+ },
+ "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+ "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+ },
+ "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+}
+
+ requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Binding resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+ close()
Close httplib2 connections.
+ +Gets details of a single Endpoint.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Endpoints in a given project and location.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(name, x__xgafv=None)
+ Gets details of a single Endpoint.
+
+Args:
+ name: string, Required. The name of the endpoint to retrieve. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Endpoint.
+ "attributes": { # Output only. Attributes of the Endpoint. Valid values: * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the Endpoint, for example, the GKE Deployment.
+ "a_key": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "createTime": "A String", # Output only. Create time.
+ "description": "A String", # Output only. Description of an Endpoint.
+ "displayName": "A String", # Output only. Display name for the Endpoint.
+ "endpointId": "A String", # Output only. A stable, globally unique identifier for Endpoint.
+ "interfaces": [ # Required. The connection details for the Endpoint.
+ { # Represents the connection details for an Agent or MCP Server.
+ "protocolBinding": "A String", # Required. The protocol binding of the interface.
+ "url": "A String", # Required. The destination URL.
+ },
+ ],
+ "name": "A String", # Identifier. The resource name of the Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+ "updateTime": "A String", # Output only. Update time.
+}
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists Endpoints in a given project and location.
+
+Args:
+ parent: string, Required. The project and location to list endpoints in. Expected format: `projects/{project}/locations/{location}`. (required)
+ filter: string, Optional. A query string used to filter the list of endpoints returned. The filter expression must follow AIP-160 syntax. Filtering is supported on the `name`, `display_name`, `description`, `version`, and `interfaces` fields. Some examples: * `name = "projects/p1/locations/l1/endpoints/e1"` * `display_name = "my-endpoint"` * `description = "my-endpoint-description"` * `version = "v1"` * `interfaces.transport = "HTTP_JSON"`
+ pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+ pageToken: string, Optional. A token identifying a page of results the server should return.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to listing Endpoints
+ "endpoints": [ # The list of Endpoint resources matching the parent and filter criteria in the request. Each Endpoint resource follows the format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+ { # Represents an Endpoint.
+ "attributes": { # Output only. Attributes of the Endpoint. Valid values: * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the Endpoint, for example, the GKE Deployment.
+ "a_key": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "createTime": "A String", # Output only. Create time.
+ "description": "A String", # Output only. Description of an Endpoint.
+ "displayName": "A String", # Output only. Display name for the Endpoint.
+ "endpointId": "A String", # Output only. A stable, globally unique identifier for Endpoint.
+ "interfaces": [ # Required. The connection details for the Endpoint.
+ { # Represents the connection details for an Agent or MCP Server.
+ "protocolBinding": "A String", # Required. The protocol binding of the interface.
+ "url": "A String", # Required. The destination URL.
+ },
+ ],
+ "name": "A String", # Identifier. The resource name of the Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+ "updateTime": "A String", # Output only. Update time.
+ },
+ ],
+ "nextPageToken": "A String", # A token identifying a page of results the server should return. Used in page_token.
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ agents()
+
Returns the agents Resource.
+ +
+ bindings()
+
Returns the bindings Resource.
+ +
+ endpoints()
+
Returns the endpoints Resource.
+ +
+ mcpServers()
+
Returns the mcpServers Resource.
+ +
+ operations()
+
Returns the operations Resource.
+ +
+ services()
+
Returns the services Resource.
+ +
+ close()
Close httplib2 connections.
+ +Gets information about a location.
+
+ list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(name, x__xgafv=None)
+ Gets information about a location.
+
+Args:
+ name: string, Resource name for the location. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A resource that represents a Google Cloud location.
+ "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+}
+list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+
+Args:
+ name: string, The resource that owns the locations collection, if applicable. (required)
+ extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+ filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
+ pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+ pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Locations.ListLocations.
+ "locations": [ # A list of locations that matches the specified filter in the request.
+ { # A resource that represents a Google Cloud location.
+ "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+ },
+ ],
+ "nextPageToken": "A String", # The standard List next-page token.
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ close()
Close httplib2 connections.
+ +Gets details of a single McpServer.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists McpServers in a given project and location.
+ +Retrieves the next page of results.
+
+ search(parent, body=None, x__xgafv=None)
Searches McpServers in a given project and location.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(name, x__xgafv=None)
+ Gets details of a single McpServer.
+
+Args:
+ name: string, Required. Name of the resource (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an MCP (Model Context Protocol) Server.
+ "attributes": { # Output only. Attributes of the MCP Server. Valid values: * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."} - the runtime identity associated with the MCP Server. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the MCP Server, for example, the GKE Deployment.
+ "a_key": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "createTime": "A String", # Output only. Create time.
+ "description": "A String", # Output only. The description of the MCP Server.
+ "displayName": "A String", # Output only. The display name of the MCP Server.
+ "interfaces": [ # Output only. The connection details for the MCP Server.
+ { # Represents the connection details for an Agent or MCP Server.
+ "protocolBinding": "A String", # Required. The protocol binding of the interface.
+ "url": "A String", # Required. The destination URL.
+ },
+ ],
+ "mcpServerId": "A String", # Output only. A stable, globally unique identifier for MCP Servers.
+ "name": "A String", # Identifier. The resource name of the MCP Server. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`.
+ "tools": [ # Output only. Tools provided by the MCP Server.
+ { # Represents a single tool provided by an MCP Server.
+ "annotations": { # Annotations describing the characteristics and behavior of a tool or operation. # Output only. Annotations associated with the tool.
+ "destructiveHint": True or False, # Output only. If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. NOTE: This property is meaningful only when `read_only_hint == false` Default: true
+ "idempotentHint": True or False, # Output only. If true, calling the tool repeatedly with the same arguments will have no additional effect on its environment. NOTE: This property is meaningful only when `read_only_hint == false` Default: false
+ "openWorldHint": True or False, # Output only. If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not. Default: true
+ "readOnlyHint": True or False, # Output only. If true, the tool does not modify its environment. Default: false
+ "title": "A String", # Output only. A human-readable title for the tool.
+ },
+ "description": "A String", # Output only. Description of what the tool does.
+ "name": "A String", # Output only. Human-readable name of the tool.
+ },
+ ],
+ "updateTime": "A String", # Output only. Update time.
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists McpServers in a given project and location.
+
+Args:
+ parent: string, Required. Parent value for ListMcpServersRequest. Format: `projects/{project}/locations/{location}`. (required)
+ filter: string, Optional. Filtering results
+ orderBy: string, Optional. Hint for how to order the results
+ pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+ pageToken: string, Optional. A token identifying a page of results the server should return.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to listing McpServers
+ "mcpServers": [ # The list of McpServers.
+ { # Represents an MCP (Model Context Protocol) Server.
+ "attributes": { # Output only. Attributes of the MCP Server. Valid values: * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."} - the runtime identity associated with the MCP Server. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the MCP Server, for example, the GKE Deployment.
+ "a_key": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "createTime": "A String", # Output only. Create time.
+ "description": "A String", # Output only. The description of the MCP Server.
+ "displayName": "A String", # Output only. The display name of the MCP Server.
+ "interfaces": [ # Output only. The connection details for the MCP Server.
+ { # Represents the connection details for an Agent or MCP Server.
+ "protocolBinding": "A String", # Required. The protocol binding of the interface.
+ "url": "A String", # Required. The destination URL.
+ },
+ ],
+ "mcpServerId": "A String", # Output only. A stable, globally unique identifier for MCP Servers.
+ "name": "A String", # Identifier. The resource name of the MCP Server. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`.
+ "tools": [ # Output only. Tools provided by the MCP Server.
+ { # Represents a single tool provided by an MCP Server.
+ "annotations": { # Annotations describing the characteristics and behavior of a tool or operation. # Output only. Annotations associated with the tool.
+ "destructiveHint": True or False, # Output only. If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. NOTE: This property is meaningful only when `read_only_hint == false` Default: true
+ "idempotentHint": True or False, # Output only. If true, calling the tool repeatedly with the same arguments will have no additional effect on its environment. NOTE: This property is meaningful only when `read_only_hint == false` Default: false
+ "openWorldHint": True or False, # Output only. If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not. Default: true
+ "readOnlyHint": True or False, # Output only. If true, the tool does not modify its environment. Default: false
+ "title": "A String", # Output only. A human-readable title for the tool.
+ },
+ "description": "A String", # Output only. Description of what the tool does.
+ "name": "A String", # Output only. Human-readable name of the tool.
+ },
+ ],
+ "updateTime": "A String", # Output only. Update time.
+ },
+ ],
+ "nextPageToken": "A String", # A token identifying a page of results the server should return.
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
search(parent, body=None, x__xgafv=None)
+ Searches McpServers in a given project and location.
+
+Args:
+ parent: string, Required. Parent value for SearchMcpServersRequest. Format: `projects/{project}/locations/{location}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Message for searching MCP Servers
+ "pageSize": 42, # Optional. The maximum number of search results to return per page. The page size is capped at `100`, even if a larger value is specified. A negative value will result in an `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. The server may return fewer results than requested.
+ "pageToken": "A String", # Optional. If present, retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call.
+ "searchString": "A String", # Optional. Search criteria used to select the MCP Servers to return. If no search criteria is specified then all accessible MCP Servers will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |--------------------|-----|-----|-----|----------------| | mcpServerId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | Examples: * `mcpServerId="urn:mcp:projects-123:projects:123:locations:us-central1:agentregistry:services:service-id"` to find the MCP Server with the specified MCP Server ID. * `name:important` to find MCP Servers whose name contains `important` as a word. * `displayName:works*` to find MCP Servers whose display name contains words that start with `works`. * `planner OR booking` to find MCP Servers whose metadata contains the words `planner` or `booking`. * `mcpServerId:service-id AND (displayName:planner OR displayName:booking)` to find MCP Servers whose MCP Server ID contains `service-id` and whose display name contains `planner` or `booking`.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to searching MCP Servers
+ "mcpServers": [ # A list of McpServers that match the `search_string`.
+ { # Represents an MCP (Model Context Protocol) Server.
+ "attributes": { # Output only. Attributes of the MCP Server. Valid values: * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."} - the runtime identity associated with the MCP Server. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the MCP Server, for example, the GKE Deployment.
+ "a_key": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "createTime": "A String", # Output only. Create time.
+ "description": "A String", # Output only. The description of the MCP Server.
+ "displayName": "A String", # Output only. The display name of the MCP Server.
+ "interfaces": [ # Output only. The connection details for the MCP Server.
+ { # Represents the connection details for an Agent or MCP Server.
+ "protocolBinding": "A String", # Required. The protocol binding of the interface.
+ "url": "A String", # Required. The destination URL.
+ },
+ ],
+ "mcpServerId": "A String", # Output only. A stable, globally unique identifier for MCP Servers.
+ "name": "A String", # Identifier. The resource name of the MCP Server. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`.
+ "tools": [ # Output only. Tools provided by the MCP Server.
+ { # Represents a single tool provided by an MCP Server.
+ "annotations": { # Annotations describing the characteristics and behavior of a tool or operation. # Output only. Annotations associated with the tool.
+ "destructiveHint": True or False, # Output only. If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. NOTE: This property is meaningful only when `read_only_hint == false` Default: true
+ "idempotentHint": True or False, # Output only. If true, calling the tool repeatedly with the same arguments will have no additional effect on its environment. NOTE: This property is meaningful only when `read_only_hint == false` Default: false
+ "openWorldHint": True or False, # Output only. If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not. Default: true
+ "readOnlyHint": True or False, # Output only. If true, the tool does not modify its environment. Default: false
+ "title": "A String", # Output only. A human-readable title for the tool.
+ },
+ "description": "A String", # Output only. Description of what the tool does.
+ "name": "A String", # Output only. Human-readable name of the tool.
+ },
+ ],
+ "updateTime": "A String", # Output only. Update time.
+ },
+ ],
+ "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
+}
+search_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ cancel(name, body=None, x__xgafv=None)
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+ close()
Close httplib2 connections.
+ +Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ +Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+ +Retrieves the next page of results.
+cancel(name, body=None, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+close()
+ Close httplib2 connections.+
delete(name, x__xgafv=None)
+ Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+ Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation's parent resource. (required)
+ filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
+ pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+ "A String",
+ ],
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, requestId=None, serviceId=None, x__xgafv=None)
Creates a new Service in a given project and location.
+
+ delete(name, requestId=None, x__xgafv=None)
Deletes a single Service.
+ +Gets details of a single Service.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Services in a given project and location.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single Service.
+close()
+ Close httplib2 connections.+
create(parent, body=None, requestId=None, serviceId=None, x__xgafv=None)
+ Creates a new Service in a given project and location.
+
+Args:
+ parent: string, Required. The project and location to create the Service in. Expected format: `projects/{project}/locations/{location}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a user-defined Service.
+ "agentSpec": { # The spec of the agent. # Optional. The spec of the Agent. When `agent_spec` is set, the type of the service is Agent.
+ "content": { # Optional. The content of the Agent spec in the JSON format. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Required. The type of the agent spec content.
+ },
+ "createTime": "A String", # Output only. Create time.
+ "description": "A String", # Optional. User-defined description of an Service. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Service. Can have a maximum length of `63` characters.
+ "endpointSpec": { # The spec of the endpoint. # Optional. The spec of the Endpoint. When `endpoint_spec` is set, the type of the service is Endpoint.
+ "content": { # Optional. The content of the endpoint spec. Reserved for future use.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Required. The type of the endpoint spec content.
+ },
+ "interfaces": [ # Optional. The connection details for the Service.
+ { # Represents the connection details for an Agent or MCP Server.
+ "protocolBinding": "A String", # Required. The protocol binding of the interface.
+ "url": "A String", # Required. The destination URL.
+ },
+ ],
+ "mcpServerSpec": { # The spec of the MCP Server. # Optional. The spec of the MCP Server. When `mcp_server_spec` is set, the type of the service is MCP Server.
+ "content": { # Optional. The content of the MCP Server spec. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Required. The type of the MCP Server spec content.
+ },
+ "name": "A String", # Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`.
+ "registryResource": "A String", # Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format: * `projects/{project}/locations/{location}/mcpServers/{mcp_server}` * `projects/{project}/locations/{location}/agents/{agent}` * `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "updateTime": "A String", # Output only. Update time.
+}
+
+ requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ serviceId: string, Required. The ID to use for the service, which will become the final component of the service's resource name. This value should be 4-63 characters, and valid characters are `/a-z-/`.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+delete(name, requestId=None, x__xgafv=None)
+ Deletes a single Service.
+
+Args:
+ name: string, Required. The name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`. (required)
+ requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+get(name, x__xgafv=None)
+ Gets details of a single Service.
+
+Args:
+ name: string, Required. The name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a user-defined Service.
+ "agentSpec": { # The spec of the agent. # Optional. The spec of the Agent. When `agent_spec` is set, the type of the service is Agent.
+ "content": { # Optional. The content of the Agent spec in the JSON format. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Required. The type of the agent spec content.
+ },
+ "createTime": "A String", # Output only. Create time.
+ "description": "A String", # Optional. User-defined description of an Service. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Service. Can have a maximum length of `63` characters.
+ "endpointSpec": { # The spec of the endpoint. # Optional. The spec of the Endpoint. When `endpoint_spec` is set, the type of the service is Endpoint.
+ "content": { # Optional. The content of the endpoint spec. Reserved for future use.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Required. The type of the endpoint spec content.
+ },
+ "interfaces": [ # Optional. The connection details for the Service.
+ { # Represents the connection details for an Agent or MCP Server.
+ "protocolBinding": "A String", # Required. The protocol binding of the interface.
+ "url": "A String", # Required. The destination URL.
+ },
+ ],
+ "mcpServerSpec": { # The spec of the MCP Server. # Optional. The spec of the MCP Server. When `mcp_server_spec` is set, the type of the service is MCP Server.
+ "content": { # Optional. The content of the MCP Server spec. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Required. The type of the MCP Server spec content.
+ },
+ "name": "A String", # Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`.
+ "registryResource": "A String", # Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format: * `projects/{project}/locations/{location}/mcpServers/{mcp_server}` * `projects/{project}/locations/{location}/agents/{agent}` * `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "updateTime": "A String", # Output only. Update time.
+}
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists Services in a given project and location.
+
+Args:
+ parent: string, Required. The project and location to list services in. Expected format: `projects/{project}/locations/{location}`. (required)
+ filter: string, Optional. A query string used to filter the list of services returned. The filter expression must follow AIP-160 syntax. Filtering is supported on the `name`, `display_name`, `description`, and `labels` fields. Some examples: * `name = "projects/p1/locations/l1/services/s1"` * `display_name = "my-service"` * `description : "myservice description"` * `labels.env = "prod"`
+ pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+ pageToken: string, Optional. A token identifying a page of results the server should return.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to listing Services
+ "nextPageToken": "A String", # A token identifying a page of results the server should return. Used in page_token.
+ "services": [ # The list of Service resources matching the parent and filter criteria in the request. Each Service resource follows the format: `projects/{project}/locations/{location}/services/{service}`.
+ { # Represents a user-defined Service.
+ "agentSpec": { # The spec of the agent. # Optional. The spec of the Agent. When `agent_spec` is set, the type of the service is Agent.
+ "content": { # Optional. The content of the Agent spec in the JSON format. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Required. The type of the agent spec content.
+ },
+ "createTime": "A String", # Output only. Create time.
+ "description": "A String", # Optional. User-defined description of an Service. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Service. Can have a maximum length of `63` characters.
+ "endpointSpec": { # The spec of the endpoint. # Optional. The spec of the Endpoint. When `endpoint_spec` is set, the type of the service is Endpoint.
+ "content": { # Optional. The content of the endpoint spec. Reserved for future use.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Required. The type of the endpoint spec content.
+ },
+ "interfaces": [ # Optional. The connection details for the Service.
+ { # Represents the connection details for an Agent or MCP Server.
+ "protocolBinding": "A String", # Required. The protocol binding of the interface.
+ "url": "A String", # Required. The destination URL.
+ },
+ ],
+ "mcpServerSpec": { # The spec of the MCP Server. # Optional. The spec of the MCP Server. When `mcp_server_spec` is set, the type of the service is MCP Server.
+ "content": { # Optional. The content of the MCP Server spec. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Required. The type of the MCP Server spec content.
+ },
+ "name": "A String", # Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`.
+ "registryResource": "A String", # Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format: * `projects/{project}/locations/{location}/mcpServers/{mcp_server}` * `projects/{project}/locations/{location}/agents/{agent}` * `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "updateTime": "A String", # Output only. Update time.
+ },
+ ],
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
+ Updates the parameters of a single Service.
+
+Args:
+ name: string, Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a user-defined Service.
+ "agentSpec": { # The spec of the agent. # Optional. The spec of the Agent. When `agent_spec` is set, the type of the service is Agent.
+ "content": { # Optional. The content of the Agent spec in the JSON format. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Required. The type of the agent spec content.
+ },
+ "createTime": "A String", # Output only. Create time.
+ "description": "A String", # Optional. User-defined description of an Service. Can have a maximum length of `2048` characters.
+ "displayName": "A String", # Optional. User-defined display name for the Service. Can have a maximum length of `63` characters.
+ "endpointSpec": { # The spec of the endpoint. # Optional. The spec of the Endpoint. When `endpoint_spec` is set, the type of the service is Endpoint.
+ "content": { # Optional. The content of the endpoint spec. Reserved for future use.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Required. The type of the endpoint spec content.
+ },
+ "interfaces": [ # Optional. The connection details for the Service.
+ { # Represents the connection details for an Agent or MCP Server.
+ "protocolBinding": "A String", # Required. The protocol binding of the interface.
+ "url": "A String", # Required. The destination URL.
+ },
+ ],
+ "mcpServerSpec": { # The spec of the MCP Server. # Optional. The spec of the MCP Server. When `mcp_server_spec` is set, the type of the service is MCP Server.
+ "content": { # Optional. The content of the MCP Server spec. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
+ "a_key": "", # Properties of the object.
+ },
+ "type": "A String", # Required. The type of the MCP Server spec content.
+ },
+ "name": "A String", # Identifier. The resource name of the Service. Format: `projects/{project}/locations/{location}/services/{service}`.
+ "registryResource": "A String", # Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format: * `projects/{project}/locations/{location}/mcpServers/{mcp_server}` * `projects/{project}/locations/{location}/agents/{agent}` * `projects/{project}/locations/{location}/endpoints/{endpoint}`
+ "updateTime": "A String", # Output only. Update time.
+}
+
+ requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+ updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+Returns the schedules Resource.
+
+ semanticGovernancePolicies()
+
Returns the semanticGovernancePolicies Resource.
+ diff --git a/docs/dyn/aiplatform_v1.projects.locations.agents.html b/docs/dyn/aiplatform_v1.projects.locations.agents.html new file mode 100644 index 00000000000..9f1e358d386 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.agents.html @@ -0,0 +1,373 @@ + + + +
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates an agent.
+ +Deletes an agent.
+ +Retrieves an agent.
+
+ list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists agents in a location.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an agent.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates an agent.
+
+Args:
+ parent: string, Required. The resource name of the location to create the agent in. Format: `projects/{project}/locations/{location}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A Vertex agent contains instructions and configurations for the LLM to execute a certain task.
+ "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`
+ "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.
+ "created": "A String", # Output only. The time the agent was created.
+ "description": "A String", # Optional. The description of the agent.
+ "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+ "metadata": { # Optional. The metadata for the agent.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`.
+ "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.
+ "tools": [ # Optional. The tools available to the agent.
+ { # A tool provides a list of actions available to the Agent during the process of executing a task.
+ "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.
+ "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`
+ "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.
+ },
+ ],
+ "updated": "A String", # Output only. The time the agent was last updated.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+delete(name, x__xgafv=None)
+ Deletes an agent.
+
+Args:
+ name: string, Required. The resource name of the agent to delete. Format: `projects/{project}/locations/{location}/agents/{agent}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+get(name, x__xgafv=None)
+ Retrieves an agent.
+
+Args:
+ name: string, Required. The resource name of the agent to retrieve. Format: `projects/{project}/locations/{location}/agents/{agent}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A Vertex agent contains instructions and configurations for the LLM to execute a certain task.
+ "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`
+ "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.
+ "created": "A String", # Output only. The time the agent was created.
+ "description": "A String", # Optional. The description of the agent.
+ "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+ "metadata": { # Optional. The metadata for the agent.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`.
+ "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.
+ "tools": [ # Optional. The tools available to the agent.
+ { # A tool provides a list of actions available to the Agent during the process of executing a task.
+ "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.
+ "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`
+ "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.
+ },
+ ],
+ "updated": "A String", # Output only. The time the agent was last updated.
+}
+list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists agents in a location.
+
+Args:
+ parent: string, Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}`. (required)
+ orderBy: string, Optional. A comma-separated list of fields to order by. Supported fields: * `created` * `updated` Use `desc` after a field name for descending order. Example: `created desc`.
+ pageSize: integer, Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10.
+ pageToken: string, Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for AgentService.ListAgents.
+ "agents": [ # The agents matching the request.
+ { # A Vertex agent contains instructions and configurations for the LLM to execute a certain task.
+ "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`
+ "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.
+ "created": "A String", # Output only. The time the agent was created.
+ "description": "A String", # Optional. The description of the agent.
+ "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+ "metadata": { # Optional. The metadata for the agent.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`.
+ "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.
+ "tools": [ # Optional. The tools available to the agent.
+ { # A tool provides a list of actions available to the Agent during the process of executing a task.
+ "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.
+ "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`
+ "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.
+ },
+ ],
+ "updated": "A String", # Output only. The time the agent was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value as ListAgentsRequest.page_token in a subsequent call.
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates an agent.
+
+Args:
+ name: string, Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A Vertex agent contains instructions and configurations for the LLM to execute a certain task.
+ "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`
+ "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.
+ "created": "A String", # Output only. The time the agent was created.
+ "description": "A String", # Optional. The description of the agent.
+ "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+ "metadata": { # Optional. The metadata for the agent.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`.
+ "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.
+ "tools": [ # Optional. The tools available to the agent.
+ { # A tool provides a list of actions available to the Agent during the process of executing a task.
+ "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.
+ "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`
+ "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.
+ },
+ ],
+ "updated": "A String", # Output only. The time the agent was last updated.
+}
+
+ updateMask: string, Optional. The list of fields to update. If not present, all fields are updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A Vertex agent contains instructions and configurations for the LLM to execute a certain task.
+ "base_agent": "A String", # Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`
+ "base_environment": "", # Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.
+ "created": "A String", # Output only. The time the agent was created.
+ "description": "A String", # Optional. The description of the agent.
+ "id": "A String", # Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+ "metadata": { # Optional. The metadata for the agent.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
+ "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`.
+ "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.
+ "tools": [ # Optional. The tools available to the agent.
+ { # A tool provides a list of actions available to the Agent during the process of executing a task.
+ "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.
+ "a_key": "A String",
+ },
+ "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.
+ "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`
+ "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.
+ },
+ ],
+ "updated": "A String", # Output only. The time the agent was last updated.
+}
+
+ agents()
+
Returns the agents Resource.
+ @@ -239,6 +244,16 @@Returns the schedules Resource.
+
+ semanticGovernancePolicies()
+
Returns the semanticGovernancePolicies Resource.
+ +
+ semanticGovernancePolicyEngine()
+
Returns the semanticGovernancePolicyEngine Resource.
+ @@ -311,6 +326,9 @@
getRagEngineConfig(name, x__xgafv=None)
Gets a RagEngineConfig.
+
+ getSemanticGovernancePolicyEngine(name, x__xgafv=None)
Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
@@ -323,6 +341,9 @@
updateRagEngineConfig(name, body=None, x__xgafv=None)
Updates a RagEngineConfig.
+
+ updateSemanticGovernancePolicyEngine(name, body=None, updateMask=None, x__xgafv=None)
Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.
askContexts(parent, body=None, x__xgafv=None)
@@ -489,6 +510,7 @@ getSemanticGovernancePolicyEngine(name, x__xgafv=None)
+ Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.
+
+Args:
+ name: string, Required. The resource name of the SemanticGovernancePolicyEngine to retrieve. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Define a singleton SemanticGovernancePolicyEngine resource under a project and location.
+ "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was created.
+ "gatewayConfigs": { # Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed.
+ "a_key": { # Configuration for a single gateway.
+ "dnsRecord": "A String", # Output only. The fully qualified record name of the created A-record in Cloud DNS.
+ "dnsZoneName": "A String", # Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint.
+ "ipAddress": "A String", # Output only. The private IP address of the PSC endpoint.
+ "network": "A String", # Optional. The URI of the network resource where PSC-E will be provisioned. if not provided `default` network will be used. Format: projects/{project}/global/networks/{network}
+ "pscEndpoint": "A String", # Output only. The self-link or name of the Private Service Connect endpoint forwarding rule.
+ "state": "A String", # Output only. The state of the Gateway configuration.
+ "subnetwork": "A String", # Optional. The URI of the subnetwork resource where PSC-E will be provisioned. if not provided `default` subnet will be used from the same {location} Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}
+ },
+ },
+ "ipAddress": "A String", # Output only. The private IPv4 address of the PSC endpoint.
+ "name": "A String", # Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine
+ "pscForwardingRule": "A String", # Output only. The URI of the PSC endpoint resource created in customer project. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
+ "pscServiceAttachment": "A String", # Output only. URI of the PSC attachment resource provided by SGP. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
+ "state": "A String", # Output only. The state of the SemanticGovernancePolicyEngine.
+ "updateTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was last updated.
+}
+list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
@@ -7000,4 +7065,64 @@ Method Details
}
updateSemanticGovernancePolicyEngine(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.
+
+Args:
+ name: string, Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Define a singleton SemanticGovernancePolicyEngine resource under a project and location.
+ "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was created.
+ "gatewayConfigs": { # Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed.
+ "a_key": { # Configuration for a single gateway.
+ "dnsRecord": "A String", # Output only. The fully qualified record name of the created A-record in Cloud DNS.
+ "dnsZoneName": "A String", # Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint.
+ "ipAddress": "A String", # Output only. The private IP address of the PSC endpoint.
+ "network": "A String", # Optional. The URI of the network resource where PSC-E will be provisioned. if not provided `default` network will be used. Format: projects/{project}/global/networks/{network}
+ "pscEndpoint": "A String", # Output only. The self-link or name of the Private Service Connect endpoint forwarding rule.
+ "state": "A String", # Output only. The state of the Gateway configuration.
+ "subnetwork": "A String", # Optional. The URI of the subnetwork resource where PSC-E will be provisioned. if not provided `default` subnet will be used from the same {location} Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}
+ },
+ },
+ "ipAddress": "A String", # Output only. The private IPv4 address of the PSC endpoint.
+ "name": "A String", # Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine
+ "pscForwardingRule": "A String", # Output only. The URI of the PSC endpoint resource created in customer project. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
+ "pscServiceAttachment": "A String", # Output only. URI of the PSC attachment resource provided by SGP. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
+ "state": "A String", # Output only. The state of the SemanticGovernancePolicyEngine.
+ "updateTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicyEngine was last updated.
+}
+
+ updateMask: string, Optional. Specifies the fields to be overwritten in the SemanticGovernancePolicyEngine resource by the update. The fields specified in the update_mask are relative to the resource itself. If no update_mask is provided, all fields are overwritten.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+