Interface INotificationEndpointsApi

Namespace: InfluxDB.Client

Assembly: InfluxDB.Client.dll

Syntax

public interface INotificationEndpointsApi

Methods

AddLabelAsync(Label, NotificationEndpoint, CancellationToken)

Add a label to a notification endpoint.

Declaration

Task<Label> AddLabelAsync(Label label, NotificationEndpoint endpoint, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Label	label	label to add
NotificationEndpoint	endpoint	the notification endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Label>

AddLabelAsync(String, String, CancellationToken)

Add a label to a notification endpoint.

Declaration

Task<Label> AddLabelAsync(string labelId, string endpointId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	labelId	the ID of label to add
System.String	endpointId	the ID of the notification endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Label>

CloneHttpEndpoint(String, HTTPNotificationEndpoint, CancellationToken)

Clone a Http Notification endpoint without authentication.

Declaration

Task<HTTPNotificationEndpoint> CloneHttpEndpoint(string name, HTTPNotificationEndpoint endpoint, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	name of cloned endpoint
HTTPNotificationEndpoint	endpoint	endpoint to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<HTTPNotificationEndpoint>	Notification endpoint cloned

CloneHttpEndpointAsync(String, String, CancellationToken)

Clone a Http Notification endpoint without authentication.

Declaration

Task<HTTPNotificationEndpoint> CloneHttpEndpointAsync(string name, string endpointId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	name of cloned endpoint
System.String	endpointId	ID of endpoint to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<HTTPNotificationEndpoint>	Notification endpoint cloned

CloneHttpEndpointBasicAuthAsync(String, String, String, HTTPNotificationEndpoint, CancellationToken)

Clone a Http Notification endpoint with Http Basic authentication.

Declaration

Task<HTTPNotificationEndpoint> CloneHttpEndpointBasicAuthAsync(string name, string username, string password, HTTPNotificationEndpoint endpoint, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	name of cloned endpoint
System.String	username	HTTP Basic Username
System.String	password	HTTP Basic Password
HTTPNotificationEndpoint	endpoint	endpoint to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<HTTPNotificationEndpoint>	Notification endpoint cloned

CloneHttpEndpointBasicAuthAsync(String, String, String, String, CancellationToken)

Clone a Http Notification endpoint with Http Basic authentication.

Declaration

Task<HTTPNotificationEndpoint> CloneHttpEndpointBasicAuthAsync(string name, string username, string password, string endpointId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	name of cloned endpoint
System.String	username	HTTP Basic Username
System.String	password	HTTP Basic Password
System.String	endpointId	ID of endpoint to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<HTTPNotificationEndpoint>	Notification endpoint cloned

CloneHttpEndpointBearerAsync(String, String, HTTPNotificationEndpoint, CancellationToken)

Clone a Http Notification endpoint with Bearer authentication.

Declaration

Task<HTTPNotificationEndpoint> CloneHttpEndpointBearerAsync(string name, string token, HTTPNotificationEndpoint endpoint, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	name of cloned endpoint
System.String	token	Bearer token
HTTPNotificationEndpoint	endpoint	endpoint to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<HTTPNotificationEndpoint>	Notification endpoint cloned

CloneHttpEndpointBearerAsync(String, String, String, CancellationToken)

Clone a Http Notification endpoint with Bearer authentication.

Declaration

Task<HTTPNotificationEndpoint> CloneHttpEndpointBearerAsync(string name, string token, string endpointId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	name of cloned endpoint
System.String	token	Bearer token
System.String	endpointId	ID of endpoint to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<HTTPNotificationEndpoint>	Notification endpoint cloned

ClonePagerDutyEndpointAsync(String, String, PagerDutyNotificationEndpoint, CancellationToken)

Clone a PagerDuty Notification endpoint.

Declaration

Task<PagerDutyNotificationEndpoint> ClonePagerDutyEndpointAsync(string name, string routingKey, PagerDutyNotificationEndpoint endpoint, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	name of cloned endpoint
System.String	routingKey	Routing Key
PagerDutyNotificationEndpoint	endpoint	endpoint to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<PagerDutyNotificationEndpoint>	Notification endpoint cloned

ClonePagerDutyEndpointAsync(String, String, String, CancellationToken)

Clone a PagerDuty Notification endpoint.

Declaration

Task<PagerDutyNotificationEndpoint> ClonePagerDutyEndpointAsync(string name, string routingKey, string endpointId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	name of cloned endpoint
System.String	routingKey	Routing Key
System.String	endpointId	ID of endpoint to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<PagerDutyNotificationEndpoint>	Notification endpoint cloned

CloneSlackEndpointAsync(String, String, SlackNotificationEndpoint, CancellationToken)

Clone a Slack Notification endpoint.

Declaration

Task<SlackNotificationEndpoint> CloneSlackEndpointAsync(string name, string token, SlackNotificationEndpoint endpoint, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	name of cloned endpoint
System.String	token
SlackNotificationEndpoint	endpoint	endpoint to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<SlackNotificationEndpoint>	Notification endpoint cloned

CloneSlackEndpointAsync(String, String, String, CancellationToken)

Clone a Slack Notification endpoint.

Declaration

Task<SlackNotificationEndpoint> CloneSlackEndpointAsync(string name, string token, string endpointId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	name of cloned endpoint
System.String	token	Slack WebHook Token
System.String	endpointId	ID of endpoint to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<SlackNotificationEndpoint>	Notification endpoint cloned

CreateEndpointAsync(NotificationEndpoint, CancellationToken)

Add new notification endpoint.

Declaration

Task<NotificationEndpoint> CreateEndpointAsync(NotificationEndpoint notificationEndpoint, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
NotificationEndpoint	notificationEndpoint	notificationEndpoint to create
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<NotificationEndpoint>	Notification endpoint created

CreateHttpEndpointAsync(String, String, HTTPNotificationEndpoint.MethodEnum, String, CancellationToken)

Add new HTTP notification endpoint without authentication.

Declaration

Task<HTTPNotificationEndpoint> CreateHttpEndpointAsync(string name, string url, HTTPNotificationEndpoint.MethodEnum method, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	Endpoint name
System.String	url	URL
HTTPNotificationEndpoint.MethodEnum	method	HTTP Method
System.String	orgId	Owner of an endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<HTTPNotificationEndpoint>	created HTTP notification endpoint

CreateHttpEndpointBasicAuthAsync(String, String, HTTPNotificationEndpoint.MethodEnum, String, String, String, CancellationToken)

Declaration

Task<HTTPNotificationEndpoint> CreateHttpEndpointBasicAuthAsync(string name, string url, HTTPNotificationEndpoint.MethodEnum method, string username, string password, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	Endpoint name
System.String	url	URL
HTTPNotificationEndpoint.MethodEnum	method	HTTP Method
System.String	username	HTTP Basic Username
System.String	password	HTTP Basic Password
System.String	orgId	Owner of an endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<HTTPNotificationEndpoint>	created HTTP notification endpoint

CreateHttpEndpointBearerAsync(String, String, HTTPNotificationEndpoint.MethodEnum, String, String, CancellationToken)

Declaration

Task<HTTPNotificationEndpoint> CreateHttpEndpointBearerAsync(string name, string url, HTTPNotificationEndpoint.MethodEnum method, string token, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	Endpoint name
System.String	url	URL
HTTPNotificationEndpoint.MethodEnum	method	HTTP Method
System.String	token	Bearer token
System.String	orgId	Owner of an endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<HTTPNotificationEndpoint>	created HTTP notification endpoint

CreatePagerDutyEndpointAsync(String, String, String, String, CancellationToken)

Add new PagerDuty notification endpoint.

Declaration

Task<PagerDutyNotificationEndpoint> CreatePagerDutyEndpointAsync(string name, string clientUrl, string routingKey, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	Endpoint name
System.String	clientUrl	Client URL
System.String	routingKey	Routing Key
System.String	orgId	Owner of an endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<PagerDutyNotificationEndpoint>	created PagerDuty notification endpoint

CreateSlackEndpointAsync(String, String, String, CancellationToken)

Add new Slack notification endpoint. The 'url' should be defined.

Declaration

Task<SlackNotificationEndpoint> CreateSlackEndpointAsync(string name, string url, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	Endpoint name
System.String	url	Slack WebHook URL
System.String	orgId	Owner of an endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<SlackNotificationEndpoint>	created Slack notification endpoint

CreateSlackEndpointAsync(String, String, String, String, CancellationToken)

Add new Slack notification endpoint. The 'url' should be defined.

Declaration

Task<SlackNotificationEndpoint> CreateSlackEndpointAsync(string name, string url, string token, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	Endpoint name
System.String	url	Slack WebHook URL
System.String	token	Slack WebHook Token
System.String	orgId	Owner of an endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<SlackNotificationEndpoint>	created Slack notification endpoint

DeleteLabelAsync(Label, NotificationEndpoint, CancellationToken)

Delete label from a notification endpoint.

Declaration

Task DeleteLabelAsync(Label label, NotificationEndpoint endpoint, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Label	label	the label to delete
NotificationEndpoint	endpoint	the notification endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task

DeleteLabelAsync(String, String, CancellationToken)

Delete label from a notification endpoint.

Declaration

Task DeleteLabelAsync(string labelId, string endpointId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	labelId	the label id to delete
System.String	endpointId	ID of the notification endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task

DeleteNotificationEndpointAsync(NotificationEndpoint, CancellationToken)

Delete a notification endpoint.

Declaration

Task DeleteNotificationEndpointAsync(NotificationEndpoint notificationEndpoint, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
NotificationEndpoint	notificationEndpoint	notification endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	delete has been accepted>

DeleteNotificationEndpointAsync(String, CancellationToken)

Delete a notification endpoint.

Declaration

Task DeleteNotificationEndpointAsync(string endpointId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	endpointId	ID of notification endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	delete has been accepted

FindNotificationEndpointByIdAsync(String, CancellationToken)

Get a notification endpoint.

Declaration

Task<NotificationEndpoint> FindNotificationEndpointByIdAsync(string endpointId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	endpointId	ID of notification endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<NotificationEndpoint>	the notification endpoint requested

FindNotificationEndpointsAsync(String, CancellationToken)

Get notification endpoints.

Declaration

Task<List<NotificationEndpoint>> FindNotificationEndpointsAsync(string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgId	only show notification endpoints belonging to specified organization
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<NotificationEndpoint>>	A list of notification endpoint

FindNotificationEndpointsAsync(String, FindOptions, CancellationToken)

Get all notification endpoints.

Declaration

Task<NotificationEndpoints> FindNotificationEndpointsAsync(string orgId, FindOptions findOptions, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgId	only show notification endpoints belonging to specified organization
FindOptions	findOptions	the find options
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<NotificationEndpoints>

GetLabelsAsync(NotificationEndpoint, CancellationToken)

List all labels for a notification endpoint.

Declaration

Task<List<Label>> GetLabelsAsync(NotificationEndpoint endpoint, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
NotificationEndpoint	endpoint	the notification endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<Label>>	a list of all labels for a notification endpoint

GetLabelsAsync(String, CancellationToken)

List all labels for a notification endpoint.

Declaration

Task<List<Label>> GetLabelsAsync(string endpointId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	endpointId	ID of the notification endpoint
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<Label>>	a list of all labels for a notification endpoint

UpdateEndpointAsync(NotificationEndpoint, CancellationToken)

Update a notification endpoint. The updates is used for fields from NotificationEndpointUpdate.

Declaration

Task<NotificationEndpoint> UpdateEndpointAsync(NotificationEndpoint notificationEndpoint, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
NotificationEndpoint	notificationEndpoint	update to apply
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<NotificationEndpoint>	An updated notification endpoint

UpdateEndpointAsync(String, NotificationEndpointUpdate, CancellationToken)

Update a notification endpoint.

Declaration

Task<NotificationEndpoint> UpdateEndpointAsync(string endpointId, NotificationEndpointUpdate notificationEndpointUpdate, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	endpointId	ID of notification endpoint
NotificationEndpointUpdate	notificationEndpointUpdate	update to apply
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<NotificationEndpoint>	An updated notification endpoint