HealthAPI
public class HealthAPI
-
Declaration
Swift
public init(influxDB2API: InfluxDB2API)
-
Get the health of an instance
Declaration
Swift
public func getHealth(zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil, completion: @escaping (_ data: HealthCheck?, _ error: InfluxDBClient.InfluxDBError?) -> Void)
Parameters
zapTraceSpan
(header) OpenTracing span context (optional)
apiResponseQueue
The queue on which api response is dispatched.
completion
completion handler to receive the data and the error objects
-
getHealth(zapTraceSpan:
AsynchronousapiResponseQueue: ) Get the health of an instance
Declaration
Swift
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *) public func getHealth(zapTraceSpan: String? = nil, apiResponseQueue: DispatchQueue? = nil) async throws -> HealthCheck?
Parameters
zapTraceSpan
(header) OpenTracing span context (optional)
apiResponseQueue
The queue on which api response is dispatched.
completion
completion handler to receive the data and the error objects