list method

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

Lists Features in a given project and location.

Request parameters:

parent - Required. The parent (project and location) where the Features will be listed. Specified in the format projects / * /locations / * . Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Feature with the name "servicemesh" in project "foo-proj": name = "projects/foo-proj/locations/global/features/servicemesh" - Features that have a label called foo: labels.foo:* - Features that have a label called foo whose value is bar: labels.foo = bar

orderBy - One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

pageSize - When requesting a 'page' of resources, page_size specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

pageToken - Token returned by previous call to ListFeatures which specifies the position in the list from where to continue listing the resources.

returnPartialSuccess - Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.

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

Completes with a ListFeaturesResponse.

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<ListFeaturesResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.bool? returnPartialSuccess,
  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 (returnPartialSuccess != null)
      'returnPartialSuccess': ['${returnPartialSuccess}'],
    if ($fields != null) 'fields': [$fields],
  };

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

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