InfluxDB PHP Client
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\HealthService Class Reference

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 getHealth ($zap_trace_span=null)
 
 getHealthWithHttpInfo ($zap_trace_span=null)
 
 getHealthAsync ($zap_trace_span=null)
 
 getHealthAsyncWithHttpInfo ($zap_trace_span=null)
 

Protected Member Functions

 getHealthRequest ($zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\HealthService::__construct ( ClientInterface  $client = null,
Configuration  $config = null,
HeaderSelector  $selector = null 
)
Parameters
ClientInterface$client
Configuration$config
HeaderSelector$selector

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\HealthService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

InfluxDB2\Service\HealthService::getConfig ( )
Returns
Configuration

◆ getHealth()

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

Operation getHealth

Get the health of an 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|\InfluxDB2\Model\Error

◆ getHealthAsync()

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

Operation getHealthAsync

Get the health of an instance

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getHealthAsyncWithHttpInfo()

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

Operation getHealthAsyncWithHttpInfo

Get the health of an instance

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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
\GuzzleHttp\Psr7\Request

◆ getHealthWithHttpInfo()

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

Operation getHealthWithHttpInfo

Get the health of an 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|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

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