list method

Future<GoogleCloudApigeeV1ListApiDocsResponse> list(
  1. String parent, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Returns the catalog items associated with a portal.

Request parameters:

parent - Required. Name of the portal. Use the following structure in your request: organizations/{org}/sites/{site} Value must have pattern ^organizations/\[^/\]+/sites/\[^/\]+$.

pageSize - Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 25 books will be returned. The maximum value is 100; values above 100 will be coerced to 100.

pageToken - Optional. A page token, received from a previous ListApiDocs call. Provide this to retrieve the subsequent page.

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

Completes with a GoogleCloudApigeeV1ListApiDocsResponse.

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<GoogleCloudApigeeV1ListApiDocsResponse> list(
  core.String parent, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

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

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