public interface CellsService
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<Void> |
deleteDashboardsIDCellsID(String dashboardID,
String cellID,
String zapTraceSpan)
Delete a dashboard cell
|
retrofit2.Call<View> |
getDashboardsIDCellsIDView(String dashboardID,
String cellID,
String zapTraceSpan)
Retrieve the view for a cell in a dashboard
|
retrofit2.Call<Cell> |
patchDashboardsIDCellsID(String dashboardID,
String cellID,
CellUpdate cellUpdate,
String zapTraceSpan)
Update the non positional information related to a cell (because updates to a single cells positional data could cause grid conflicts)
|
retrofit2.Call<View> |
patchDashboardsIDCellsIDView(String dashboardID,
String cellID,
View view,
String zapTraceSpan)
Update the view for a cell
|
retrofit2.Call<Cell> |
postDashboardsIDCells(String dashboardID,
CreateCell createCell,
String zapTraceSpan)
Create a dashboard cell
|
retrofit2.Call<Dashboard> |
putDashboardsIDCells(String dashboardID,
List<Cell> cell,
String zapTraceSpan)
Replace a dashboards cells
|
@DELETE(value="api/v2/dashboards/{dashboardID}/cells/{cellID}")
retrofit2.Call<Void> deleteDashboardsIDCellsID(@Path(value="dashboardID")
String dashboardID,
@Path(value="cellID")
String cellID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - ID of dashboard to delte (required)cellID - ID of cell to delete (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/dashboards/{dashboardID}/cells/{cellID}/view")
retrofit2.Call<View> getDashboardsIDCellsIDView(@Path(value="dashboardID")
String dashboardID,
@Path(value="cellID")
String cellID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - ID of dashboard (required)cellID - ID of cell (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@PATCH(value="api/v2/dashboards/{dashboardID}/cells/{cellID}")
retrofit2.Call<Cell> patchDashboardsIDCellsID(@Path(value="dashboardID")
String dashboardID,
@Path(value="cellID")
String cellID,
@Body
CellUpdate cellUpdate,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - ID of dashboard to update (required)cellID - ID of cell to update (required)cellUpdate - updates the non positional information related to a cell (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@PATCH(value="api/v2/dashboards/{dashboardID}/cells/{cellID}/view")
retrofit2.Call<View> patchDashboardsIDCellsIDView(@Path(value="dashboardID")
String dashboardID,
@Path(value="cellID")
String cellID,
@Body
View view,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - ID of dashboard to update (required)cellID - ID of cell to update (required)view - updates the view for a cell (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/dashboards/{dashboardID}/cells")
retrofit2.Call<Cell> postDashboardsIDCells(@Path(value="dashboardID")
String dashboardID,
@Body
CreateCell createCell,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - ID of dashboard to update (required)createCell - cell that will be added (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@PUT(value="api/v2/dashboards/{dashboardID}/cells")
retrofit2.Call<Dashboard> putDashboardsIDCells(@Path(value="dashboardID")
String dashboardID,
@Body
List<Cell> cell,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - ID of dashboard to update (required)cell - batch replaces all of a dashboards cells (this is used primarily to update the positional information of all of the cells) (required)zapTraceSpan - OpenTracing span context (optional)Copyright © 2018–2019 InfluxData, Inc.. All rights reserved.