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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 getRoutes ($zap_trace_span=null)
 
 getRoutesWithHttpInfo ($zap_trace_span=null)
 
 getRoutesAsync ($zap_trace_span=null)
 
 getRoutesAsyncWithHttpInfo ($zap_trace_span=null)
 

Protected Member Functions

 getRoutesRequest ($zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\RoutesService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

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

◆ getRoutes()

InfluxDB2\Service\RoutesService::getRoutes (   $zap_trace_span = null)

Operation getRoutes

List all top level routes

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Routes

◆ getRoutesAsync()

InfluxDB2\Service\RoutesService::getRoutesAsync (   $zap_trace_span = null)

Operation getRoutesAsync

List all top level routes

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getRoutesAsyncWithHttpInfo()

InfluxDB2\Service\RoutesService::getRoutesAsyncWithHttpInfo (   $zap_trace_span = null)

Operation getRoutesAsyncWithHttpInfo

List all top level routes

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getRoutesRequest()

InfluxDB2\Service\RoutesService::getRoutesRequest (   $zap_trace_span = null)
protected

Create request for operation 'getRoutes'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getRoutesWithHttpInfo()

InfluxDB2\Service\RoutesService::getRoutesWithHttpInfo (   $zap_trace_span = null)

Operation getRoutesWithHttpInfo

List all top level routes

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Routes, HTTP status code, HTTP response headers (array of strings)

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