com.influxdb.client.service

Interface NotificationRulesService

public interface NotificationRulesService

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<NotificationRule>	createNotificationRule(PostNotificationRule postNotificationRule) Add a notification rule
retrofit2.Call<Void>	deleteNotificationRulesID(String ruleID, String zapTraceSpan) Delete a notification rule
retrofit2.Call<Void>	deleteNotificationRulesIDLabelsID(String ruleID, String labelID, String zapTraceSpan) Delete label from a notification rule
retrofit2.Call<NotificationRules>	getNotificationRules(String orgID, String zapTraceSpan, Integer offset, Integer limit, String checkID, String tag) Get all notification rules
retrofit2.Call<NotificationRule>	getNotificationRulesID(String ruleID, String zapTraceSpan) Get a notification rule
retrofit2.Call<LabelsResponse>	getNotificationRulesIDLabels(String ruleID, String zapTraceSpan) List all labels for a notification rule
retrofit2.Call<NotificationRule>	patchNotificationRulesID(String ruleID, NotificationRuleUpdate notificationRuleUpdate, String zapTraceSpan) Update a notification rule
retrofit2.Call<LabelResponse>	postNotificationRuleIDLabels(String ruleID, LabelMapping labelMapping, String zapTraceSpan) Add a label to a notification rule
retrofit2.Call<NotificationRule>	putNotificationRulesID(String ruleID, NotificationRule notificationRule, String zapTraceSpan) Update a notification rule

Method Detail

createNotificationRule

@Headers(value="Content-Type:application/json")
 @POST(value="api/v2/notificationRules")
retrofit2.Call<NotificationRule> createNotificationRule(@Body
                                                                                                                                                 PostNotificationRule postNotificationRule)

Add a notification rule

Parameters:

postNotificationRule - Notification rule to create (required)

Returns:

Call<NotificationRule>

deleteNotificationRulesID

@DELETE(value="api/v2/notificationRules/{ruleID}")
retrofit2.Call<Void> deleteNotificationRulesID(@Path(value="ruleID")
                                                                                                  String ruleID,
                                                                                                  @Header(value="Zap-Trace-Span")
                                                                                                  String zapTraceSpan)

Delete a notification rule

Parameters:

ruleID - The notification rule ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteNotificationRulesIDLabelsID

@DELETE(value="api/v2/notificationRules/{ruleID}/labels/{labelID}")
retrofit2.Call<Void> deleteNotificationRulesIDLabelsID(@Path(value="ruleID")
                                                                                                                           String ruleID,
                                                                                                                           @Path(value="labelID")
                                                                                                                           String labelID,
                                                                                                                           @Header(value="Zap-Trace-Span")
                                                                                                                           String zapTraceSpan)

Delete label from a notification rule

Parameters:

ruleID - The notification rule ID. (required)

labelID - The ID of the label to delete. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getNotificationRules

@GET(value="api/v2/notificationRules")
retrofit2.Call<NotificationRules> getNotificationRules(@Query(value="orgID")
                                                                                              String orgID,
                                                                                              @Header(value="Zap-Trace-Span")
                                                                                              String zapTraceSpan,
                                                                                              @Query(value="offset")
                                                                                              Integer offset,
                                                                                              @Query(value="limit")
                                                                                              Integer limit,
                                                                                              @Query(value="checkID")
                                                                                              String checkID,
                                                                                              @Query(value="tag")
                                                                                              String tag)

Get all notification rules

Parameters:

orgID - Only show notification rules that belong to a specific organization ID. (required)

zapTraceSpan - OpenTracing span context (optional)

offset - (optional)

limit - (optional, default to 20)

checkID - Only show notifications that belong to the specific check ID. (optional)

tag - Only return notification rules that \"would match\" statuses which contain the tag key value pairs provided. (optional)

Returns:

Call<NotificationRules>

getNotificationRulesID

@GET(value="api/v2/notificationRules/{ruleID}")
retrofit2.Call<NotificationRule> getNotificationRulesID(@Path(value="ruleID")
                                                                                                        String ruleID,
                                                                                                        @Header(value="Zap-Trace-Span")
                                                                                                        String zapTraceSpan)

Get a notification rule

Parameters:

ruleID - The notification rule ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<NotificationRule>

getNotificationRulesIDLabels

@GET(value="api/v2/notificationRules/{ruleID}/labels")
retrofit2.Call<LabelsResponse> getNotificationRulesIDLabels(@Path(value="ruleID")
                                                                                                                   String ruleID,
                                                                                                                   @Header(value="Zap-Trace-Span")
                                                                                                                   String zapTraceSpan)

List all labels for a notification rule

Parameters:

ruleID - The notification rule ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelsResponse>

patchNotificationRulesID

@Headers(value="Content-Type:application/json")
 @PATCH(value="api/v2/notificationRules/{ruleID}")
retrofit2.Call<NotificationRule> patchNotificationRulesID(@Path(value="ruleID")
                                                                                                                                                             String ruleID,
                                                                                                                                                             @Body
                                                                                                                                                             NotificationRuleUpdate notificationRuleUpdate,
                                                                                                                                                             @Header(value="Zap-Trace-Span")
                                                                                                                                                             String zapTraceSpan)

Update a notification rule

Parameters:

ruleID - The notification rule ID. (required)

notificationRuleUpdate - Notification rule update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<NotificationRule>

postNotificationRuleIDLabels

@Headers(value="Content-Type:application/json")
 @POST(value="api/v2/notificationRules/{ruleID}/labels")
retrofit2.Call<LabelResponse> postNotificationRuleIDLabels(@Path(value="ruleID")
                                                                                                                                                                    String ruleID,
                                                                                                                                                                    @Body
                                                                                                                                                                    LabelMapping labelMapping,
                                                                                                                                                                    @Header(value="Zap-Trace-Span")
                                                                                                                                                                    String zapTraceSpan)

Add a label to a notification rule

Parameters:

ruleID - The notification rule ID. (required)

labelMapping - Label to add (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelResponse>

putNotificationRulesID

@Headers(value="Content-Type:application/json")
 @PUT(value="api/v2/notificationRules/{ruleID}")
retrofit2.Call<NotificationRule> putNotificationRulesID(@Path(value="ruleID")
                                                                                                                                                         String ruleID,
                                                                                                                                                         @Body
                                                                                                                                                         NotificationRule notificationRule,
                                                                                                                                                         @Header(value="Zap-Trace-Span")
                                                                                                                                                         String zapTraceSpan)

Update a notification rule

Parameters:

ruleID - The notification rule ID. (required)

notificationRule - Notification rule update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<NotificationRule>