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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 getTelegrafPlugins ($zap_trace_span=null, $type=null)
 
 getTelegrafPluginsWithHttpInfo ($zap_trace_span=null, $type=null)
 
 getTelegrafPluginsAsync ($zap_trace_span=null, $type=null)
 
 getTelegrafPluginsAsyncWithHttpInfo ($zap_trace_span=null, $type=null)
 

Protected Member Functions

 getTelegrafPluginsRequest ($zap_trace_span=null, $type=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\TelegrafPluginsService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

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

◆ getTelegrafPlugins()

InfluxDB2\Service\TelegrafPluginsService::getTelegrafPlugins (   $zap_trace_span = null,
  $type = null 
)

Operation getTelegrafPlugins

List all Telegraf plugins

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$typeThe type of plugin desired. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\TelegrafPlugins|\InfluxDB2\Model\Error

◆ getTelegrafPluginsAsync()

InfluxDB2\Service\TelegrafPluginsService::getTelegrafPluginsAsync (   $zap_trace_span = null,
  $type = null 
)

Operation getTelegrafPluginsAsync

List all Telegraf plugins

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$typeThe type of plugin desired. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTelegrafPluginsAsyncWithHttpInfo()

InfluxDB2\Service\TelegrafPluginsService::getTelegrafPluginsAsyncWithHttpInfo (   $zap_trace_span = null,
  $type = null 
)

Operation getTelegrafPluginsAsyncWithHttpInfo

List all Telegraf plugins

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$typeThe type of plugin desired. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTelegrafPluginsRequest()

InfluxDB2\Service\TelegrafPluginsService::getTelegrafPluginsRequest (   $zap_trace_span = null,
  $type = null 
)
protected

Create request for operation 'getTelegrafPlugins'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$typeThe type of plugin desired. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getTelegrafPluginsWithHttpInfo()

InfluxDB2\Service\TelegrafPluginsService::getTelegrafPluginsWithHttpInfo (   $zap_trace_span = null,
  $type = null 
)

Operation getTelegrafPluginsWithHttpInfo

List all Telegraf plugins

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$typeThe type of plugin desired. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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