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)
removes a member from an dashboard
|
retrofit2.Call<Void> |
deleteDashboardsIDOwnersID(String userID,
String dashboardID,
String zapTraceSpan)
removes an owner from a dashboard
|
retrofit2.Call<Dashboards> |
getDashboards(String zapTraceSpan,
String owner,
String sortBy,
List<String> id,
String orgID,
String org)
Get all dashboards
|
retrofit2.Call<Dashboard> |
getDashboardsID(String dashboardID,
String zapTraceSpan)
Get a single Dashboard
|
retrofit2.Call<View> |
getDashboardsIDCellsIDView(String dashboardID,
String cellID,
String zapTraceSpan)
Retrieve the view for a cell in a dashboard
|
retrofit2.Call<LabelsResponse> |
getDashboardsIDLabels(String dashboardID,
String zapTraceSpan)
list all labels for a dashboard
|
retrofit2.Call<OperationLogs> |
getDashboardsIDLogs(String dashboardID,
String zapTraceSpan,
Integer offset,
Integer limit)
Retrieve operation logs 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,
Dashboard dashboard,
String zapTraceSpan)
Update a single 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<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 dashboard member
|
retrofit2.Call<ResourceOwner> |
postDashboardsIDOwners(String dashboardID,
AddResourceMemberRequestBody addResourceMemberRequestBody,
String zapTraceSpan)
Add dashboard owner
|
retrofit2.Call<Dashboard> |
putDashboardsIDCells(String dashboardID,
List<Cell> cell,
String zapTraceSpan)
Replace a dashboards cells
|
@DELETE(value="api/v2/dashboards/{dashboardID}")
retrofit2.Call<Void> deleteDashboardsID(@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - ID of 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 - ID of dashboard to delte (required)cellID - ID of 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 - ID of the dashboard (required)labelID - the label id 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 - ID of member to remove (required)dashboardID - ID of the dashboard (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 - ID of owner to remove (required)dashboardID - ID of the dashboard (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/dashboards") retrofit2.Call<Dashboards> getDashboards(@Header(value="Zap-Trace-Span") String zapTraceSpan, @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)owner - specifies the owner id to return resources for (optional)sortBy - specifies the owner id to return resources for (optional)id - ID list of dashboards to return. If both this and owner are specified, only ids is used. (optional, default to new ArrayList<>())orgID - specifies the organization id of the resource (optional)org - specifies the organization name of the resource (optional)@GET(value="api/v2/dashboards/{dashboardID}")
retrofit2.Call<Dashboard> getDashboardsID(@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - ID of dashboard to update (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)@GET(value="api/v2/dashboards/{dashboardID}/labels")
retrofit2.Call<LabelsResponse> getDashboardsIDLabels(@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - ID of the dashboard (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/dashboards/{dashboardID}/logs")
retrofit2.Call<OperationLogs> getDashboardsIDLogs(@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan,
@Query(value="offset")
Integer offset,
@Query(value="limit")
Integer limit)
dashboardID - ID of the dashboard (required)zapTraceSpan - OpenTracing span context (optional)offset - (optional)limit - (optional, default to 20)@GET(value="api/v2/dashboards/{dashboardID}/members")
retrofit2.Call<ResourceMembers> getDashboardsIDMembers(@Path(value="dashboardID")
String dashboardID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - ID of the dashboard (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 - ID of the dashboard (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,
@Body
Dashboard dashboard,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
dashboardID - ID of dashboard to update (required)dashboard - patching of a dashboard (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") 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 - ID of 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 - ID of the dashboard (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 - ID of the dashboard (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 - ID of the dashboard (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 - 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.