list method

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

Returns matching specs.

Request parameters:

parent - Required. The parent, which owns this collection of specs. Format: projects / * /locations / * /apis / * /versions / * Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/apis/\[^/\]+/versions/\[^/\]+$.

filter - An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.

orderBy - A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"

pageSize - The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.

pageToken - A page token, received from a previous ListApiSpecs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListApiSpecs must match the call that provided the page token.

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

Completes with a ListApiSpecsResponse.

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<ListApiSpecsResponse> 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') + '/specs';

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