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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 postSignin ($zap_trace_span=null, $authorization=null)
 
 postSigninWithHttpInfo ($zap_trace_span=null, $authorization=null)
 
 postSigninAsync ($zap_trace_span=null, $authorization=null)
 
 postSigninAsyncWithHttpInfo ($zap_trace_span=null, $authorization=null)
 
 postSignout ($zap_trace_span=null)
 
 postSignoutWithHttpInfo ($zap_trace_span=null)
 
 postSignoutAsync ($zap_trace_span=null)
 
 postSignoutAsyncWithHttpInfo ($zap_trace_span=null)
 

Protected Member Functions

 postSigninRequest ($zap_trace_span=null, $authorization=null)
 
 postSignoutRequest ($zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\DefaultService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

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

◆ postSignin()

InfluxDB2\Service\DefaultService::postSignin (   $zap_trace_span = null,
  $authorization = null 
)

Operation postSignin

Exchange basic auth credentials for session

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ postSigninAsync()

InfluxDB2\Service\DefaultService::postSigninAsync (   $zap_trace_span = null,
  $authorization = null 
)

Operation postSigninAsync

Exchange basic auth credentials for session

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postSigninAsyncWithHttpInfo()

InfluxDB2\Service\DefaultService::postSigninAsyncWithHttpInfo (   $zap_trace_span = null,
  $authorization = null 
)

Operation postSigninAsyncWithHttpInfo

Exchange basic auth credentials for session

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postSigninRequest()

InfluxDB2\Service\DefaultService::postSigninRequest (   $zap_trace_span = null,
  $authorization = null 
)
protected

Create request for operation 'postSignin'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postSigninWithHttpInfo()

InfluxDB2\Service\DefaultService::postSigninWithHttpInfo (   $zap_trace_span = null,
  $authorization = null 
)

Operation postSigninWithHttpInfo

Exchange basic auth credentials for session

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$authorizationAn auth credential for the Basic scheme (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postSignout()

InfluxDB2\Service\DefaultService::postSignout (   $zap_trace_span = null)

Operation postSignout

Expire the current session

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ postSignoutAsync()

InfluxDB2\Service\DefaultService::postSignoutAsync (   $zap_trace_span = null)

Operation postSignoutAsync

Expire the current session

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postSignoutAsyncWithHttpInfo()

InfluxDB2\Service\DefaultService::postSignoutAsyncWithHttpInfo (   $zap_trace_span = null)

Operation postSignoutAsyncWithHttpInfo

Expire the current session

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postSignoutRequest()

InfluxDB2\Service\DefaultService::postSignoutRequest (   $zap_trace_span = null)
protected

Create request for operation 'postSignout'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postSignoutWithHttpInfo()

InfluxDB2\Service\DefaultService::postSignoutWithHttpInfo (   $zap_trace_span = null)

Operation postSignoutWithHttpInfo

Expire the current session

Parameters
string$zap_trace_spanOpenTracing span context (optional)
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: