ListEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The request message for RegistrationService.ListEndpoints.
Attributes | |
---|---|
Name | Description |
parent |
str
Required. The resource name of the service whose endpoints you'd like to list. |
page_size |
int
Optional. The maximum number of items to return. |
page_token |
str
Optional. The next_page_token value returned from a previous List request, if any. |
filter |
str
Optional. The filter to list results by. General filter string syntax:
- can be name , address , port , or
metadata. for map field
- can be , > , <> , >= ,
!= , = , : . Of which : means HAS , and
is roughly the same as =
- must be the same data type as field
- can be AND , OR , NOT
Examples of valid filters:
- metadata.owner returns endpoints that have a metadata
with the key owner , this is the same as
metadata:owner
- metadata.protocol=gRPC returns endpoints that have
key/value protocol=gRPC
- address=192.108.1.105 returns endpoints that have
this address
- port>8080 returns endpoints that have port number
larger than 8080
-
name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/my-service/endpoints/endpoint-c
returns endpoints that have name that is alphabetically
later than the string, so "endpoint-e" is returned but
"endpoint-a" is not
- metadata.owner!=sd AND metadata.foo=bar returns
endpoints that have owner in metadata key but value
is not sd AND have key/value foo=bar
- doesnotexist.foo=bar returns an empty list. Note that
endpoint doesn't have a field called "doesnotexist".
Since the filter does not match any endpoints, it returns
no results
For more information about filtering, see `API
Filtering |
order_by |
str
Optional. The order to list results by. General order_by string syntax:
- allows values: name , address ,
port
- ascending or descending order by
. If this is left blank, asc is used
Note that an empty order_by string results in default
order, which is order by name in ascending order.
|