Skip to main content

endpoints

Creates, updates, deletes, gets or lists an endpoints resource.

Overview

Nameendpoints
TypeResource
Idgoogle.agentregistry.endpoints

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringIdentifier. The resource name of the Endpoint. Format: projects/{project}/locations/{location}/endpoints/{endpoint}.
attributesobjectOutput 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.
createTimestring (google-datetime)Output only. Create time.
descriptionstringOutput only. Description of an Endpoint.
displayNamestringOutput only. Display name for the Endpoint.
endpointIdstringOutput only. A stable, globally unique identifier for Endpoint.
interfacesarrayRequired. The connection details for the Endpoint.
updateTimestring (google-datetime)Output only. Update time.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, endpointsIdGets details of a single Endpoint.
listselectprojectsId, locationsIdfilter, pageToken, pageSizeLists Endpoints in a given project and location.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
endpointsIdstring
locationsIdstring
projectsIdstring
filterstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples

Gets details of a single Endpoint.

SELECT
name,
attributes,
createTime,
description,
displayName,
endpointId,
interfaces,
updateTime
FROM google.agentregistry.endpoints
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND endpointsId = '{{ endpointsId }}' -- required
;