InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\HealthService Class Reference

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 getHealth ($zap_trace_span=null)
 
 getHealthWithHttpInfo ($zap_trace_span=null)
 

Protected Member Functions

 getHealthRequest ($zap_trace_span=null)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\HealthService::__construct ( DefaultApi  $defaultApi)
Parameters
DefaultApi$defaultApi
HeaderSelector$selector

Member Function Documentation

◆ getHealth()

InfluxDB2\Service\HealthService::getHealth (   $zap_trace_span = null)

Operation getHealth

Retrieve the health of the instance

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\HealthCheck|\InfluxDB2\Model\HealthCheck|string

◆ getHealthRequest()

InfluxDB2\Service\HealthService::getHealthRequest (   $zap_trace_span = null)
protected

Create request for operation 'getHealth'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getHealthWithHttpInfo()

InfluxDB2\Service\HealthService::getHealthWithHttpInfo (   $zap_trace_span = null)

Operation getHealthWithHttpInfo

Retrieve the health of the instance

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\HealthCheck|\InfluxDB2\Model\HealthCheck|string, HTTP status code, HTTP response headers (array of strings)

The documentation for this class was generated from the following file: