list method

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

Lists bare metal node pools in a given project, location and bare metal cluster.

Request parameters:

parent - Required. The parent, which owns this collection of node pools. Format: projects/{project}/locations/{location}/bareMetalClusters/{bareMetalCluster} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/bareMetalClusters/\[^/\]+$.

pageSize - The maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 50 node pools will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken - A page token, received from a previous ListBareMetalNodePools call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBareMetalNodePools must match the call that provided the page token.

view - View for bare metal node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details. Possible string values are:

  • "NODE_POOL_VIEW_UNSPECIFIED" : If the value is not set, the default `FULL` view is used.
  • "BASIC" : Includes basic information of a node pool resource including node pool resource name.
  • "FULL" : Includes the complete configuration for bare metal node pool resource. This is the default value for ListBareMetalNodePoolsRequest method.

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

Completes with a ListBareMetalNodePoolsResponse.

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

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

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