get method

Future<InstanceGroup> get(
  1. String project,
  2. String zone,
  3. String instanceGroup, {
  4. String? $fields,
})

Returns the specified zonal instance group.

Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.

Request parameters:

project - Project ID for this request. Value must have pattern (?:(?:\[-a-z0-9\]{1,63}\.)*(?:\[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?):)?(?:\[0-9\]{1,19}|(?:\[a-z0-9\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?)).

zone - The name of the zone where the instance group is located.

instanceGroup - The name of the instance group.

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

Completes with a InstanceGroup.

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

  final url_ = 'projects/' +
      commons.escapeVariable('$project') +
      '/zones/' +
      commons.escapeVariable('$zone') +
      '/instanceGroups/' +
      commons.escapeVariable('$instanceGroup');

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