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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 getNotificationRulesIDQuery ($rule_id, $zap_trace_span=null)
 
 getNotificationRulesIDQueryWithHttpInfo ($rule_id, $zap_trace_span=null)
 
 getNotificationRulesIDQueryAsync ($rule_id, $zap_trace_span=null)
 
 getNotificationRulesIDQueryAsyncWithHttpInfo ($rule_id, $zap_trace_span=null)
 

Protected Member Functions

 getNotificationRulesIDQueryRequest ($rule_id, $zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\RulesService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

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

◆ getNotificationRulesIDQuery()

InfluxDB2\Service\RulesService::getNotificationRulesIDQuery (   $rule_id,
  $zap_trace_span = null 
)

Operation getNotificationRulesIDQuery

Retrieve a notification rule query

Parameters
string$rule_idThe notification rule ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\FluxResponse|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getNotificationRulesIDQueryAsync()

InfluxDB2\Service\RulesService::getNotificationRulesIDQueryAsync (   $rule_id,
  $zap_trace_span = null 
)

Operation getNotificationRulesIDQueryAsync

Retrieve a notification rule query

Parameters
string$rule_idThe notification rule ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationRulesIDQueryAsyncWithHttpInfo()

InfluxDB2\Service\RulesService::getNotificationRulesIDQueryAsyncWithHttpInfo (   $rule_id,
  $zap_trace_span = null 
)

Operation getNotificationRulesIDQueryAsyncWithHttpInfo

Retrieve a notification rule query

Parameters
string$rule_idThe notification rule ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationRulesIDQueryRequest()

InfluxDB2\Service\RulesService::getNotificationRulesIDQueryRequest (   $rule_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getNotificationRulesIDQuery'

Parameters
string$rule_idThe notification rule ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getNotificationRulesIDQueryWithHttpInfo()

InfluxDB2\Service\RulesService::getNotificationRulesIDQueryWithHttpInfo (   $rule_id,
  $zap_trace_span = null 
)

Operation getNotificationRulesIDQueryWithHttpInfo

Retrieve a notification rule query

Parameters
string$rule_idThe notification rule ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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