Package com.influxdb.client.service

Interface ChecksService

public interface ChecksService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Check>	createCheck(Check check)	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)	List all checks
retrofit2.Call<Check>	getChecksID(String checkID, String zapTraceSpan)	Retrieve a check
retrofit2.Call<LabelsResponse>	getChecksIDLabels(String checkID, String zapTraceSpan)	List all labels for a check
retrofit2.Call<FluxResponse>	getChecksIDQuery(String checkID, String zapTraceSpan)	Retrieve 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

Method Details

createCheck

@Headers("Content-Type:application/json")
@POST("api/v2/checks")
retrofit2.Call<Check> createCheck(@Body
 Check check)

Add new check

Parameters:

check - Check to create (required)

Returns:

Call<Check>

deleteChecksID

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

Delete a check

Parameters:

checkID - The check ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteChecksIDLabelsID

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

Delete label from a check

Parameters:

checkID - The check ID. (required)

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

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getChecks

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

List all checks

Parameters:

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

zapTraceSpan - OpenTracing span context (optional)

offset - (optional)

limit - (optional, default to 20)

Returns:

Call<Checks>

getChecksID

@GET("api/v2/checks/{checkID}")
retrofit2.Call<Check> getChecksID(@Path("checkID")
 String checkID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Retrieve a check

Parameters:

checkID - The check ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Check>

getChecksIDLabels

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

List all labels for a check

Parameters:

checkID - The check ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelsResponse>

getChecksIDQuery

@GET("api/v2/checks/{checkID}/query")
retrofit2.Call<FluxResponse> getChecksIDQuery(@Path("checkID")
 String checkID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Retrieve a check query

Parameters:

checkID - The check ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<FluxResponse>

patchChecksID

@Headers("Content-Type:application/json")
@PATCH("api/v2/checks/{checkID}")
retrofit2.Call<Check> patchChecksID(@Path("checkID")
 String checkID,
 @Body
 CheckPatch checkPatch,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update a check

Parameters:

checkID - The check ID. (required)

checkPatch - Check update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Check>

postChecksIDLabels

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

Add a label to a check

Parameters:

checkID - The check ID. (required)

labelMapping - Label to add (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelResponse>

putChecksID

@Headers("Content-Type:application/json")
@PUT("api/v2/checks/{checkID}")
retrofit2.Call<Check> putChecksID(@Path("checkID")
 String checkID,
 @Body
 Check check,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update a check

Parameters:

checkID - The check ID. (required)

check - Check update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Check>