getHealth method

Future<TargetPoolInstanceHealth> getHealth(InstanceReference request, String project, String region, String targetPool, { String? $fields, })

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

request - The metadata request object.

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\])?)).

region - Name of the region scoping this request. Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?.

targetPool - Name of the TargetPool resource to which the queried instance belongs. Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?|\[1-9\]\[0-9\]{0,19}.

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

Completes with a TargetPoolInstanceHealth.

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<TargetPoolInstanceHealth> getHealth(
  InstanceReference request,
  core.String project,
  core.String region,
  core.String targetPool, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'projects/' +
      commons.escapeVariable('$project') +
      '/regions/' +
      commons.escapeVariable('$region') +
      '/targetPools/' +
      commons.escapeVariable('$targetPool') +
      '/getHealth';

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