list method

Future<ListCertificatesResponse> list(
  1. String parent, {
  2. String? filter,
  3. String? orderBy,
  4. int? pageSize,
  5. String? pageToken,
  6. String? $fields,
})

Lists Certificates.

Request parameters:

parent - Required. The resource name of the parent associated with the Certificates, in the format projects / * /locations / * /caPools / * . The parent resource name can be in one of two forms: 1. Specific CA Pool: To list certificates within a single CA Pool: projects / * /locations / * /caPools / * 2. All CA Pools in a Location: To list certificates across all CA Pools in a given project and location, use the wildcard character (-) in place of the CA Pool ID. Example: projects / * /locations / * /caPools/- See go/ccfe-nested-collections#aggregate-listing for more details. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/caPools/\[^/\]+$.

filter - Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see Certificates Filtering documentation.

orderBy - Optional. Specify how the results should be sorted. For details on supported fields and syntax, see Certificates Sorting documentation.

pageSize - Optional. Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

pageToken - Optional. Pagination token, returned earlier via ListCertificatesResponse.next_page_token.

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

Completes with a ListCertificatesResponse.

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<ListCertificatesResponse> 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>>{
    'filter': ?filter == null ? null : [filter],
    'orderBy': ?orderBy == null ? null : [orderBy],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'fields': ?$fields == null ? null : [$fields],
  };

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

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