Lists IndexEndpoints in a Location.
Endpoint
gethttps://{endpoint}/v1/{parent}/indexEndpoints
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
parent
string
Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/{project}/locations/{location}
Query parameters
filter
string
Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.
indexEndpoint
supports = and !=.indexEndpoint
represents the IndexEndpoint id, ie. the last segment of the IndexEndpoint'sresourcename
.displayName
supports =, != and regex() (uses re2 syntax)labels
supports general map functions that is:labels.key=value
- key:value equalitylabels.key:* or labels:key - key existence A key including a space must be quoted.
labels."a key"`.
Some examples: * indexEndpoint="1"
* displayName="myDisplayName"
* regex(displayName, "^A") -> The display name starts with an A.
*
labels.myKey="myValue"`
pageSize
integer
Optional. The standard list page size.
pageToken
string
Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token
of the previous IndexEndpointService.ListIndexEndpoints
call.
Optional. Mask specifying which fields to read.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo"
.
Request body
The request body must be empty.
Response body
Response message for IndexEndpointService.ListIndexEndpoints
.
If successful, the response body contains data with the following structure:
List of IndexEndpoints in the requested page.
nextPageToken
string
A token to retrieve next page of results. Pass to ListIndexEndpointsRequest.page_token
to obtain that page.
JSON representation |
---|
{
"indexEndpoints": [
{
object ( |