list method

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

Lists all non-deleted WorkforcePoolProviders in a WorkforcePool.

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

Request parameters:

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

pageSize - The maximum number of providers to return. If unspecified, at most 50 providers are returned. The maximum value is 100; values above 100 are truncated to 100.

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

showDeleted - Whether to return soft-deleted providers.

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

Completes with a ListWorkforcePoolProvidersResponse.

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<ListWorkforcePoolProvidersResponse> 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') + '/providers';

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