public interface TemplatesService
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<Void> |
deleteDocumentsTemplatesID(String templateID,
String zapTraceSpan)
Delete a template
|
retrofit2.Call<Void> |
deleteDocumentsTemplatesIDLabelsID(String templateID,
String labelID,
String zapTraceSpan)
Delete a label from a template
|
retrofit2.Call<Documents> |
getDocumentsTemplates(String zapTraceSpan,
String org,
String orgID) |
retrofit2.Call<Document> |
getDocumentsTemplatesID(String templateID,
String zapTraceSpan) |
retrofit2.Call<LabelsResponse> |
getDocumentsTemplatesIDLabels(String templateID,
String zapTraceSpan)
List all labels for a template
|
retrofit2.Call<Document> |
postDocumentsTemplates(DocumentCreate documentCreate,
String zapTraceSpan)
Create a template
|
retrofit2.Call<LabelResponse> |
postDocumentsTemplatesIDLabels(String templateID,
LabelMapping labelMapping,
String zapTraceSpan)
Add a label to a template
|
retrofit2.Call<Document> |
putDocumentsTemplatesID(String templateID,
DocumentUpdate documentUpdate,
String zapTraceSpan) |
@DELETE(value="api/v2/documents/templates/{templateID}")
retrofit2.Call<Void> deleteDocumentsTemplatesID(@Path(value="templateID")
String templateID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
templateID - The template ID. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/documents/templates/{templateID}/labels/{labelID}")
retrofit2.Call<Void> deleteDocumentsTemplatesIDLabelsID(@Path(value="templateID")
String templateID,
@Path(value="labelID")
String labelID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
templateID - The template ID. (required)labelID - The label ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/documents/templates") retrofit2.Call<Documents> getDocumentsTemplates(@Header(value="Zap-Trace-Span") String zapTraceSpan, @Query(value="org") String org, @Query(value="orgID") String orgID)
zapTraceSpan - OpenTracing span context (optional)org - Specifies the name of the organization of the template. (optional)orgID - Specifies the organization ID of the template. (optional)@GET(value="api/v2/documents/templates/{templateID}")
retrofit2.Call<Document> getDocumentsTemplatesID(@Path(value="templateID")
String templateID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
templateID - The template ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/documents/templates/{templateID}/labels")
retrofit2.Call<LabelsResponse> getDocumentsTemplatesIDLabels(@Path(value="templateID")
String templateID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
templateID - The template ID. (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json") @POST(value="api/v2/documents/templates") retrofit2.Call<Document> postDocumentsTemplates(@Body DocumentCreate documentCreate, @Header(value="Zap-Trace-Span") String zapTraceSpan)
documentCreate - Template that will be created (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/documents/templates/{templateID}/labels")
retrofit2.Call<LabelResponse> postDocumentsTemplatesIDLabels(@Path(value="templateID")
String templateID,
@Body
LabelMapping labelMapping,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
templateID - The template ID. (required)labelMapping - Label to add (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@PUT(value="api/v2/documents/templates/{templateID}")
retrofit2.Call<Document> putDocumentsTemplatesID(@Path(value="templateID")
String templateID,
@Body
DocumentUpdate documentUpdate,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
templateID - The template ID. (required)documentUpdate - Template that will be updated (required)zapTraceSpan - OpenTracing span context (optional)Copyright © 2018–2021 InfluxData, Inc.. All rights reserved.