To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Measured usage for a single usage factor together with the quota included in the license, used to report how far the subscription has gone over its plan for that factor. Produced by calcOverage, one instance per usage factor.
Extends: MetricUsageData
Properties
| Property | Returns | Description |
|---|---|---|
| included | BigDecimal | The quota included in the license for this usage factor. Never null; defaults to zero when no inclusion amount applies. |
| overage | BigDecimal | The amount of usage, after scaling, that exceeds the included quota for this factor. |
Inherited from MetricUsageData
Properties
| Property | Returns | Description |
|---|---|---|
| id | String | Identifier of the usage factor this measurement was taken for, matching UsageFactor.getId. |
| totalUsage | BigDecimal | Total measured usage for this factor over the license period, with the usage factor's scale factor applied so the value is in its billed units. |
| usageFactor | UsageFactor | The usage factor that this measurement was taken for. |
Methods
getId()
Returns: String
Identifier of the usage factor this measurement was taken for, matching UsageFactor.getId.
getTotalUsage()
Returns: BigDecimal
Total measured usage for this factor over the license period, with the usage factor's scale factor applied so the value is in its billed units.
getUsageFactor()
Returns: UsageFactor
The usage factor that this measurement was taken for.
series()
Returns: SalesDataSeries
Looks up the sales data series that this factor's usage was read from.
hasUsage()
Returns: boolean
Whether any usage was measured for this factor over the license period.
Methods
getIncluded()
Returns: BigDecimal
The quota included in the license for this usage factor. Never null; defaults to zero when no inclusion amount applies.
getOverage()
Returns: BigDecimal
The amount of usage, after scaling, that exceeds the included quota for this factor.
hasOvers()
Returns: boolean
Whether measured usage for this factor exceeds the included quota.
© 2025 Kademi Ltd