Package com.influxdb.client.service

Interface DashboardsService

public interface DashboardsService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteDashboardsID(String dashboardID, String zapTraceSpan)	Delete a dashboard
retrofit2.Call<Void>	deleteDashboardsIDCellsID(String dashboardID, String cellID, String zapTraceSpan)	Delete a dashboard cell
retrofit2.Call<Void>	deleteDashboardsIDLabelsID(String dashboardID, String labelID, String zapTraceSpan)	Delete a label from a dashboard
retrofit2.Call<Void>	deleteDashboardsIDMembersID(String userID, String dashboardID, String zapTraceSpan)	Remove a member from a dashboard
retrofit2.Call<Void>	deleteDashboardsIDOwnersID(String userID, String dashboardID, String zapTraceSpan)	Remove an owner from a dashboard
retrofit2.Call<Dashboards>	getDashboards(String zapTraceSpan, Integer offset, Integer limit, Boolean descending, String owner, String sortBy, List<String> id, String orgID, String org)	List all dashboards
retrofit2.Call<Dashboard>	getDashboardsID(String dashboardID, String zapTraceSpan, String include)	Retrieve a Dashboard
retrofit2.Call<View>	getDashboardsIDCellsIDView(String dashboardID, String cellID, String zapTraceSpan)	Retrieve the view for a cell
retrofit2.Call<LabelsResponse>	getDashboardsIDLabels(String dashboardID, String zapTraceSpan)	List all labels for a dashboard
retrofit2.Call<ResourceMembers>	getDashboardsIDMembers(String dashboardID, String zapTraceSpan)	List all dashboard members
retrofit2.Call<ResourceOwners>	getDashboardsIDOwners(String dashboardID, String zapTraceSpan)	List all dashboard owners
retrofit2.Call<Dashboard>	patchDashboardsID(String dashboardID, String zapTraceSpan, PatchDashboardRequest patchDashboardRequest)	Update a dashboard
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<Dashboard>	postDashboards(CreateDashboardRequest createDashboardRequest, String zapTraceSpan)	Create a dashboard
retrofit2.Call<Cell>	postDashboardsIDCells(String dashboardID, CreateCell createCell, String zapTraceSpan)	Create a dashboard cell
retrofit2.Call<LabelResponse>	postDashboardsIDLabels(String dashboardID, LabelMapping labelMapping, String zapTraceSpan)	Add a label to a dashboard
retrofit2.Call<ResourceMember>	postDashboardsIDMembers(String dashboardID, AddResourceMemberRequestBody addResourceMemberRequestBody, String zapTraceSpan)	Add a member to a dashboard
retrofit2.Call<ResourceOwner>	postDashboardsIDOwners(String dashboardID, AddResourceMemberRequestBody addResourceMemberRequestBody, String zapTraceSpan)	Add an owner to a dashboard
retrofit2.Call<Dashboard>	putDashboardsIDCells(String dashboardID, List<Cell> cell, String zapTraceSpan)	Replace cells in a dashboard Replaces all cells in a dashboard.

Method Details

deleteDashboardsID

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

Delete a dashboard

Parameters:

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

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

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>

deleteDashboardsIDLabelsID

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

Delete a label from a dashboard

Parameters:

dashboardID - The dashboard ID. (required)

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

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteDashboardsIDMembersID

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

Remove a member from a dashboard

Parameters:

userID - The ID of the member to remove. (required)

dashboardID - The dashboard ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteDashboardsIDOwnersID

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

Remove an owner from a dashboard

Parameters:

userID - The ID of the owner to remove. (required)

dashboardID - The dashboard ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getDashboards

@GET("api/v2/dashboards")
retrofit2.Call<Dashboards> getDashboards(@Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("descending")
 Boolean descending,
 @Query("owner")
 String owner,
 @Query("sortBy")
 String sortBy,
 @Query("id")
 List<String> id,
 @Query("orgID")
 String orgID,
 @Query("org")
 String org)

List all dashboards

Parameters:

zapTraceSpan - OpenTracing span context (optional)

offset - (optional)

limit - (optional, default to 20)

descending - (optional, default to false)

owner - A user identifier. Returns only dashboards where this user has the `owner` role. (optional)

sortBy - The column to sort by. (optional)

id - A list of dashboard identifiers. Returns only the listed dashboards. If both `id` and `owner` are specified, only `id` is used. (optional, default to new ArrayList<>())

orgID - The identifier of the organization. (optional)

org - The name of the organization. (optional)

Returns:

Call<Dashboards>

getDashboardsID

@GET("api/v2/dashboards/{dashboardID}")
retrofit2.Call<Dashboard> getDashboardsID(@Path("dashboardID")
 String dashboardID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("include")
 String include)

Retrieve a Dashboard

Parameters:

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

zapTraceSpan - OpenTracing span context (optional)

include - Includes the cell view properties in the response if set to `properties` (optional)

Returns:

Call<Dashboard>

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>

getDashboardsIDLabels

@GET("api/v2/dashboards/{dashboardID}/labels")
retrofit2.Call<LabelsResponse> getDashboardsIDLabels(@Path("dashboardID")
 String dashboardID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all labels for a dashboard

Parameters:

dashboardID - The dashboard ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelsResponse>

getDashboardsIDMembers

@GET("api/v2/dashboards/{dashboardID}/members")
retrofit2.Call<ResourceMembers> getDashboardsIDMembers(@Path("dashboardID")
 String dashboardID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all dashboard members

Parameters:

dashboardID - The dashboard ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceMembers>

getDashboardsIDOwners

@GET("api/v2/dashboards/{dashboardID}/owners")
retrofit2.Call<ResourceOwners> getDashboardsIDOwners(@Path("dashboardID")
 String dashboardID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all dashboard owners

Parameters:

dashboardID - The dashboard ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceOwners>

patchDashboardsID

@Headers("Content-Type:application/json")
@PATCH("api/v2/dashboards/{dashboardID}")
retrofit2.Call<Dashboard> patchDashboardsID(@Path("dashboardID")
 String dashboardID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Body
 PatchDashboardRequest patchDashboardRequest)

Update a dashboard

Parameters:

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

zapTraceSpan - OpenTracing span context (optional)

patchDashboardRequest - (optional)

Returns:

Call<Dashboard>

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>

postDashboards

@Headers("Content-Type:application/json")
@POST("api/v2/dashboards")
retrofit2.Call<Dashboard> postDashboards(@Body
 CreateDashboardRequest createDashboardRequest,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Create a dashboard

Parameters:

createDashboardRequest - Dashboard to create (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Dashboard>

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>

postDashboardsIDLabels

@Headers("Content-Type:application/json")
@POST("api/v2/dashboards/{dashboardID}/labels")
retrofit2.Call<LabelResponse> postDashboardsIDLabels(@Path("dashboardID")
 String dashboardID,
 @Body
 LabelMapping labelMapping,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Add a label to a dashboard

Parameters:

dashboardID - The dashboard ID. (required)

labelMapping - Label to add (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelResponse>

postDashboardsIDMembers

@Headers("Content-Type:application/json")
@POST("api/v2/dashboards/{dashboardID}/members")
retrofit2.Call<ResourceMember> postDashboardsIDMembers(@Path("dashboardID")
 String dashboardID,
 @Body
 AddResourceMemberRequestBody addResourceMemberRequestBody,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Add a member to a dashboard

Parameters:

dashboardID - The dashboard ID. (required)

addResourceMemberRequestBody - User to add as member (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceMember>

postDashboardsIDOwners

@Headers("Content-Type:application/json")
@POST("api/v2/dashboards/{dashboardID}/owners")
retrofit2.Call<ResourceOwner> postDashboardsIDOwners(@Path("dashboardID")
 String dashboardID,
 @Body
 AddResourceMemberRequestBody addResourceMemberRequestBody,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Add an owner to a dashboard

Parameters:

dashboardID - The dashboard ID. (required)

addResourceMemberRequestBody - User to add as owner (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceOwner>

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>