Agent Registry API . projects . locations . endpoints

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

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.

list_next()

Retrieves the next page of results.

Method Details

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.