com.influxdb.client

Interface NotificationEndpointsApi

@ThreadSafe
public interface NotificationEndpointsApi

The client of the InfluxDB 2.x that implement NotificationEndpoint HTTP API.

Author:

Jakub Bednar (11/09/2019 09:20)

Method Summary

Modifier and Type	Method and Description
LabelResponse	addLabel(Label label, NotificationEndpoint endpoint) Add a label to a notification endpoint.
LabelResponse	addLabel(String labelID, String endpointID) Add a label to a notification endpoint.
HTTPNotificationEndpoint	cloneHTTPEndpoint(String name, HTTPNotificationEndpoint endpoint) Clone a Http Notification endpoint without authentication.
HTTPNotificationEndpoint	cloneHTTPEndpoint(String name, String endpointID) Clone a Http Notification endpoint without authentication.
HTTPNotificationEndpoint	cloneHTTPEndpointBasicAuth(String name, String username, String password, HTTPNotificationEndpoint endpoint) Clone a Http Notification endpoint with Http Basic authentication.
HTTPNotificationEndpoint	cloneHTTPEndpointBasicAuth(String name, String username, String password, String endpointID) Clone a Http Notification endpoint with Http Basic authentication.
HTTPNotificationEndpoint	cloneHTTPEndpointBearer(String name, String token, HTTPNotificationEndpoint endpoint) Clone a Http Notification endpoint with Bearer authentication.
HTTPNotificationEndpoint	cloneHTTPEndpointBearer(String name, String token, String endpointID) Clone a Http Notification endpoint with Bearer authentication.
PagerDutyNotificationEndpoint	clonePagerDutyEndpoint(String name, String routingKey, PagerDutyNotificationEndpoint endpoint) Clone a PagerDuty Notification endpoint.
PagerDutyNotificationEndpoint	clonePagerDutyEndpoint(String name, String routingKey, String endpointID) Clone a PagerDuty Notification endpoint.
SlackNotificationEndpoint	cloneSlackEndpoint(String name, String token, SlackNotificationEndpoint endpoint) Clone a Slack Notification endpoint.
SlackNotificationEndpoint	cloneSlackEndpoint(String name, String token, String endpointID) Clone a Slack Notification endpoint.
NotificationEndpoint	createEndpoint(NotificationEndpoint notificationEndpoint) Add new notification endpoint.
HTTPNotificationEndpoint	createHTTPEndpoint(String name, String url, HTTPNotificationEndpoint.MethodEnum method, String orgID) Add new HTTP notification endpoint without authentication.
HTTPNotificationEndpoint	createHTTPEndpointBasicAuth(String name, String url, HTTPNotificationEndpoint.MethodEnum method, String username, String password, String orgID) Add new HTTP notification endpoint with Http Basic authentication.
HTTPNotificationEndpoint	createHTTPEndpointBearer(String name, String url, HTTPNotificationEndpoint.MethodEnum method, String token, String orgID) Add new HTTP notification endpoint with Bearer authentication.
PagerDutyNotificationEndpoint	createPagerDutyEndpoint(String name, String clientURL, String routingKey, String orgID) Add new PagerDuty notification endpoint.
SlackNotificationEndpoint	createSlackEndpoint(String name, String url, String orgID) Add new Slack notification endpoint.
SlackNotificationEndpoint	createSlackEndpoint(String name, String url, String token, String orgID) Add new Slack notification endpoint.
void	deleteLabel(Label label, NotificationEndpoint endpoint) Delete label from a notification endpoint.
void	deleteLabel(String labelID, String endpointID) Delete label from a notification endpoint.
void	deleteNotificationEndpoint(NotificationEndpoint notificationEndpoint) Delete a notification endpoint.
void	deleteNotificationEndpoint(String endpointID) Delete a notification endpoint.
NotificationEndpoint	findNotificationEndpointByID(String endpointID) Get a notification endpoint.
List<NotificationEndpoint>	findNotificationEndpoints(String orgID) Get notification endpoints.
NotificationEndpoints	findNotificationEndpoints(String orgID, FindOptions findOptions) Get all notification endpoints.
List<Label>	getLabels(NotificationEndpoint endpoint) List all labels for a notification endpoint.
List<Label>	getLabels(String endpointID) List all labels for a notification endpoint.
NotificationEndpoint	updateEndpoint(NotificationEndpoint notificationEndpoint) Update a notification endpoint.
NotificationEndpoint	updateEndpoint(String endpointID, NotificationEndpointUpdate notificationEndpointUpdate) Update a notification endpoint.

Method Detail

createSlackEndpoint

@Nonnull
SlackNotificationEndpoint createSlackEndpoint(@Nonnull
                                                       String name,
                                                       @Nonnull
                                                       String url,
                                                       @Nonnull
                                                       String orgID)

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

Parameters:

name - Endpoint name

url - Slack WebHook URL

orgID - Owner of an endpoint

Returns:

created Slack notification endpoint

createSlackEndpoint

@Nonnull
SlackNotificationEndpoint createSlackEndpoint(@Nonnull
                                                       String name,
                                                       @Nonnull
                                                       String url,
                                                       @Nullable
                                                       String token,
                                                       @Nonnull
                                                       String orgID)

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

Parameters:

name - Endpoint name

url - Slack WebHook URL

token - Slack WebHook Token

orgID - Owner of an endpoint

Returns:

created Slack notification endpoint

createPagerDutyEndpoint

@Nonnull
PagerDutyNotificationEndpoint createPagerDutyEndpoint(@Nonnull
                                                               String name,
                                                               @Nonnull
                                                               String clientURL,
                                                               @Nonnull
                                                               String routingKey,
                                                               @Nonnull
                                                               String orgID)

Add new PagerDuty notification endpoint.

Parameters:

name - Endpoint name

clientURL - Client URL

routingKey - Routing Key

orgID - Owner of an endpoint

Returns:

created PagerDuty notification endpoint

createHTTPEndpoint

@Nonnull
HTTPNotificationEndpoint createHTTPEndpoint(@Nonnull
                                                     String name,
                                                     @Nonnull
                                                     String url,
                                                     @Nonnull
                                                     HTTPNotificationEndpoint.MethodEnum method,
                                                     @Nonnull
                                                     String orgID)

Add new HTTP notification endpoint without authentication.

Parameters:

name - Endpoint name

url - URL

method - HTTP Method

orgID - Owner of an endpoint

Returns:

created HTTP notification endpoint

createHTTPEndpointBasicAuth

@Nonnull
HTTPNotificationEndpoint createHTTPEndpointBasicAuth(@Nonnull
                                                              String name,
                                                              @Nonnull
                                                              String url,
                                                              @Nonnull
                                                              HTTPNotificationEndpoint.MethodEnum method,
                                                              @Nonnull
                                                              String username,
                                                              @Nonnull
                                                              String password,
                                                              @Nonnull
                                                              String orgID)

Add new HTTP notification endpoint with Http Basic authentication.

Parameters:

name - Endpoint name

url - URL

method - HTTP Method

username - HTTP Basic Username

password - HTTP Basic Password

orgID - Owner of an endpoint

Returns:

created HTTP notification endpoint

createHTTPEndpointBearer

@Nonnull
HTTPNotificationEndpoint createHTTPEndpointBearer(@Nonnull
                                                           String name,
                                                           @Nonnull
                                                           String url,
                                                           @Nonnull
                                                           HTTPNotificationEndpoint.MethodEnum method,
                                                           @Nonnull
                                                           String token,
                                                           @Nonnull
                                                           String orgID)

Add new HTTP notification endpoint with Bearer authentication.

Parameters:

name - Endpoint name

url - URL

method - HTTP Method

token - Bearer token

orgID - Owner of an endpoint

Returns:

created HTTP notification endpoint

createEndpoint

@Nonnull
NotificationEndpoint createEndpoint(@Nonnull
                                             NotificationEndpoint notificationEndpoint)

Add new notification endpoint.

Parameters:

notificationEndpoint - notificationEndpoint to create

Returns:

Notification endpoint created

updateEndpoint

@Nonnull
NotificationEndpoint updateEndpoint(@Nonnull
                                             NotificationEndpoint notificationEndpoint)

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

Parameters:

notificationEndpoint - update to apply

Returns:

An updated notification endpoint

updateEndpoint

@Nonnull
NotificationEndpoint updateEndpoint(@Nonnull
                                             String endpointID,
                                             @Nonnull
                                             NotificationEndpointUpdate notificationEndpointUpdate)

Update a notification endpoint.

Parameters:

endpointID - ID of notification endpoint

notificationEndpointUpdate - update to apply

Returns:

An updated notification endpoint

deleteNotificationEndpoint

void deleteNotificationEndpoint(@Nonnull
                                NotificationEndpoint notificationEndpoint)

Delete a notification endpoint.

Parameters:

notificationEndpoint - notification endpoint

deleteNotificationEndpoint

void deleteNotificationEndpoint(@Nonnull
                                String endpointID)

Delete a notification endpoint.

Parameters:

endpointID - ID of notification endpoint

findNotificationEndpoints

@Nonnull
List<NotificationEndpoint> findNotificationEndpoints(@Nonnull
                                                              String orgID)

Get notification endpoints.

Parameters:

orgID - only show notification endpoints belonging to specified organization

Returns:

A list of notification endpoint

findNotificationEndpoints

@Nonnull
NotificationEndpoints findNotificationEndpoints(@Nonnull
                                                         String orgID,
                                                         @Nonnull
                                                         FindOptions findOptions)

Get all notification endpoints.

Parameters:

orgID - only show notification endpoints belonging to specified organization

findOptions - the find options

Returns:

A list of notification endpoint

cloneSlackEndpoint

@Nonnull
SlackNotificationEndpoint cloneSlackEndpoint(@Nonnull
                                                      String name,
                                                      @Nullable
                                                      String token,
                                                      @Nonnull
                                                      String endpointID)

Clone a Slack Notification endpoint.

Parameters:

name - name of cloned endpoint

token - Slack WebHook Token

endpointID - ID of endpoint to clone

Returns:

Notification endpoint cloned

cloneSlackEndpoint

@Nonnull
SlackNotificationEndpoint cloneSlackEndpoint(@Nonnull
                                                      String name,
                                                      @Nullable
                                                      String token,
                                                      @Nonnull
                                                      SlackNotificationEndpoint endpoint)

Clone a Slack Notification endpoint.

Parameters:

name - name of cloned endpoint

token - Slack WebHook Token

endpoint - endpoint to clone

Returns:

Notification endpoint cloned

clonePagerDutyEndpoint

@Nonnull
PagerDutyNotificationEndpoint clonePagerDutyEndpoint(@Nonnull
                                                              String name,
                                                              @Nonnull
                                                              String routingKey,
                                                              @Nonnull
                                                              String endpointID)

Clone a PagerDuty Notification endpoint.

Parameters:

name - name of cloned endpoint

routingKey - Routing Key

endpointID - ID of endpoint to clone

Returns:

Notification endpoint cloned

clonePagerDutyEndpoint

@Nonnull
PagerDutyNotificationEndpoint clonePagerDutyEndpoint(@Nonnull
                                                              String name,
                                                              @Nonnull
                                                              String routingKey,
                                                              @Nonnull
                                                              PagerDutyNotificationEndpoint endpoint)

Clone a PagerDuty Notification endpoint.

Parameters:

name - name of cloned endpoint

routingKey - Routing Key

endpoint - endpoint to clone

Returns:

Notification endpoint cloned

cloneHTTPEndpoint

@Nonnull
HTTPNotificationEndpoint cloneHTTPEndpoint(@Nonnull
                                                    String name,
                                                    @Nonnull
                                                    String endpointID)

Clone a Http Notification endpoint without authentication.

Parameters:

name - name of cloned endpoint

endpointID - ID of endpoint to clone

Returns:

Notification endpoint cloned

cloneHTTPEndpoint

@Nonnull
HTTPNotificationEndpoint cloneHTTPEndpoint(@Nonnull
                                                    String name,
                                                    @Nonnull
                                                    HTTPNotificationEndpoint endpoint)

Clone a Http Notification endpoint without authentication.

Parameters:

name - name of cloned endpoint

endpoint - endpoint to clone

Returns:

Notification endpoint cloned

cloneHTTPEndpointBasicAuth

@Nonnull
HTTPNotificationEndpoint cloneHTTPEndpointBasicAuth(@Nonnull
                                                             String name,
                                                             @Nonnull
                                                             String username,
                                                             @Nonnull
                                                             String password,
                                                             @Nonnull
                                                             String endpointID)

Clone a Http Notification endpoint with Http Basic authentication.

Parameters:

name - name of cloned endpoint

username - HTTP Basic Username

password - HTTP Basic Password

endpointID - ID of endpoint to clone

Returns:

Notification endpoint cloned

cloneHTTPEndpointBasicAuth

@Nonnull
HTTPNotificationEndpoint cloneHTTPEndpointBasicAuth(@Nonnull
                                                             String name,
                                                             @Nonnull
                                                             String username,
                                                             @Nonnull
                                                             String password,
                                                             @Nonnull
                                                             HTTPNotificationEndpoint endpoint)

Clone a Http Notification endpoint with Http Basic authentication.

Parameters:

name - name of cloned endpoint

username - HTTP Basic Username

password - HTTP Basic Password

endpoint - endpoint to clone

Returns:

Notification endpoint cloned

cloneHTTPEndpointBearer

@Nonnull
HTTPNotificationEndpoint cloneHTTPEndpointBearer(@Nonnull
                                                          String name,
                                                          @Nonnull
                                                          String token,
                                                          @Nonnull
                                                          String endpointID)

Clone a Http Notification endpoint with Bearer authentication.

Parameters:

name - name of cloned endpoint

token - Bearer token

endpointID - ID of endpoint to clone

Returns:

Notification endpoint cloned

cloneHTTPEndpointBearer

@Nonnull
HTTPNotificationEndpoint cloneHTTPEndpointBearer(@Nonnull
                                                          String name,
                                                          @Nonnull
                                                          String token,
                                                          @Nonnull
                                                          HTTPNotificationEndpoint endpoint)

Clone a Http Notification endpoint with Bearer authentication.

Parameters:

name - name of cloned endpoint

token - Bearer token

endpoint - endpoint to clone

Returns:

Notification endpoint cloned

findNotificationEndpointByID

@Nonnull
NotificationEndpoint findNotificationEndpointByID(@Nonnull
                                                           String endpointID)

Get a notification endpoint.

Parameters:

endpointID - ID of notification endpoint

Returns:

the notification endpoint requested

getLabels

@Nonnull
List<Label> getLabels(@Nonnull
                               NotificationEndpoint endpoint)

List all labels for a notification endpoint.

Parameters:

endpoint - the notification endpoint

Returns:

a list of all labels for a notification endpoint

getLabels

@Nonnull
List<Label> getLabels(@Nonnull
                               String endpointID)

List all labels for a notification endpoint.

Parameters:

endpointID - ID of the notification endpoint

Returns:

a list of all labels for a notification endpoint

addLabel

@Nonnull
LabelResponse addLabel(@Nonnull
                                Label label,
                                @Nonnull
                                NotificationEndpoint endpoint)

Add a label to a notification endpoint.

Parameters:

label - label to add

endpoint - the notification endpoint

Returns:

the label was added to the notification endpoint

addLabel

@Nonnull
LabelResponse addLabel(@Nonnull
                                String labelID,
                                @Nonnull
                                String endpointID)

Add a label to a notification endpoint.

Parameters:

endpointID - the ID of the notification endpoint

labelID - the ID of label to add

Returns:

the label was added to the notification endpoint

deleteLabel

void deleteLabel(@Nonnull
                 Label label,
                 @Nonnull
                 NotificationEndpoint endpoint)

Delete label from a notification endpoint.

Parameters:

label - the label to delete

endpoint - the notification endpoint

deleteLabel

void deleteLabel(@Nonnull
                 String labelID,
                 @Nonnull
                 String endpointID)

Delete label from a notification endpoint.

Parameters:

endpointID - ID of the notification endpoint

labelID - the label id to delete