Package com.influxdb.client.service

Interface LabelsService

public interface LabelsService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteLabelsID(String labelID, String zapTraceSpan)	Delete a label
retrofit2.Call<LabelsResponse>	getLabels(String zapTraceSpan, String orgID)	List all labels
retrofit2.Call<LabelResponse>	getLabelsID(String labelID, String zapTraceSpan)	Retrieve a label
retrofit2.Call<LabelResponse>	patchLabelsID(String labelID, LabelUpdate labelUpdate, String zapTraceSpan)	Update a label
retrofit2.Call<LabelResponse>	postLabels(LabelCreateRequest labelCreateRequest)	Create a label

Method Details

deleteLabelsID

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

Delete a label

Parameters:

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

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getLabels

@GET("api/v2/labels")
retrofit2.Call<LabelsResponse> getLabels(@Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("orgID")
 String orgID)

List all labels

Parameters:

zapTraceSpan - OpenTracing span context (optional)

orgID - The organization ID. (optional)

Returns:

Call<LabelsResponse>

getLabelsID

@GET("api/v2/labels/{labelID}")
retrofit2.Call<LabelResponse> getLabelsID(@Path("labelID")
 String labelID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Retrieve a label

Parameters:

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

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelResponse>

patchLabelsID

@Headers("Content-Type:application/json")
@PATCH("api/v2/labels/{labelID}")
retrofit2.Call<LabelResponse> patchLabelsID(@Path("labelID")
 String labelID,
 @Body
 LabelUpdate labelUpdate,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update a label

Parameters:

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

labelUpdate - Label update (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelResponse>

postLabels

@Headers("Content-Type:application/json")
@POST("api/v2/labels")
retrofit2.Call<LabelResponse> postLabels(@Body
 LabelCreateRequest labelCreateRequest)

Create a label

Parameters:

labelCreateRequest - Label to create (required)

Returns:

Call<LabelResponse>