getHealth method

Future<HealthCheck> getHealth({
  1. String? zapTraceSpan,
})

Get the health of an instance

Parameters:

  • String zapTraceSpan: OpenTracing span context

Implementation

Future<HealthCheck> getHealth({String? zapTraceSpan}) async {
  final response = await getHealthWithHttpInfo(zapTraceSpan: zapTraceSpan);
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'HealthCheck',
    ) as HealthCheck;
  }
  throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}