Public Member Functions
	__construct (DefaultApi $defaultApi)

	createNotificationRule ($notification_rule)

	createNotificationRuleWithHttpInfo ($notification_rule)

	deleteNotificationRulesID ($rule_id, $zap_trace_span=null)

	deleteNotificationRulesIDWithHttpInfo ($rule_id, $zap_trace_span=null)

	deleteNotificationRulesIDLabelsID ($rule_id, $label_id, $zap_trace_span=null)

	deleteNotificationRulesIDLabelsIDWithHttpInfo ($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)

	getNotificationRulesID ($rule_id, $zap_trace_span=null)

	getNotificationRulesIDWithHttpInfo ($rule_id, $zap_trace_span=null)

	getNotificationRulesIDLabels ($rule_id, $zap_trace_span=null)

	getNotificationRulesIDLabelsWithHttpInfo ($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)

	postNotificationRuleIDLabels ($rule_id, $label_mapping, $zap_trace_span=null)

	postNotificationRuleIDLabelsWithHttpInfo ($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)

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)

Protected Attributes
	$defaultApi

	$headerSelector

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\NotificationRulesService::__construct ( DefaultApi $defaultApi )

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

◆ createNotificationRule()

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

Operation createNotificationRule

Add a notification rule

Parameters

\InfluxDB2\Model\NotificationRule $notification_rule Notification rule to create (required)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ createNotificationRuleRequest()

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

protected

Create request for operation 'createNotificationRule'

Parameters

\InfluxDB2\Model\NotificationRule $notification_rule Notification rule to create (required)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ createNotificationRuleWithHttpInfo()

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

Operation createNotificationRuleWithHttpInfo

Add a notification rule

Parameters

\InfluxDB2\Model\NotificationRule $notification_rule Notification 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_id	The notification rule ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteNotificationRulesIDLabelsID()

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

Operation deleteNotificationRulesIDLabelsID

Delete label from a notification rule

Parameters

string	$rule_id	The notification rule ID. (required)
string	$label_id	The ID of the label to delete. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteNotificationRulesIDLabelsIDRequest()

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

protected

Create request for operation 'deleteNotificationRulesIDLabelsID'

Parameters

string	$rule_id	The notification rule ID. (required)
string	$label_id	The ID of the label to delete. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteNotificationRulesIDLabelsIDWithHttpInfo()

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

Operation deleteNotificationRulesIDLabelsIDWithHttpInfo

Delete label from a notification rule

Parameters

string	$rule_id	The notification rule ID. (required)
string	$label_id	The ID of the label to delete. (required)
string	$zap_trace_span	OpenTracing 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_id	The notification rule ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteNotificationRulesIDWithHttpInfo()

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

Operation deleteNotificationRulesIDWithHttpInfo

Delete a notification rule

Parameters

string	$rule_id	The notification rule ID. (required)
string	$zap_trace_span	OpenTracing 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)

◆ 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_id	Only show notification rules that belong to a specific organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
int	$offset	The offset for pagination. The number of records to skip. (optional)
int	$limit	Limits the number of records returned. Default is `20`. (optional, default to 20)
string	$check_id	Only show notifications that belong to the specific check ID. (optional)
string	$tag	Only 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

◆ getNotificationRulesID()

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

Operation getNotificationRulesID

Retrieve a notification rule

Parameters

string	$rule_id	The notification rule ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getNotificationRulesIDLabels()

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

Operation getNotificationRulesIDLabels

List all labels for a notification rule

Parameters

string	$rule_id	The notification rule ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error

◆ getNotificationRulesIDLabelsRequest()

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

protected

Create request for operation 'getNotificationRulesIDLabels'

Parameters

string	$rule_id	The notification rule ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getNotificationRulesIDLabelsWithHttpInfo()

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

Operation getNotificationRulesIDLabelsWithHttpInfo

List all labels for a notification rule

Parameters

string	$rule_id	The notification rule ID. (required)
string	$zap_trace_span	OpenTracing 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_id	The notification rule ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getNotificationRulesIDWithHttpInfo()

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

Operation getNotificationRulesIDWithHttpInfo

Retrieve a notification rule

Parameters

string	$rule_id	The notification rule ID. (required)
string	$zap_trace_span	OpenTracing 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_id	Only show notification rules that belong to a specific organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
int	$offset	The offset for pagination. The number of records to skip. (optional)
int	$limit	Limits the number of records returned. Default is `20`. (optional, default to 20)
string	$check_id	Only show notifications that belong to the specific check ID. (optional)
string	$tag	Only return notification rules that "would match" statuses which contain the tag key value pairs provided. (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ 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_id	Only show notification rules that belong to a specific organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
int	$offset	The offset for pagination. The number of records to skip. (optional)
int	$limit	Limits the number of records returned. Default is `20`. (optional, default to 20)
string	$check_id	Only show notifications that belong to the specific check ID. (optional)
string	$tag	Only 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_id	The notification rule ID. (required)
\InfluxDB2\Model\NotificationRuleUpdate	$notification_rule_update	Notification rule update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchNotificationRulesIDRequest()

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

protected

Create request for operation 'patchNotificationRulesID'

Parameters

string	$rule_id	The notification rule ID. (required)
\InfluxDB2\Model\NotificationRuleUpdate	$notification_rule_update	Notification rule update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ patchNotificationRulesIDWithHttpInfo()

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

Operation patchNotificationRulesIDWithHttpInfo

Update a notification rule

Parameters

string	$rule_id	The notification rule ID. (required)
\InfluxDB2\Model\NotificationRuleUpdate	$notification_rule_update	Notification rule update to apply (required)
string	$zap_trace_span	OpenTracing 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_id	The notification rule ID. (required)
\InfluxDB2\Model\LabelMapping	$label_mapping	Label to add (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postNotificationRuleIDLabelsRequest()

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

protected

Create request for operation 'postNotificationRuleIDLabels'

Parameters

string	$rule_id	The notification rule ID. (required)
\InfluxDB2\Model\LabelMapping	$label_mapping	Label to add (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ 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_id	The notification rule ID. (required)
\InfluxDB2\Model\LabelMapping	$label_mapping	Label to add (required)
string	$zap_trace_span	OpenTracing 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_id	The notification rule ID. (required)
\InfluxDB2\Model\NotificationRule	$notification_rule	Notification rule update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ putNotificationRulesIDRequest()

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

protected

Create request for operation 'putNotificationRulesID'

Parameters

string	$rule_id	The notification rule ID. (required)
\InfluxDB2\Model\NotificationRule	$notification_rule	Notification rule update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ putNotificationRulesIDWithHttpInfo()

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

Operation putNotificationRulesIDWithHttpInfo

Update a notification rule

Parameters

string	$rule_id	The notification rule ID. (required)
\InfluxDB2\Model\NotificationRule	$notification_rule	Notification rule update to apply (required)
string	$zap_trace_span	OpenTracing 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:

src/InfluxDB2/Service/NotificationRulesService.php

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createNotificationRule()

◆ createNotificationRuleRequest()

◆ createNotificationRuleWithHttpInfo()

◆ deleteNotificationRulesID()

◆ deleteNotificationRulesIDLabelsID()

◆ deleteNotificationRulesIDLabelsIDRequest()

◆ deleteNotificationRulesIDLabelsIDWithHttpInfo()

◆ deleteNotificationRulesIDRequest()

◆ deleteNotificationRulesIDWithHttpInfo()

◆ getNotificationRules()

◆ getNotificationRulesID()

◆ getNotificationRulesIDLabels()

◆ getNotificationRulesIDLabelsRequest()

◆ getNotificationRulesIDLabelsWithHttpInfo()

◆ getNotificationRulesIDRequest()

◆ getNotificationRulesIDWithHttpInfo()

◆ getNotificationRulesRequest()

◆ getNotificationRulesWithHttpInfo()

◆ patchNotificationRulesID()

◆ patchNotificationRulesIDRequest()

◆ patchNotificationRulesIDWithHttpInfo()

◆ postNotificationRuleIDLabels()

◆ postNotificationRuleIDLabelsRequest()

◆ postNotificationRuleIDLabelsWithHttpInfo()

◆ putNotificationRulesID()

◆ putNotificationRulesIDRequest()

◆ putNotificationRulesIDWithHttpInfo()