get method

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

Returns the properties of a single cluster.

Request parameters:

name - Required. The name of the cluster whose configuration to return. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/clusters/\[^/\]+$.

view - Optional. Specifies the view of the Cluster resource to be returned. Defaults to CLUSTER_VIEW_BASIC. See the ClusterView enum for possible values. Possible string values are:

  • "CLUSTER_VIEW_UNSPECIFIED" : The default / unset value. The API will default to the BASIC view.
  • "CLUSTER_VIEW_BASIC" : Include the basic metadata of the Cluster. This is the default value (for both ListClusters and GetCluster).
  • "CLUSTER_VIEW_FULL" : Include everything, including data fetched from the Kafka cluster source of truth.

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

Completes with a Cluster.

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

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

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