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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 getReady ($zap_trace_span=null)
 
 getReadyWithHttpInfo ($zap_trace_span=null)
 
 getReadyAsync ($zap_trace_span=null)
 
 getReadyAsyncWithHttpInfo ($zap_trace_span=null)
 

Protected Member Functions

 getReadyRequest ($zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\ReadyService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

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

◆ getReady()

InfluxDB2\Service\ReadyService::getReady (   $zap_trace_span = null)

Operation getReady

Get the readiness of an instance at startup

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Ready|\InfluxDB2\Model\Error

◆ getReadyAsync()

InfluxDB2\Service\ReadyService::getReadyAsync (   $zap_trace_span = null)

Operation getReadyAsync

Get the readiness of an instance at startup

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getReadyAsyncWithHttpInfo()

InfluxDB2\Service\ReadyService::getReadyAsyncWithHttpInfo (   $zap_trace_span = null)

Operation getReadyAsyncWithHttpInfo

Get the readiness of an instance at startup

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getReadyRequest()

InfluxDB2\Service\ReadyService::getReadyRequest (   $zap_trace_span = null)
protected

Create request for operation 'getReady'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getReadyWithHttpInfo()

InfluxDB2\Service\ReadyService::getReadyWithHttpInfo (   $zap_trace_span = null)

Operation getReadyWithHttpInfo

Get the readiness of an instance at startup

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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