blob: 37c968664b0d1beaf2cc4f530d7436dedfb08aa5 [file] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="agentregistry_v1alpha.html">Agent Registry API</a> . <a href="agentregistry_v1alpha.projects.html">projects</a> . <a href="agentregistry_v1alpha.projects.locations.html">locations</a> . <a href="agentregistry_v1alpha.projects.locations.endpoints.html">endpoints</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Endpoint.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Endpoints in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>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.
&quot;attributes&quot;: { # Output only. Attributes of the Endpoint. Valid values: * `agentregistry.googleapis.com/system/RuntimeReference`: {&quot;uri&quot;: &quot;//...&quot;} - the URI of the underlying resource hosting the Endpoint, for example, the GKE Deployment.
&quot;a_key&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time.
&quot;description&quot;: &quot;A String&quot;, # Output only. Description of an Endpoint.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name for the Endpoint.
&quot;endpointId&quot;: &quot;A String&quot;, # Output only. A stable, globally unique identifier for Endpoint.
&quot;interfaces&quot;: [ # Required. The connection details for the Endpoint.
{ # Represents the connection details for an Agent or MCP Server.
&quot;protocolBinding&quot;: &quot;A String&quot;, # Required. The protocol binding of the interface.
&quot;url&quot;: &quot;A String&quot;, # Required. The destination URL.
},
],
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>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 = &quot;projects/p1/locations/l1/endpoints/e1&quot;` * `display_name = &quot;my-endpoint&quot;` * `description = &quot;my-endpoint-description&quot;` * `version = &quot;v1&quot;` * `interfaces.transport = &quot;HTTP_JSON&quot;`
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
&quot;endpoints&quot;: [ # 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.
&quot;attributes&quot;: { # Output only. Attributes of the Endpoint. Valid values: * `agentregistry.googleapis.com/system/RuntimeReference`: {&quot;uri&quot;: &quot;//...&quot;} - the URI of the underlying resource hosting the Endpoint, for example, the GKE Deployment.
&quot;a_key&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time.
&quot;description&quot;: &quot;A String&quot;, # Output only. Description of an Endpoint.
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name for the Endpoint.
&quot;endpointId&quot;: &quot;A String&quot;, # Output only. A stable, globally unique identifier for Endpoint.
&quot;interfaces&quot;: [ # Required. The connection details for the Endpoint.
{ # Represents the connection details for an Agent or MCP Server.
&quot;protocolBinding&quot;: &quot;A String&quot;, # Required. The protocol binding of the interface.
&quot;url&quot;: &quot;A String&quot;, # Required. The destination URL.
},
],
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return. Used in page_token.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>