public interface NotificationEndpointsService
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<NotificationEndpoint> |
createNotificationEndpoint(PostNotificationEndpoint postNotificationEndpoint)
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)
Get all notification endpoints
|
retrofit2.Call<NotificationEndpoint> |
getNotificationEndpointsID(String endpointID,
String zapTraceSpan)
Get 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
|
@Headers(value="Content-Type:application/json") @POST(value="api/v2/notificationEndpoints") retrofit2.Call<NotificationEndpoint> createNotificationEndpoint(@Body PostNotificationEndpoint postNotificationEndpoint)
postNotificationEndpoint - Notification endpoint to create (required)@DELETE(value="api/v2/notificationEndpoints/{endpointID}")
retrofit2.Call<Void> deleteNotificationEndpointsID(@Path(value="endpointID")
String endpointID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
endpointID - The notification endpoint ID. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/notificationEndpoints/{endpointID}/labels/{labelID}")
retrofit2.Call<Void> deleteNotificationEndpointsIDLabelsID(@Path(value="endpointID")
String endpointID,
@Path(value="labelID")
String labelID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
endpointID - The notification endpoint ID. (required)labelID - The ID of the label to delete. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/notificationEndpoints") retrofit2.Call<NotificationEndpoints> getNotificationEndpoints(@Query(value="orgID") String orgID, @Header(value="Zap-Trace-Span") String zapTraceSpan, @Query(value="offset") Integer offset, @Query(value="limit") Integer limit)
orgID - Only show notification endpoints that belong to specific organization ID. (required)zapTraceSpan - OpenTracing span context (optional)offset - (optional)limit - (optional, default to 20)@GET(value="api/v2/notificationEndpoints/{endpointID}")
retrofit2.Call<NotificationEndpoint> getNotificationEndpointsID(@Path(value="endpointID")
String endpointID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
endpointID - The notification endpoint ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/notificationEndpoints/{endpointID}/labels")
retrofit2.Call<LabelsResponse> getNotificationEndpointsIDLabels(@Path(value="endpointID")
String endpointID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
endpointID - The notification endpoint ID. (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@PATCH(value="api/v2/notificationEndpoints/{endpointID}")
retrofit2.Call<NotificationEndpoint> patchNotificationEndpointsID(@Path(value="endpointID")
String endpointID,
@Body
NotificationEndpointUpdate notificationEndpointUpdate,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
endpointID - The notification endpoint ID. (required)notificationEndpointUpdate - Check update to apply (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/notificationEndpoints/{endpointID}/labels")
retrofit2.Call<LabelResponse> postNotificationEndpointIDLabels(@Path(value="endpointID")
String endpointID,
@Body
LabelMapping labelMapping,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
endpointID - The notification endpoint ID. (required)labelMapping - Label to add (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@PUT(value="api/v2/notificationEndpoints/{endpointID}")
retrofit2.Call<NotificationEndpoint> putNotificationEndpointsID(@Path(value="endpointID")
String endpointID,
@Body
NotificationEndpoint notificationEndpoint,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
endpointID - The notification endpoint ID. (required)notificationEndpoint - A new notification endpoint to replace the existing endpoint with (required)zapTraceSpan - OpenTracing span context (optional)Copyright © 2018–2020 InfluxData, Inc.. All rights reserved.