Visualization of Usage¶
Visualization gives the user access to an overview of their usage during a set period or for a given product category.
Usage chart¶
The usage chart shows the usage over time for each product category.
Figure 1: Full usage shown for product type COMPUTE
for the period of a week.
Figure 2: Usage specifics for each category in the product type.
Breakdown chart¶
The breakdown chart shows the usage for the entire period divided into the different products used.
Figure 3: Breakdown of different products usage in product type COMPUTE
Table of Contents¶
1. Remote Procedure Calls
Name | Description |
---|---|
retrieveBreakdown |
Retrieve breakdown charts of usage for the entire period. |
retrieveUsage |
Retrieve charts of usage over time. |
2. Data Models
Name | Description |
---|---|
BreakdownChart |
No description |
LineChart |
No description |
LineChart.Line |
No description |
LineChart.Point |
No description |
PieChart |
No description |
PieChart.Point |
No description |
UsageChart |
No description |
VisualizationRetrieveBreakdownRequest |
No description |
VisualizationRetrieveUsageRequest |
No description |
VisualizationRetrieveBreakdownResponse |
No description |
VisualizationRetrieveUsageResponse |
No description |
Remote Procedure Calls¶
retrieveBreakdown
¶
Retrieve breakdown charts of usage for the entire period.
Request | Response | Error |
---|---|---|
VisualizationRetrieveBreakdownRequest |
VisualizationRetrieveBreakdownResponse |
CommonErrorMessage |
retrieveUsage
¶
Retrieve charts of usage over time.
Request | Response | Error |
---|---|---|
VisualizationRetrieveUsageRequest |
VisualizationRetrieveUsageResponse |
CommonErrorMessage |
Data Models¶
BreakdownChart
¶
data class BreakdownChart(
val type: ProductType,
val chargeType: ChargeType,
val unit: ProductPriceUnit,
val chart: PieChart,
)
LineChart
¶
data class LineChart(
val lines: List<LineChart.Line>,
)
Properties
lines
: List<LineChart.Line>
List<LineChart.Line>
LineChart.Line
¶
data class Line(
val name: String,
val points: List<LineChart.Point>,
)
LineChart.Point
¶
data class Point(
val timestamp: Long,
val value: Double,
)
PieChart
¶
data class PieChart(
val points: List<PieChart.Point>,
)
Properties
points
: List<PieChart.Point>
List<PieChart.Point>
PieChart.Point
¶
data class Point(
val name: String,
val value: Double,
)
UsageChart
¶
data class UsageChart(
val type: ProductType,
val periodUsage: Long,
val chargeType: ChargeType,
val unit: ProductPriceUnit,
val chart: LineChart,
)
Properties
type
: ProductType
ProductType
periodUsage
: Long
Long
chargeType
: ChargeType
ChargeType
unit
: ProductPriceUnit
ProductPriceUnit
chart
: LineChart
LineChart
VisualizationRetrieveBreakdownRequest
¶
data class VisualizationRetrieveBreakdownRequest(
val filterStartDate: Long?,
val filterEndDate: Long?,
val filterType: ProductType?,
val filterProvider: String?,
val filterProductCategory: String?,
val filterAllocation: String?,
val filterWorkspace: String?,
val filterWorkspaceProject: Boolean?,
)
VisualizationRetrieveUsageRequest
¶
data class VisualizationRetrieveUsageRequest(
val filterStartDate: Long?,
val filterEndDate: Long?,
val filterType: ProductType?,
val filterProvider: String?,
val filterProductCategory: String?,
val filterAllocation: String?,
val filterWorkspace: String?,
val filterWorkspaceProject: Boolean?,
)
VisualizationRetrieveBreakdownResponse
¶
data class VisualizationRetrieveBreakdownResponse(
val charts: List<BreakdownChart>,
)
Properties
charts
: List<BreakdownChart>
List<BreakdownChart>
VisualizationRetrieveUsageResponse
¶
data class VisualizationRetrieveUsageResponse(
val charts: List<UsageChart>,
)
Properties
charts
: List<UsageChart>
List<UsageChart>