list method

Future<ListEndpointsResponse> list(String parent, { String? filter, String? orderBy, int? pageSize, String? pageToken, String? $fields, })

Lists all endpoints.

Request parameters:

parent - Required. The resource name of the service whose endpoints you'd like to list. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/namespaces/\[^/\]+/services/\[^/\]+$.

filter - Optional. The filter to list results by. General filter string syntax: () * can be `name`, `address`, `port`, or `annotations.` 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: * annotations.owner returns endpoints that have a annotation with the key owner, this is the same as annotations:owner * annotations.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 * annotations.owner!=sd AND annotations.foo=bar returns endpoints that have owner in annotation 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.

orderBy - 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.

pageSize - Optional. The maximum number of items to return.

pageToken - Optional. The next_page_token value returned from a previous List request, if any.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ListEndpointsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<ListEndpointsResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (orderBy != null) 'orderBy': [orderBy],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/endpoints';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ListEndpointsResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}