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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 createNotificationEndpoint ($notification_endpoint)
 
 createNotificationEndpointWithHttpInfo ($notification_endpoint)
 
 createNotificationEndpointAsync ($notification_endpoint)
 
 createNotificationEndpointAsyncWithHttpInfo ($notification_endpoint)
 
 deleteNotificationEndpointsID ($endpoint_id, $zap_trace_span=null)
 
 deleteNotificationEndpointsIDWithHttpInfo ($endpoint_id, $zap_trace_span=null)
 
 deleteNotificationEndpointsIDAsync ($endpoint_id, $zap_trace_span=null)
 
 deleteNotificationEndpointsIDAsyncWithHttpInfo ($endpoint_id, $zap_trace_span=null)
 
 deleteNotificationEndpointsIDLabelsID ($endpoint_id, $label_id, $zap_trace_span=null)
 
 deleteNotificationEndpointsIDLabelsIDWithHttpInfo ($endpoint_id, $label_id, $zap_trace_span=null)
 
 deleteNotificationEndpointsIDLabelsIDAsync ($endpoint_id, $label_id, $zap_trace_span=null)
 
 deleteNotificationEndpointsIDLabelsIDAsyncWithHttpInfo ($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)
 
 getNotificationEndpointsAsync ($org_id, $zap_trace_span=null, $offset=null, $limit=20)
 
 getNotificationEndpointsAsyncWithHttpInfo ($org_id, $zap_trace_span=null, $offset=null, $limit=20)
 
 getNotificationEndpointsID ($endpoint_id, $zap_trace_span=null)
 
 getNotificationEndpointsIDWithHttpInfo ($endpoint_id, $zap_trace_span=null)
 
 getNotificationEndpointsIDAsync ($endpoint_id, $zap_trace_span=null)
 
 getNotificationEndpointsIDAsyncWithHttpInfo ($endpoint_id, $zap_trace_span=null)
 
 getNotificationEndpointsIDLabels ($endpoint_id, $zap_trace_span=null)
 
 getNotificationEndpointsIDLabelsWithHttpInfo ($endpoint_id, $zap_trace_span=null)
 
 getNotificationEndpointsIDLabelsAsync ($endpoint_id, $zap_trace_span=null)
 
 getNotificationEndpointsIDLabelsAsyncWithHttpInfo ($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)
 
 patchNotificationEndpointsIDAsync ($endpoint_id, $notification_endpoint_update, $zap_trace_span=null)
 
 patchNotificationEndpointsIDAsyncWithHttpInfo ($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)
 
 postNotificationEndpointIDLabelsAsync ($endpoint_id, $label_mapping, $zap_trace_span=null)
 
 postNotificationEndpointIDLabelsAsyncWithHttpInfo ($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)
 
 putNotificationEndpointsIDAsync ($endpoint_id, $notification_endpoint, $zap_trace_span=null)
 
 putNotificationEndpointsIDAsyncWithHttpInfo ($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)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\NotificationEndpointsService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ createNotificationEndpoint()

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

Operation createNotificationEndpoint

Add a notification endpoint

Parameters
\InfluxDB2\Model\NotificationEndpoint$notification_endpointNotification endpoint to create (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ createNotificationEndpointAsync()

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

Operation createNotificationEndpointAsync

Add a notification endpoint

Parameters
\InfluxDB2\Model\NotificationEndpoint$notification_endpointNotification endpoint to create (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ createNotificationEndpointAsyncWithHttpInfo()

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

Operation createNotificationEndpointAsyncWithHttpInfo

Add a notification endpoint

Parameters
\InfluxDB2\Model\NotificationEndpoint$notification_endpointNotification endpoint to create (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ createNotificationEndpointRequest()

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

Create request for operation 'createNotificationEndpoint'

Parameters
\InfluxDB2\Model\NotificationEndpoint$notification_endpointNotification endpoint to create (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ createNotificationEndpointWithHttpInfo()

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

Operation createNotificationEndpointWithHttpInfo

Add a notification endpoint

Parameters
\InfluxDB2\Model\NotificationEndpoint$notification_endpointNotification 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_idThe notification endpoint ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteNotificationEndpointsIDAsync()

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

Operation deleteNotificationEndpointsIDAsync

Delete a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteNotificationEndpointsIDAsyncWithHttpInfo()

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

Operation deleteNotificationEndpointsIDAsyncWithHttpInfo

Delete a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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_idThe notification endpoint 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

◆ deleteNotificationEndpointsIDLabelsIDAsync()

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

Operation deleteNotificationEndpointsIDLabelsIDAsync

Delete a label from a notification endpoint

Parameters
string$endpoint_idThe notification endpoint 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

◆ deleteNotificationEndpointsIDLabelsIDAsyncWithHttpInfo()

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

Operation deleteNotificationEndpointsIDLabelsIDAsyncWithHttpInfo

Delete a label from a notification endpoint

Parameters
string$endpoint_idThe notification endpoint 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

◆ deleteNotificationEndpointsIDLabelsIDRequest()

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

Create request for operation 'deleteNotificationEndpointsIDLabelsID'

Parameters
string$endpoint_idThe notification endpoint 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

◆ 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_idThe notification endpoint 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)

◆ deleteNotificationEndpointsIDRequest()

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

Create request for operation 'deleteNotificationEndpointsID'

Parameters
string$endpoint_idThe notification endpoint ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteNotificationEndpointsIDWithHttpInfo()

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

Operation deleteNotificationEndpointsIDWithHttpInfo

Delete a notification endpoint

Parameters
string$endpoint_idThe notification endpoint 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\NotificationEndpointsService::getConfig ( )
Returns
Configuration

◆ getNotificationEndpoints()

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

Operation getNotificationEndpoints

List all notification endpoints

Parameters
string$org_idOnly show notification endpoints that belong to specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offsetoffset (optional)
int$limitlimit (optional, default to 20)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getNotificationEndpointsAsync()

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

Operation getNotificationEndpointsAsync

List all notification endpoints

Parameters
string$org_idOnly show notification endpoints that belong to specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationEndpointsAsyncWithHttpInfo()

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

Operation getNotificationEndpointsAsyncWithHttpInfo

List all notification endpoints

Parameters
string$org_idOnly show notification endpoints that belong to specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationEndpointsID()

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

Operation getNotificationEndpointsID

Retrieve a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getNotificationEndpointsIDAsync()

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

Operation getNotificationEndpointsIDAsync

Retrieve a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationEndpointsIDAsyncWithHttpInfo()

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

Operation getNotificationEndpointsIDAsyncWithHttpInfo

Retrieve a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationEndpointsIDLabels()

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

Operation getNotificationEndpointsIDLabels

List all labels for a notification endpoint

Parameters
string$endpoint_idThe notification endpoint 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

◆ getNotificationEndpointsIDLabelsAsync()

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

Operation getNotificationEndpointsIDLabelsAsync

List all labels for a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationEndpointsIDLabelsAsyncWithHttpInfo()

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

Operation getNotificationEndpointsIDLabelsAsyncWithHttpInfo

List all labels for a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getNotificationEndpointsIDLabelsRequest()

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

Create request for operation 'getNotificationEndpointsIDLabels'

Parameters
string$endpoint_idThe notification endpoint ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getNotificationEndpointsIDLabelsWithHttpInfo()

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

Operation getNotificationEndpointsIDLabelsWithHttpInfo

List all labels for a notification endpoint

Parameters
string$endpoint_idThe notification endpoint 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)

◆ getNotificationEndpointsIDRequest()

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

Create request for operation 'getNotificationEndpointsID'

Parameters
string$endpoint_idThe notification endpoint ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getNotificationEndpointsIDWithHttpInfo()

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

Operation getNotificationEndpointsIDWithHttpInfo

Retrieve a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
string$zap_trace_spanOpenTracing 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_idOnly show notification endpoints that belong to specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getNotificationEndpointsWithHttpInfo()

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

Operation getNotificationEndpointsWithHttpInfo

List all notification endpoints

Parameters
string$org_idOnly show notification endpoints that belong to specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(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_idThe notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpointUpdate$notification_endpoint_updateCheck update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchNotificationEndpointsIDAsync()

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

Operation patchNotificationEndpointsIDAsync

Update a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpointUpdate$notification_endpoint_updateCheck update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchNotificationEndpointsIDAsyncWithHttpInfo()

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

Operation patchNotificationEndpointsIDAsyncWithHttpInfo

Update a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpointUpdate$notification_endpoint_updateCheck update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchNotificationEndpointsIDRequest()

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

Create request for operation 'patchNotificationEndpointsID'

Parameters
string$endpoint_idThe notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpointUpdate$notification_endpoint_updateCheck update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchNotificationEndpointsIDWithHttpInfo()

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

Operation patchNotificationEndpointsIDWithHttpInfo

Update a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpointUpdate$notification_endpoint_updateCheck 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\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_idThe notification endpoint 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

◆ postNotificationEndpointIDLabelsAsync()

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

Operation postNotificationEndpointIDLabelsAsync

Add a label to a notification endpoint

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postNotificationEndpointIDLabelsAsyncWithHttpInfo()

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

Operation postNotificationEndpointIDLabelsAsyncWithHttpInfo

Add a label to a notification endpoint

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postNotificationEndpointIDLabelsRequest()

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

Create request for operation 'postNotificationEndpointIDLabels'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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_idThe notification endpoint 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)

◆ putNotificationEndpointsID()

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

Operation putNotificationEndpointsID

Update a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpoint$notification_endpointA new notification endpoint to replace the existing endpoint with (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ putNotificationEndpointsIDAsync()

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

Operation putNotificationEndpointsIDAsync

Update a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpoint$notification_endpointA new notification endpoint to replace the existing endpoint with (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ putNotificationEndpointsIDAsyncWithHttpInfo()

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

Operation putNotificationEndpointsIDAsyncWithHttpInfo

Update a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpoint$notification_endpointA new notification endpoint to replace the existing endpoint with (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ putNotificationEndpointsIDRequest()

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

Create request for operation 'putNotificationEndpointsID'

Parameters
string$endpoint_idThe notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpoint$notification_endpointA new notification endpoint to replace the existing endpoint with (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ putNotificationEndpointsIDWithHttpInfo()

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

Operation putNotificationEndpointsIDWithHttpInfo

Update a notification endpoint

Parameters
string$endpoint_idThe notification endpoint ID. (required)
\InfluxDB2\Model\NotificationEndpoint$notification_endpointA new notification endpoint to replace the existing endpoint with (required)
string$zap_trace_spanOpenTracing 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: