Package com.influxdb.client.service

Interface NotificationEndpointsService

public interface NotificationEndpointsService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<NotificationEndpoint>	createNotificationEndpoint(NotificationEndpoint notificationEndpoint)	Add a notification endpoint
retrofit2.Call<Void>	deleteNotificationEndpointsID(String endpointID, String zapTraceSpan)	Delete a notification endpoint
retrofit2.Call<Void>	deleteNotificationEndpointsIDLabelsID(String endpointID, String labelID, String zapTraceSpan)	Delete a label from a notification endpoint
retrofit2.Call<NotificationEndpoints>	getNotificationEndpoints(String orgID, String zapTraceSpan, Integer offset, Integer limit)	List all notification endpoints
retrofit2.Call<NotificationEndpoint>	getNotificationEndpointsID(String endpointID, String zapTraceSpan)	Retrieve a notification endpoint
retrofit2.Call<LabelsResponse>	getNotificationEndpointsIDLabels(String endpointID, String zapTraceSpan)	List all labels for a notification endpoint
retrofit2.Call<NotificationEndpoint>	patchNotificationEndpointsID(String endpointID, NotificationEndpointUpdate notificationEndpointUpdate, String zapTraceSpan)	Update a notification endpoint
retrofit2.Call<LabelResponse>	postNotificationEndpointIDLabels(String endpointID, LabelMapping labelMapping, String zapTraceSpan)	Add a label to a notification endpoint
retrofit2.Call<NotificationEndpoint>	putNotificationEndpointsID(String endpointID, NotificationEndpoint notificationEndpoint, String zapTraceSpan)	Update a notification endpoint

Method Details

createNotificationEndpoint

@Headers("Content-Type:application/json")
@POST("api/v2/notificationEndpoints")
retrofit2.Call<NotificationEndpoint> createNotificationEndpoint(@Body
 NotificationEndpoint notificationEndpoint)

Add a notification endpoint

Parameters:

notificationEndpoint - Notification endpoint to create (required)

Returns:

Call<NotificationEndpoint>

deleteNotificationEndpointsID

@DELETE("api/v2/notificationEndpoints/{endpointID}")
retrofit2.Call<Void> deleteNotificationEndpointsID(@Path("endpointID")
 String endpointID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Delete a notification endpoint

Parameters:

endpointID - The notification endpoint ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteNotificationEndpointsIDLabelsID

@DELETE("api/v2/notificationEndpoints/{endpointID}/labels/{labelID}")
retrofit2.Call<Void> deleteNotificationEndpointsIDLabelsID(@Path("endpointID")
 String endpointID,
 @Path("labelID")
 String labelID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Delete a label from a notification endpoint

Parameters:

endpointID - The notification endpoint ID. (required)

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

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getNotificationEndpoints

@GET("api/v2/notificationEndpoints")
retrofit2.Call<NotificationEndpoints> getNotificationEndpoints(@Query("orgID")
 String orgID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit)

List all notification endpoints

Parameters:

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

zapTraceSpan - OpenTracing span context (optional)

offset - (optional)

limit - (optional, default to 20)

Returns:

Call<NotificationEndpoints>

getNotificationEndpointsID

@GET("api/v2/notificationEndpoints/{endpointID}")
retrofit2.Call<NotificationEndpoint> getNotificationEndpointsID(@Path("endpointID")
 String endpointID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Retrieve a notification endpoint

Parameters:

endpointID - The notification endpoint ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<NotificationEndpoint>

getNotificationEndpointsIDLabels

@GET("api/v2/notificationEndpoints/{endpointID}/labels")
retrofit2.Call<LabelsResponse> getNotificationEndpointsIDLabels(@Path("endpointID")
 String endpointID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all labels for a notification endpoint

Parameters:

endpointID - The notification endpoint ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelsResponse>

patchNotificationEndpointsID

@Headers("Content-Type:application/json")
@PATCH("api/v2/notificationEndpoints/{endpointID}")
retrofit2.Call<NotificationEndpoint> patchNotificationEndpointsID(@Path("endpointID")
 String endpointID,
 @Body
 NotificationEndpointUpdate notificationEndpointUpdate,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update a notification endpoint

Parameters:

endpointID - The notification endpoint ID. (required)

notificationEndpointUpdate - Check update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<NotificationEndpoint>

postNotificationEndpointIDLabels

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

Add a label to a notification endpoint

Parameters:

endpointID - The notification endpoint ID. (required)

labelMapping - Label to add (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelResponse>

putNotificationEndpointsID

@Headers("Content-Type:application/json")
@PUT("api/v2/notificationEndpoints/{endpointID}")
retrofit2.Call<NotificationEndpoint> putNotificationEndpointsID(@Path("endpointID")
 String endpointID,
 @Body
 NotificationEndpoint notificationEndpoint,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update a notification endpoint

Parameters:

endpointID - The notification endpoint ID. (required)

notificationEndpoint - A new notification endpoint to replace the existing endpoint with (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<NotificationEndpoint>