list method

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

Lists all non-deleted WorkforcePoolProviderKeys in a WorkforcePoolProvider.

If show_deleted is set to true, then deleted keys are also listed.

Request parameters:

parent - Required. The provider resource to list encryption keys for. Format: locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id} Value must have pattern ^locations/\[^/\]+/workforcePools/\[^/\]+/providers/\[^/\]+$.

pageSize - The maximum number of keys to return. If unspecified, all keys are returned. The maximum value is 10; values above 10 are truncated to 10.

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

showDeleted - Whether to return soft-deleted keys.

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

Completes with a ListWorkforcePoolProviderKeysResponse.

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

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

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