list method

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

Lists bare metal clusters in a given project and location.

Request parameters:

parent - Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}" Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.

pageSize - Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken - A token identifying a page of results the server should return.

view - View for bare metal Clusters. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details. Possible string values are:

  • "CLUSTER_VIEW_UNSPECIFIED" : If the value is not set, the default `FULL` view is used.
  • "BASIC" : Includes basic information of a cluster resource including cluster resource name and admin cluster membership.
  • "FULL" : Includes the complete configuration for bare metal cluster resource. This is the default value for ListBareMetalClustersRequest method.

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

Completes with a ListBareMetalClustersResponse.

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

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