public interface ChecksService
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<Check> |
createCheck(PostCheck postCheck)
Add new check
|
retrofit2.Call<Void> |
deleteChecksID(String checkID,
String zapTraceSpan)
Delete a check
|
retrofit2.Call<Void> |
deleteChecksIDLabelsID(String checkID,
String labelID,
String zapTraceSpan)
Delete label from a check
|
retrofit2.Call<Checks> |
getChecks(String orgID,
String zapTraceSpan,
Integer offset,
Integer limit)
Get all checks
|
retrofit2.Call<Check> |
getChecksID(String checkID,
String zapTraceSpan)
Get a check
|
retrofit2.Call<LabelsResponse> |
getChecksIDLabels(String checkID,
String zapTraceSpan)
List all labels for a check
|
retrofit2.Call<FluxResponse> |
getChecksIDQuery(String checkID,
String zapTraceSpan)
Get a check query
|
retrofit2.Call<Check> |
patchChecksID(String checkID,
CheckPatch checkPatch,
String zapTraceSpan)
Update a check
|
retrofit2.Call<LabelResponse> |
postChecksIDLabels(String checkID,
LabelMapping labelMapping,
String zapTraceSpan)
Add a label to a check
|
retrofit2.Call<Check> |
putChecksID(String checkID,
Check check,
String zapTraceSpan)
Update a check
|
@Headers(value="Content-Type:application/json") @POST(value="api/v2/checks") retrofit2.Call<Check> createCheck(@Body PostCheck postCheck)
postCheck - Check to create (required)@DELETE(value="api/v2/checks/{checkID}")
retrofit2.Call<Void> deleteChecksID(@Path(value="checkID")
String checkID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
checkID - The check ID. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/checks/{checkID}/labels/{labelID}")
retrofit2.Call<Void> deleteChecksIDLabelsID(@Path(value="checkID")
String checkID,
@Path(value="labelID")
String labelID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
checkID - The check ID. (required)labelID - The ID of the label to delete. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/checks") retrofit2.Call<Checks> getChecks(@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 checks that belong to a specific organization ID. (required)zapTraceSpan - OpenTracing span context (optional)offset - (optional)limit - (optional, default to 20)@GET(value="api/v2/checks/{checkID}")
retrofit2.Call<Check> getChecksID(@Path(value="checkID")
String checkID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
checkID - The check ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/checks/{checkID}/labels")
retrofit2.Call<LabelsResponse> getChecksIDLabels(@Path(value="checkID")
String checkID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
checkID - The check ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/checks/{checkID}/query")
retrofit2.Call<FluxResponse> getChecksIDQuery(@Path(value="checkID")
String checkID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
checkID - The check ID. (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@PATCH(value="api/v2/checks/{checkID}")
retrofit2.Call<Check> patchChecksID(@Path(value="checkID")
String checkID,
@Body
CheckPatch checkPatch,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
checkID - The check ID. (required)checkPatch - Check update to apply (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/checks/{checkID}/labels")
retrofit2.Call<LabelResponse> postChecksIDLabels(@Path(value="checkID")
String checkID,
@Body
LabelMapping labelMapping,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
checkID - The check ID. (required)labelMapping - Label to add (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@PUT(value="api/v2/checks/{checkID}")
retrofit2.Call<Check> putChecksID(@Path(value="checkID")
String checkID,
@Body
Check check,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
checkID - The check ID. (required)check - Check update to apply (required)zapTraceSpan - OpenTracing span context (optional)Copyright © 2018–2020 InfluxData, Inc.. All rights reserved.