public interface DashboardsService
| Modifier and Type | Method and 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.
|
@DELETE(value="api/v2/dashboards/{dashboardID}")
retrofit2.Call<Void> deleteDashboardsID(@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - The ID of the dashboard to update. (required)zapTraceSpan - OpenTracing span context (optional)@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 - The ID of the dashboard to delete. (required)cellID - The ID of the cell to delete. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/dashboards/{dashboardID}/labels/{labelID}")
retrofit2.Call<Void> deleteDashboardsIDLabelsID(@Path(value="dashboardID")
String dashboardID,
@Path(value="labelID")
String labelID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - The dashboard ID. (required)labelID - The ID of the label to delete. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/dashboards/{dashboardID}/members/{userID}")
retrofit2.Call<Void> deleteDashboardsIDMembersID(@Path(value="userID")
String userID,
@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
userID - The ID of the member to remove. (required)dashboardID - The dashboard ID. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/dashboards/{dashboardID}/owners/{userID}")
retrofit2.Call<Void> deleteDashboardsIDOwnersID(@Path(value="userID")
String userID,
@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
userID - The ID of the owner to remove. (required)dashboardID - The dashboard ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/dashboards") retrofit2.Call<Dashboards> getDashboards(@Header(value="Zap-Trace-Span") String zapTraceSpan, @Query(value="offset") Integer offset, @Query(value="limit") Integer limit, @Query(value="descending") Boolean descending, @Query(value="owner") String owner, @Query(value="sortBy") String sortBy, @Query(value="id") List<String> id, @Query(value="orgID") String orgID, @Query(value="org") String org)
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)@GET(value="api/v2/dashboards/{dashboardID}")
retrofit2.Call<Dashboard> getDashboardsID(@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan,
@Query(value="include")
String include)
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)@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 - The dashboard ID. (required)cellID - The cell ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/dashboards/{dashboardID}/labels")
retrofit2.Call<LabelsResponse> getDashboardsIDLabels(@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - The dashboard ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/dashboards/{dashboardID}/members")
retrofit2.Call<ResourceMembers> getDashboardsIDMembers(@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - The dashboard ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/dashboards/{dashboardID}/owners")
retrofit2.Call<ResourceOwners> getDashboardsIDOwners(@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - The dashboard ID. (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@PATCH(value="api/v2/dashboards/{dashboardID}")
retrofit2.Call<Dashboard> patchDashboardsID(@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan,
@Body
PatchDashboardRequest patchDashboardRequest)
dashboardID - The ID of the dashboard to update. (required)zapTraceSpan - OpenTracing span context (optional)patchDashboardRequest - (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 - The ID of the dashboard to update. (required)cellID - The ID of the cell to update. (required)cellUpdate - (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 - The ID of the dashboard to update. (required)cellID - The ID of the cell to update. (required)view - (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json") @POST(value="api/v2/dashboards") retrofit2.Call<Dashboard> postDashboards(@Body CreateDashboardRequest createDashboardRequest, @Header(value="Zap-Trace-Span") String zapTraceSpan)
createDashboardRequest - Dashboard to create (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 - The ID of the dashboard to update. (required)createCell - Cell that will be added (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/dashboards/{dashboardID}/labels")
retrofit2.Call<LabelResponse> postDashboardsIDLabels(@Path(value="dashboardID")
String dashboardID,
@Body
LabelMapping labelMapping,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - The dashboard ID. (required)labelMapping - Label to add (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/dashboards/{dashboardID}/members")
retrofit2.Call<ResourceMember> postDashboardsIDMembers(@Path(value="dashboardID")
String dashboardID,
@Body
AddResourceMemberRequestBody addResourceMemberRequestBody,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - The dashboard ID. (required)addResourceMemberRequestBody - User to add as member (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/dashboards/{dashboardID}/owners")
retrofit2.Call<ResourceOwner> postDashboardsIDOwners(@Path(value="dashboardID")
String dashboardID,
@Body
AddResourceMemberRequestBody addResourceMemberRequestBody,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - The dashboard ID. (required)addResourceMemberRequestBody - User to add as owner (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 - The ID of the dashboard to update. (required)cell - (required)zapTraceSpan - OpenTracing span context (optional)Copyright © 2018–2021 InfluxData, Inc.. All rights reserved.