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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 createNotificationRule ($notification_rule)
 
 createNotificationRuleWithHttpInfo ($notification_rule)
 
 createNotificationRuleAsync ($notification_rule)
 
 createNotificationRuleAsyncWithHttpInfo ($notification_rule)
 
 deleteNotificationRulesID ($rule_id, $zap_trace_span=null)
 
 deleteNotificationRulesIDWithHttpInfo ($rule_id, $zap_trace_span=null)
 
 deleteNotificationRulesIDAsync ($rule_id, $zap_trace_span=null)
 
 deleteNotificationRulesIDAsyncWithHttpInfo ($rule_id, $zap_trace_span=null)
 
 deleteNotificationRulesIDLabelsID ($rule_id, $label_id, $zap_trace_span=null)
 
 deleteNotificationRulesIDLabelsIDWithHttpInfo ($rule_id, $label_id, $zap_trace_span=null)
 
 deleteNotificationRulesIDLabelsIDAsync ($rule_id, $label_id, $zap_trace_span=null)
 
 deleteNotificationRulesIDLabelsIDAsyncWithHttpInfo ($rule_id, $label_id, $zap_trace_span=null)
 
 getNotificationRules ($org_id, $zap_trace_span=null, $offset=null, $limit=20, $check_id=null, $tag=null)
 
 getNotificationRulesWithHttpInfo ($org_id, $zap_trace_span=null, $offset=null, $limit=20, $check_id=null, $tag=null)
 
 getNotificationRulesAsync ($org_id, $zap_trace_span=null, $offset=null, $limit=20, $check_id=null, $tag=null)
 
 getNotificationRulesAsyncWithHttpInfo ($org_id, $zap_trace_span=null, $offset=null, $limit=20, $check_id=null, $tag=null)
 
 getNotificationRulesID ($rule_id, $zap_trace_span=null)
 
 getNotificationRulesIDWithHttpInfo ($rule_id, $zap_trace_span=null)
 
 getNotificationRulesIDAsync ($rule_id, $zap_trace_span=null)
 
 getNotificationRulesIDAsyncWithHttpInfo ($rule_id, $zap_trace_span=null)
 
 getNotificationRulesIDLabels ($rule_id, $zap_trace_span=null)
 
 getNotificationRulesIDLabelsWithHttpInfo ($rule_id, $zap_trace_span=null)
 
 getNotificationRulesIDLabelsAsync ($rule_id, $zap_trace_span=null)
 
 getNotificationRulesIDLabelsAsyncWithHttpInfo ($rule_id, $zap_trace_span=null)
 
 patchNotificationRulesID ($rule_id, $notification_rule_update, $zap_trace_span=null)
 
 patchNotificationRulesIDWithHttpInfo ($rule_id, $notification_rule_update, $zap_trace_span=null)
 
 patchNotificationRulesIDAsync ($rule_id, $notification_rule_update, $zap_trace_span=null)
 
 patchNotificationRulesIDAsyncWithHttpInfo ($rule_id, $notification_rule_update, $zap_trace_span=null)
 
 postNotificationRuleIDLabels ($rule_id, $label_mapping, $zap_trace_span=null)
 
 postNotificationRuleIDLabelsWithHttpInfo ($rule_id, $label_mapping, $zap_trace_span=null)
 
 postNotificationRuleIDLabelsAsync ($rule_id, $label_mapping, $zap_trace_span=null)
 
 postNotificationRuleIDLabelsAsyncWithHttpInfo ($rule_id, $label_mapping, $zap_trace_span=null)
 
 putNotificationRulesID ($rule_id, $notification_rule, $zap_trace_span=null)
 
 putNotificationRulesIDWithHttpInfo ($rule_id, $notification_rule, $zap_trace_span=null)
 
 putNotificationRulesIDAsync ($rule_id, $notification_rule, $zap_trace_span=null)
 
 putNotificationRulesIDAsyncWithHttpInfo ($rule_id, $notification_rule, $zap_trace_span=null)
 

Protected Member Functions

 createNotificationRuleRequest ($notification_rule)
 
 deleteNotificationRulesIDRequest ($rule_id, $zap_trace_span=null)
 
 deleteNotificationRulesIDLabelsIDRequest ($rule_id, $label_id, $zap_trace_span=null)
 
 getNotificationRulesRequest ($org_id, $zap_trace_span=null, $offset=null, $limit=20, $check_id=null, $tag=null)
 
 getNotificationRulesIDRequest ($rule_id, $zap_trace_span=null)
 
 getNotificationRulesIDLabelsRequest ($rule_id, $zap_trace_span=null)
 
 patchNotificationRulesIDRequest ($rule_id, $notification_rule_update, $zap_trace_span=null)
 
 postNotificationRuleIDLabelsRequest ($rule_id, $label_mapping, $zap_trace_span=null)
 
 putNotificationRulesIDRequest ($rule_id, $notification_rule, $zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\NotificationRulesService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ createNotificationRule()

InfluxDB2\Service\NotificationRulesService::createNotificationRule (   $notification_rule)

Operation createNotificationRule

Add a notification rule

Parameters
\InfluxDB2\Model\NotificationRule$notification_ruleNotification rule to create (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\NotificationRule|\InfluxDB2\Model\Error

◆ createNotificationRuleAsync()

InfluxDB2\Service\NotificationRulesService::createNotificationRuleAsync (   $notification_rule)

Operation createNotificationRuleAsync

Add a notification rule

Parameters
\InfluxDB2\Model\NotificationRule$notification_ruleNotification rule to create (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ createNotificationRuleAsyncWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::createNotificationRuleAsyncWithHttpInfo (   $notification_rule)

Operation createNotificationRuleAsyncWithHttpInfo

Add a notification rule

Parameters
\InfluxDB2\Model\NotificationRule$notification_ruleNotification rule to create (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ createNotificationRuleRequest()

InfluxDB2\Service\NotificationRulesService::createNotificationRuleRequest (   $notification_rule)
protected

Create request for operation 'createNotificationRule'

Parameters
\InfluxDB2\Model\NotificationRule$notification_ruleNotification rule to create (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ createNotificationRuleWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::createNotificationRuleWithHttpInfo (   $notification_rule)

Operation createNotificationRuleWithHttpInfo

Add a notification rule

Parameters
\InfluxDB2\Model\NotificationRule$notification_ruleNotification rule to create (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ deleteNotificationRulesID()

InfluxDB2\Service\NotificationRulesService::deleteNotificationRulesID (   $rule_id,
  $zap_trace_span = null 
)

Operation deleteNotificationRulesID

Delete a notification rule

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
void

◆ deleteNotificationRulesIDAsync()

InfluxDB2\Service\NotificationRulesService::deleteNotificationRulesIDAsync (   $rule_id,
  $zap_trace_span = null 
)

Operation deleteNotificationRulesIDAsync

Delete a notification rule

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteNotificationRulesIDAsyncWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::deleteNotificationRulesIDAsyncWithHttpInfo (   $rule_id,
  $zap_trace_span = null 
)

Operation deleteNotificationRulesIDAsyncWithHttpInfo

Delete a notification rule

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteNotificationRulesIDLabelsID()

InfluxDB2\Service\NotificationRulesService::deleteNotificationRulesIDLabelsID (   $rule_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteNotificationRulesIDLabelsID

Delete label from a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
string$label_idThe ID of the label to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteNotificationRulesIDLabelsIDAsync()

InfluxDB2\Service\NotificationRulesService::deleteNotificationRulesIDLabelsIDAsync (   $rule_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteNotificationRulesIDLabelsIDAsync

Delete label from a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
string$label_idThe ID of the label to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteNotificationRulesIDLabelsIDAsyncWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::deleteNotificationRulesIDLabelsIDAsyncWithHttpInfo (   $rule_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteNotificationRulesIDLabelsIDAsyncWithHttpInfo

Delete label from a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
string$label_idThe ID of the label to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteNotificationRulesIDLabelsIDRequest()

InfluxDB2\Service\NotificationRulesService::deleteNotificationRulesIDLabelsIDRequest (   $rule_id,
  $label_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteNotificationRulesIDLabelsID'

Parameters
string$rule_idThe notification rule ID. (required)
string$label_idThe ID of the label to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteNotificationRulesIDLabelsIDWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::deleteNotificationRulesIDLabelsIDWithHttpInfo (   $rule_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteNotificationRulesIDLabelsIDWithHttpInfo

Delete label from a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
string$label_idThe ID of the label to delete. (required)
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)

◆ deleteNotificationRulesIDRequest()

InfluxDB2\Service\NotificationRulesService::deleteNotificationRulesIDRequest (   $rule_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteNotificationRulesID'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteNotificationRulesIDWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::deleteNotificationRulesIDWithHttpInfo (   $rule_id,
  $zap_trace_span = null 
)

Operation deleteNotificationRulesIDWithHttpInfo

Delete a notification rule

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 null, HTTP status code, HTTP response headers (array of strings)

◆ getConfig()

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

◆ getNotificationRules()

InfluxDB2\Service\NotificationRulesService::getNotificationRules (   $org_id,
  $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $check_id = null,
  $tag = null 
)

Operation getNotificationRules

List all notification rules

Parameters
string$org_idOnly show notification rules that belong to a specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offsetoffset (optional)
int$limitlimit (optional, default to 20)
string$check_idOnly show notifications that belong to the specific check ID. (optional)
string$tagOnly return notification rules that "would match" statuses which contain the tag key value pairs provided. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\NotificationRules|\InfluxDB2\Model\Error

◆ getNotificationRulesAsync()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesAsync (   $org_id,
  $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $check_id = null,
  $tag = null 
)

Operation getNotificationRulesAsync

List all notification rules

Parameters
string$org_idOnly show notification rules that belong to a specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
string$check_idOnly show notifications that belong to the specific check ID. (optional)
string$tagOnly return notification rules that "would match" statuses which contain the tag key value pairs provided. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationRulesAsyncWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesAsyncWithHttpInfo (   $org_id,
  $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $check_id = null,
  $tag = null 
)

Operation getNotificationRulesAsyncWithHttpInfo

List all notification rules

Parameters
string$org_idOnly show notification rules that belong to a specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
string$check_idOnly show notifications that belong to the specific check ID. (optional)
string$tagOnly return notification rules that "would match" statuses which contain the tag key value pairs provided. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationRulesID()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesID (   $rule_id,
  $zap_trace_span = null 
)

Operation getNotificationRulesID

Retrieve a notification rule

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\NotificationRule|\InfluxDB2\Model\Error

◆ getNotificationRulesIDAsync()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesIDAsync (   $rule_id,
  $zap_trace_span = null 
)

Operation getNotificationRulesIDAsync

Retrieve a notification rule

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationRulesIDAsyncWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesIDAsyncWithHttpInfo (   $rule_id,
  $zap_trace_span = null 
)

Operation getNotificationRulesIDAsyncWithHttpInfo

Retrieve a notification rule

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationRulesIDLabels()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesIDLabels (   $rule_id,
  $zap_trace_span = null 
)

Operation getNotificationRulesIDLabels

List all labels for a notification rule

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\LabelsResponse|\InfluxDB2\Model\Error

◆ getNotificationRulesIDLabelsAsync()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesIDLabelsAsync (   $rule_id,
  $zap_trace_span = null 
)

Operation getNotificationRulesIDLabelsAsync

List all labels for a notification rule

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationRulesIDLabelsAsyncWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesIDLabelsAsyncWithHttpInfo (   $rule_id,
  $zap_trace_span = null 
)

Operation getNotificationRulesIDLabelsAsyncWithHttpInfo

List all labels for a notification rule

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationRulesIDLabelsRequest()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesIDLabelsRequest (   $rule_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getNotificationRulesIDLabels'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getNotificationRulesIDLabelsWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesIDLabelsWithHttpInfo (   $rule_id,
  $zap_trace_span = null 
)

Operation getNotificationRulesIDLabelsWithHttpInfo

List all labels for a notification rule

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\LabelsResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getNotificationRulesIDRequest()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesIDRequest (   $rule_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getNotificationRulesID'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getNotificationRulesIDWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesIDWithHttpInfo (   $rule_id,
  $zap_trace_span = null 
)

Operation getNotificationRulesIDWithHttpInfo

Retrieve a notification rule

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\NotificationRule|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getNotificationRulesRequest()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesRequest (   $org_id,
  $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $check_id = null,
  $tag = null 
)
protected

Create request for operation 'getNotificationRules'

Parameters
string$org_idOnly show notification rules that belong to a specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
string$check_idOnly show notifications that belong to the specific check ID. (optional)
string$tagOnly return notification rules that "would match" statuses which contain the tag key value pairs provided. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getNotificationRulesWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::getNotificationRulesWithHttpInfo (   $org_id,
  $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $check_id = null,
  $tag = null 
)

Operation getNotificationRulesWithHttpInfo

List all notification rules

Parameters
string$org_idOnly show notification rules that belong to a specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
string$check_idOnly show notifications that belong to the specific check ID. (optional)
string$tagOnly return notification rules that "would match" statuses which contain the tag key value pairs provided. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchNotificationRulesID()

InfluxDB2\Service\NotificationRulesService::patchNotificationRulesID (   $rule_id,
  $notification_rule_update,
  $zap_trace_span = null 
)

Operation patchNotificationRulesID

Update a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\NotificationRuleUpdate$notification_rule_updateNotification rule update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\NotificationRule|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ patchNotificationRulesIDAsync()

InfluxDB2\Service\NotificationRulesService::patchNotificationRulesIDAsync (   $rule_id,
  $notification_rule_update,
  $zap_trace_span = null 
)

Operation patchNotificationRulesIDAsync

Update a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\NotificationRuleUpdate$notification_rule_updateNotification rule update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchNotificationRulesIDAsyncWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::patchNotificationRulesIDAsyncWithHttpInfo (   $rule_id,
  $notification_rule_update,
  $zap_trace_span = null 
)

Operation patchNotificationRulesIDAsyncWithHttpInfo

Update a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\NotificationRuleUpdate$notification_rule_updateNotification rule update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchNotificationRulesIDRequest()

InfluxDB2\Service\NotificationRulesService::patchNotificationRulesIDRequest (   $rule_id,
  $notification_rule_update,
  $zap_trace_span = null 
)
protected

Create request for operation 'patchNotificationRulesID'

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\NotificationRuleUpdate$notification_rule_updateNotification rule update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchNotificationRulesIDWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::patchNotificationRulesIDWithHttpInfo (   $rule_id,
  $notification_rule_update,
  $zap_trace_span = null 
)

Operation patchNotificationRulesIDWithHttpInfo

Update a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\NotificationRuleUpdate$notification_rule_updateNotification rule update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postNotificationRuleIDLabels()

InfluxDB2\Service\NotificationRulesService::postNotificationRuleIDLabels (   $rule_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postNotificationRuleIDLabels

Add a label to a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error

◆ postNotificationRuleIDLabelsAsync()

InfluxDB2\Service\NotificationRulesService::postNotificationRuleIDLabelsAsync (   $rule_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postNotificationRuleIDLabelsAsync

Add a label to a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postNotificationRuleIDLabelsAsyncWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::postNotificationRuleIDLabelsAsyncWithHttpInfo (   $rule_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postNotificationRuleIDLabelsAsyncWithHttpInfo

Add a label to a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postNotificationRuleIDLabelsRequest()

InfluxDB2\Service\NotificationRulesService::postNotificationRuleIDLabelsRequest (   $rule_id,
  $label_mapping,
  $zap_trace_span = null 
)
protected

Create request for operation 'postNotificationRuleIDLabels'

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postNotificationRuleIDLabelsWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::postNotificationRuleIDLabelsWithHttpInfo (   $rule_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postNotificationRuleIDLabelsWithHttpInfo

Add a label to a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ putNotificationRulesID()

InfluxDB2\Service\NotificationRulesService::putNotificationRulesID (   $rule_id,
  $notification_rule,
  $zap_trace_span = null 
)

Operation putNotificationRulesID

Update a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\NotificationRule$notification_ruleNotification rule update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\NotificationRule|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ putNotificationRulesIDAsync()

InfluxDB2\Service\NotificationRulesService::putNotificationRulesIDAsync (   $rule_id,
  $notification_rule,
  $zap_trace_span = null 
)

Operation putNotificationRulesIDAsync

Update a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\NotificationRule$notification_ruleNotification rule update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ putNotificationRulesIDAsyncWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::putNotificationRulesIDAsyncWithHttpInfo (   $rule_id,
  $notification_rule,
  $zap_trace_span = null 
)

Operation putNotificationRulesIDAsyncWithHttpInfo

Update a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\NotificationRule$notification_ruleNotification rule update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ putNotificationRulesIDRequest()

InfluxDB2\Service\NotificationRulesService::putNotificationRulesIDRequest (   $rule_id,
  $notification_rule,
  $zap_trace_span = null 
)
protected

Create request for operation 'putNotificationRulesID'

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\NotificationRule$notification_ruleNotification rule update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ putNotificationRulesIDWithHttpInfo()

InfluxDB2\Service\NotificationRulesService::putNotificationRulesIDWithHttpInfo (   $rule_id,
  $notification_rule,
  $zap_trace_span = null 
)

Operation putNotificationRulesIDWithHttpInfo

Update a notification rule

Parameters
string$rule_idThe notification rule ID. (required)
\InfluxDB2\Model\NotificationRule$notification_ruleNotification rule update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\NotificationRule|\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: