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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 getPing ()
 
 getPingWithHttpInfo ()
 
 getPingAsync ()
 
 getPingAsyncWithHttpInfo ()
 
 headPing ()
 
 headPingWithHttpInfo ()
 
 headPingAsync ()
 
 headPingAsyncWithHttpInfo ()
 

Protected Member Functions

 getPingRequest ()
 
 headPingRequest ()
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\PingService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

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

◆ getPing()

InfluxDB2\Service\PingService::getPing ( )

Operation getPing

Checks the status of InfluxDB instance and version of InfluxDB.

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ getPingAsync()

InfluxDB2\Service\PingService::getPingAsync ( )

Operation getPingAsync

Checks the status of InfluxDB instance and version of InfluxDB.

Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getPingAsyncWithHttpInfo()

InfluxDB2\Service\PingService::getPingAsyncWithHttpInfo ( )

Operation getPingAsyncWithHttpInfo

Checks the status of InfluxDB instance and version of InfluxDB.

Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getPingRequest()

InfluxDB2\Service\PingService::getPingRequest ( )
protected

Create request for operation 'getPing'

Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getPingWithHttpInfo()

InfluxDB2\Service\PingService::getPingWithHttpInfo ( )

Operation getPingWithHttpInfo

Checks the status of InfluxDB instance and version of InfluxDB.

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ headPing()

InfluxDB2\Service\PingService::headPing ( )

Operation headPing

Checks the status of InfluxDB instance and version of InfluxDB.

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ headPingAsync()

InfluxDB2\Service\PingService::headPingAsync ( )

Operation headPingAsync

Checks the status of InfluxDB instance and version of InfluxDB.

Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ headPingAsyncWithHttpInfo()

InfluxDB2\Service\PingService::headPingAsyncWithHttpInfo ( )

Operation headPingAsyncWithHttpInfo

Checks the status of InfluxDB instance and version of InfluxDB.

Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ headPingRequest()

InfluxDB2\Service\PingService::headPingRequest ( )
protected

Create request for operation 'headPing'

Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ headPingWithHttpInfo()

InfluxDB2\Service\PingService::headPingWithHttpInfo ( )

Operation headPingWithHttpInfo

Checks the status of InfluxDB instance and version of InfluxDB.

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

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