Package com.influxdb.client.service

Interface CellsService

public interface CellsService

Method Summary

Modifier and Type	Method	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
retrofit2.Call<Cell>	patchDashboardsIDCellsID(String dashboardID, String cellID, CellUpdate cellUpdate, String zapTraceSpan)	Update the non-positional information related to a cell Updates the non positional information related to a cell.
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 cells in a dashboard Replaces all cells in a dashboard.

Method Details

deleteDashboardsIDCellsID

@DELETE("api/v2/dashboards/{dashboardID}/cells/{cellID}")
retrofit2.Call<Void> deleteDashboardsIDCellsID(@Path("dashboardID")
 String dashboardID,
 @Path("cellID")
 String cellID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Delete a dashboard cell

Parameters:

dashboardID - The ID of the dashboard to delete. (required)

cellID - The ID of the cell to delete. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getDashboardsIDCellsIDView

@GET("api/v2/dashboards/{dashboardID}/cells/{cellID}/view")
retrofit2.Call<View> getDashboardsIDCellsIDView(@Path("dashboardID")
 String dashboardID,
 @Path("cellID")
 String cellID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Retrieve the view for a cell

Parameters:

dashboardID - The dashboard ID. (required)

cellID - The cell ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<View>

patchDashboardsIDCellsID

@Headers("Content-Type:application/json")
@PATCH("api/v2/dashboards/{dashboardID}/cells/{cellID}")
retrofit2.Call<Cell> patchDashboardsIDCellsID(@Path("dashboardID")
 String dashboardID,
 @Path("cellID")
 String cellID,
 @Body
 CellUpdate cellUpdate,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update the non-positional information related to a cell Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Parameters:

dashboardID - The ID of the dashboard to update. (required)

cellID - The ID of the cell to update. (required)

cellUpdate - (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Cell>

patchDashboardsIDCellsIDView

@Headers("Content-Type:application/json")
@PATCH("api/v2/dashboards/{dashboardID}/cells/{cellID}/view")
retrofit2.Call<View> patchDashboardsIDCellsIDView(@Path("dashboardID")
 String dashboardID,
 @Path("cellID")
 String cellID,
 @Body
 View view,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update the view for a cell

Parameters:

dashboardID - The ID of the dashboard to update. (required)

cellID - The ID of the cell to update. (required)

view - (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<View>

postDashboardsIDCells

@Headers("Content-Type:application/json")
@POST("api/v2/dashboards/{dashboardID}/cells")
retrofit2.Call<Cell> postDashboardsIDCells(@Path("dashboardID")
 String dashboardID,
 @Body
 CreateCell createCell,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Create a dashboard cell

Parameters:

dashboardID - The ID of the dashboard to update. (required)

createCell - Cell that will be added (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Cell>

putDashboardsIDCells

@Headers("Content-Type:application/json")
@PUT("api/v2/dashboards/{dashboardID}/cells")
retrofit2.Call<Dashboard> putDashboardsIDCells(@Path("dashboardID")
 String dashboardID,
 @Body
 List<Cell> cell,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Replace cells in a dashboard Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Parameters:

dashboardID - The ID of the dashboard to update. (required)

cell - (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Dashboard>