list method

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

Lists all non-deleted WorkforcePools under the specified parent.

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

Request parameters:

location - The location of the pool. Format: locations/{location}. Value must have pattern ^locations/\[^/\]+$.

pageSize - The maximum number of pools to return. The default value is 50. The maximum value is 100.

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

parent - Required. The parent resource to list pools for. Format: organizations/{org-id}.

showDeleted - Whether to return soft-deleted pools.

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

Completes with a ListWorkforcePoolsResponse.

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

  final url_ = 'v1/' + core.Uri.encodeFull('$location') + '/workforcePools';

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