Public Member Functions
	__construct (DefaultApi $defaultApi)

	createNotificationEndpoint ($notification_endpoint)

	createNotificationEndpointWithHttpInfo ($notification_endpoint)

	deleteNotificationEndpointsID ($endpoint_id, $zap_trace_span=null)

	deleteNotificationEndpointsIDWithHttpInfo ($endpoint_id, $zap_trace_span=null)

	deleteNotificationEndpointsIDLabelsID ($endpoint_id, $label_id, $zap_trace_span=null)

	deleteNotificationEndpointsIDLabelsIDWithHttpInfo ($endpoint_id, $label_id, $zap_trace_span=null)

	getNotificationEndpoints ($org_id, $zap_trace_span=null, $offset=null, $limit=20)

	getNotificationEndpointsWithHttpInfo ($org_id, $zap_trace_span=null, $offset=null, $limit=20)

	getNotificationEndpointsID ($endpoint_id, $zap_trace_span=null)

	getNotificationEndpointsIDWithHttpInfo ($endpoint_id, $zap_trace_span=null)

	getNotificationEndpointsIDLabels ($endpoint_id, $zap_trace_span=null)

	getNotificationEndpointsIDLabelsWithHttpInfo ($endpoint_id, $zap_trace_span=null)

	patchNotificationEndpointsID ($endpoint_id, $notification_endpoint_update, $zap_trace_span=null)

	patchNotificationEndpointsIDWithHttpInfo ($endpoint_id, $notification_endpoint_update, $zap_trace_span=null)

	postNotificationEndpointIDLabels ($endpoint_id, $label_mapping, $zap_trace_span=null)

	postNotificationEndpointIDLabelsWithHttpInfo ($endpoint_id, $label_mapping, $zap_trace_span=null)

	putNotificationEndpointsID ($endpoint_id, $notification_endpoint, $zap_trace_span=null)

	putNotificationEndpointsIDWithHttpInfo ($endpoint_id, $notification_endpoint, $zap_trace_span=null)

Protected Member Functions
	createNotificationEndpointRequest ($notification_endpoint)

	deleteNotificationEndpointsIDRequest ($endpoint_id, $zap_trace_span=null)

	deleteNotificationEndpointsIDLabelsIDRequest ($endpoint_id, $label_id, $zap_trace_span=null)

	getNotificationEndpointsRequest ($org_id, $zap_trace_span=null, $offset=null, $limit=20)

	getNotificationEndpointsIDRequest ($endpoint_id, $zap_trace_span=null)

	getNotificationEndpointsIDLabelsRequest ($endpoint_id, $zap_trace_span=null)

	patchNotificationEndpointsIDRequest ($endpoint_id, $notification_endpoint_update, $zap_trace_span=null)

	postNotificationEndpointIDLabelsRequest ($endpoint_id, $label_mapping, $zap_trace_span=null)

	putNotificationEndpointsIDRequest ($endpoint_id, $notification_endpoint, $zap_trace_span=null)

Protected Attributes
	$defaultApi

	$headerSelector

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

◆ createNotificationEndpoint()

InfluxDB2\Service\NotificationEndpointsService::createNotificationEndpoint ( $notification_endpoint )

Operation createNotificationEndpoint

Add a notification endpoint

Parameters

\InfluxDB2\Model\NotificationEndpoint $notification_endpoint Notification endpoint to create (required)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\NotificationEndpoint|\InfluxDB2\Model\Error

◆ createNotificationEndpointRequest()

InfluxDB2\Service\NotificationEndpointsService::createNotificationEndpointRequest ( $notification_endpoint )

protected

Create request for operation 'createNotificationEndpoint'

Parameters

\InfluxDB2\Model\NotificationEndpoint $notification_endpoint Notification endpoint to create (required)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ createNotificationEndpointWithHttpInfo()

InfluxDB2\Service\NotificationEndpointsService::createNotificationEndpointWithHttpInfo ( $notification_endpoint )

Operation createNotificationEndpointWithHttpInfo

Add a notification endpoint

Parameters

\InfluxDB2\Model\NotificationEndpoint $notification_endpoint Notification endpoint to create (required)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ deleteNotificationEndpointsID()

InfluxDB2\Service\NotificationEndpointsService::deleteNotificationEndpointsID	(		$endpoint_id,
			$zap_trace_span = null )

Operation deleteNotificationEndpointsID

Delete a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteNotificationEndpointsIDLabelsID()

InfluxDB2\Service\NotificationEndpointsService::deleteNotificationEndpointsIDLabelsID	(	$endpoint_id,
		$label_id,
		$zap_trace_span = null )

Operation deleteNotificationEndpointsIDLabelsID

Delete a label from a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint 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

◆ deleteNotificationEndpointsIDLabelsIDRequest()

InfluxDB2\Service\NotificationEndpointsService::deleteNotificationEndpointsIDLabelsIDRequest	(	$endpoint_id,
		$label_id,
		$zap_trace_span = null )

protected

Create request for operation 'deleteNotificationEndpointsIDLabelsID'

Parameters

string	$endpoint_id	The notification endpoint 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

◆ deleteNotificationEndpointsIDLabelsIDWithHttpInfo()

InfluxDB2\Service\NotificationEndpointsService::deleteNotificationEndpointsIDLabelsIDWithHttpInfo	(	$endpoint_id,
		$label_id,
		$zap_trace_span = null )

Operation deleteNotificationEndpointsIDLabelsIDWithHttpInfo

Delete a label from a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint 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)

◆ deleteNotificationEndpointsIDRequest()

InfluxDB2\Service\NotificationEndpointsService::deleteNotificationEndpointsIDRequest	(		$endpoint_id,
			$zap_trace_span = null )

protected

Create request for operation 'deleteNotificationEndpointsID'

Parameters

string	$endpoint_id	The notification endpoint ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteNotificationEndpointsIDWithHttpInfo()

InfluxDB2\Service\NotificationEndpointsService::deleteNotificationEndpointsIDWithHttpInfo	(		$endpoint_id,
			$zap_trace_span = null )

Operation deleteNotificationEndpointsIDWithHttpInfo

Delete a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint 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)

◆ getNotificationEndpoints()

InfluxDB2\Service\NotificationEndpointsService::getNotificationEndpoints	(	$org_id,
		$zap_trace_span = null,
		$offset = null,
		$limit = 20 )

Operation getNotificationEndpoints

List all notification endpoints

Parameters

string	$org_id	Only show notification endpoints that belong to 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)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\NotificationEndpoints|\InfluxDB2\Model\Error

◆ getNotificationEndpointsID()

InfluxDB2\Service\NotificationEndpointsService::getNotificationEndpointsID	(		$endpoint_id,
			$zap_trace_span = null )

Operation getNotificationEndpointsID

Retrieve a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\NotificationEndpoint|\InfluxDB2\Model\Error

◆ getNotificationEndpointsIDLabels()

InfluxDB2\Service\NotificationEndpointsService::getNotificationEndpointsIDLabels	(		$endpoint_id,
			$zap_trace_span = null )

Operation getNotificationEndpointsIDLabels

List all labels for a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint 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

◆ getNotificationEndpointsIDLabelsRequest()

InfluxDB2\Service\NotificationEndpointsService::getNotificationEndpointsIDLabelsRequest	(		$endpoint_id,
			$zap_trace_span = null )

protected

Create request for operation 'getNotificationEndpointsIDLabels'

Parameters

string	$endpoint_id	The notification endpoint ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getNotificationEndpointsIDLabelsWithHttpInfo()

InfluxDB2\Service\NotificationEndpointsService::getNotificationEndpointsIDLabelsWithHttpInfo	(		$endpoint_id,
			$zap_trace_span = null )

Operation getNotificationEndpointsIDLabelsWithHttpInfo

List all labels for a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint 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)

◆ getNotificationEndpointsIDRequest()

InfluxDB2\Service\NotificationEndpointsService::getNotificationEndpointsIDRequest	(		$endpoint_id,
			$zap_trace_span = null )

protected

Create request for operation 'getNotificationEndpointsID'

Parameters

string	$endpoint_id	The notification endpoint ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getNotificationEndpointsIDWithHttpInfo()

InfluxDB2\Service\NotificationEndpointsService::getNotificationEndpointsIDWithHttpInfo	(		$endpoint_id,
			$zap_trace_span = null )

Operation getNotificationEndpointsIDWithHttpInfo

Retrieve a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getNotificationEndpointsRequest()

InfluxDB2\Service\NotificationEndpointsService::getNotificationEndpointsRequest	(	$org_id,
		$zap_trace_span = null,
		$offset = null,
		$limit = 20 )

protected

Create request for operation 'getNotificationEndpoints'

Parameters

string	$org_id	Only show notification endpoints that belong to 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)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getNotificationEndpointsWithHttpInfo()

InfluxDB2\Service\NotificationEndpointsService::getNotificationEndpointsWithHttpInfo	(	$org_id,
		$zap_trace_span = null,
		$offset = null,
		$limit = 20 )

Operation getNotificationEndpointsWithHttpInfo

List all notification endpoints

Parameters

string	$org_id	Only show notification endpoints that belong to 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)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchNotificationEndpointsID()

InfluxDB2\Service\NotificationEndpointsService::patchNotificationEndpointsID	(	$endpoint_id,
		$notification_endpoint_update,
		$zap_trace_span = null )

Operation patchNotificationEndpointsID

Update a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpointUpdate	$notification_endpoint_update	Check update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\NotificationEndpoint|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ patchNotificationEndpointsIDRequest()

InfluxDB2\Service\NotificationEndpointsService::patchNotificationEndpointsIDRequest	(	$endpoint_id,
		$notification_endpoint_update,
		$zap_trace_span = null )

protected

Create request for operation 'patchNotificationEndpointsID'

Parameters

string	$endpoint_id	The notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpointUpdate	$notification_endpoint_update	Check update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ patchNotificationEndpointsIDWithHttpInfo()

InfluxDB2\Service\NotificationEndpointsService::patchNotificationEndpointsIDWithHttpInfo	(	$endpoint_id,
		$notification_endpoint_update,
		$zap_trace_span = null )

Operation patchNotificationEndpointsIDWithHttpInfo

Update a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpointUpdate	$notification_endpoint_update	Check 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\NotificationEndpoint|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postNotificationEndpointIDLabels()

InfluxDB2\Service\NotificationEndpointsService::postNotificationEndpointIDLabels	(	$endpoint_id,
		$label_mapping,
		$zap_trace_span = null )

Operation postNotificationEndpointIDLabels

Add a label to a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint 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

◆ postNotificationEndpointIDLabelsRequest()

InfluxDB2\Service\NotificationEndpointsService::postNotificationEndpointIDLabelsRequest	(	$endpoint_id,
		$label_mapping,
		$zap_trace_span = null )

protected

Create request for operation 'postNotificationEndpointIDLabels'

Parameters

string	$endpoint_id	The notification endpoint 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

◆ postNotificationEndpointIDLabelsWithHttpInfo()

InfluxDB2\Service\NotificationEndpointsService::postNotificationEndpointIDLabelsWithHttpInfo	(	$endpoint_id,
		$label_mapping,
		$zap_trace_span = null )

Operation postNotificationEndpointIDLabelsWithHttpInfo

Add a label to a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint 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)

◆ putNotificationEndpointsID()

InfluxDB2\Service\NotificationEndpointsService::putNotificationEndpointsID	(	$endpoint_id,
		$notification_endpoint,
		$zap_trace_span = null )

Operation putNotificationEndpointsID

Update a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpoint	$notification_endpoint	A new notification endpoint to replace the existing endpoint with (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\NotificationEndpoint|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ putNotificationEndpointsIDRequest()

InfluxDB2\Service\NotificationEndpointsService::putNotificationEndpointsIDRequest	(	$endpoint_id,
		$notification_endpoint,
		$zap_trace_span = null )

protected

Create request for operation 'putNotificationEndpointsID'

Parameters

string	$endpoint_id	The notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpoint	$notification_endpoint	A new notification endpoint to replace the existing endpoint with (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ putNotificationEndpointsIDWithHttpInfo()

InfluxDB2\Service\NotificationEndpointsService::putNotificationEndpointsIDWithHttpInfo	(	$endpoint_id,
		$notification_endpoint,
		$zap_trace_span = null )

Operation putNotificationEndpointsIDWithHttpInfo

Update a notification endpoint

Parameters

string	$endpoint_id	The notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpoint	$notification_endpoint	A new notification endpoint to replace the existing endpoint with (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\NotificationEndpoint|\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/NotificationEndpointsService.php

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createNotificationEndpoint()

◆ createNotificationEndpointRequest()

◆ createNotificationEndpointWithHttpInfo()

◆ deleteNotificationEndpointsID()

◆ deleteNotificationEndpointsIDLabelsID()

◆ deleteNotificationEndpointsIDLabelsIDRequest()

◆ deleteNotificationEndpointsIDLabelsIDWithHttpInfo()

◆ deleteNotificationEndpointsIDRequest()

◆ deleteNotificationEndpointsIDWithHttpInfo()

◆ getNotificationEndpoints()

◆ getNotificationEndpointsID()

◆ getNotificationEndpointsIDLabels()

◆ getNotificationEndpointsIDLabelsRequest()

◆ getNotificationEndpointsIDLabelsWithHttpInfo()

◆ getNotificationEndpointsIDRequest()

◆ getNotificationEndpointsIDWithHttpInfo()

◆ getNotificationEndpointsRequest()

◆ getNotificationEndpointsWithHttpInfo()

◆ patchNotificationEndpointsID()

◆ patchNotificationEndpointsIDRequest()

◆ patchNotificationEndpointsIDWithHttpInfo()

◆ postNotificationEndpointIDLabels()

◆ postNotificationEndpointIDLabelsRequest()

◆ postNotificationEndpointIDLabelsWithHttpInfo()

◆ putNotificationEndpointsID()

◆ putNotificationEndpointsIDRequest()

◆ putNotificationEndpointsIDWithHttpInfo()