com.influxdb.client.service

Interface LabelsService

public interface LabelsService

Method Summary

Modifier and Type	Method and 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 Detail

deleteLabelsID

@DELETE(value="api/v2/labels/{labelID}")
retrofit2.Call<Void> deleteLabelsID(@Path(value="labelID")
                                                                             String labelID,
                                                                             @Header(value="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(value="api/v2/labels")
retrofit2.Call<LabelsResponse> getLabels(@Header(value="Zap-Trace-Span")
                                                                     String zapTraceSpan,
                                                                     @Query(value="orgID")
                                                                     String orgID)

List all labels

Parameters:

zapTraceSpan - OpenTracing span context (optional)

orgID - The organization ID. (optional)

Returns:

Call<LabelsResponse>

getLabelsID

@GET(value="api/v2/labels/{labelID}")
retrofit2.Call<LabelResponse> getLabelsID(@Path(value="labelID")
                                                                                String labelID,
                                                                                @Header(value="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(value="Content-Type:application/json")
 @PATCH(value="api/v2/labels/{labelID}")
retrofit2.Call<LabelResponse> patchLabelsID(@Path(value="labelID")
                                                                                                                                     String labelID,
                                                                                                                                     @Body
                                                                                                                                     LabelUpdate labelUpdate,
                                                                                                                                     @Header(value="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(value="Content-Type:application/json")
 @POST(value="api/v2/labels")
retrofit2.Call<LabelResponse> postLabels(@Body
                                                                                                                       LabelCreateRequest labelCreateRequest)

Create a label

Parameters:

labelCreateRequest - Label to create (required)

Returns:

Call<LabelResponse>