get method

Future<BareMetalCluster> get(
  1. String name, {
  2. String? view,
  3. String? $fields,
})

Gets details of a single bare metal Cluster.

Request parameters:

name - Required. Name of the bare metal user cluster to get. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bare_metal_cluster}" Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/bareMetalClusters/\[^/\]+$.

view - View for bare metal user cluster. 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 GetBareMetalClusterRequest method.

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

Completes with a BareMetalCluster.

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<BareMetalCluster> get(
  core.String name, {
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

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

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