Package com.ibm.cloud.platform_services.usage_reports.v4.model

Class Metric

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class Metric
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    Information about a metric.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Double getCost()
      Gets the cost.
      java.util.List<Discount> getDiscounts()
      Gets the discounts.
      java.lang.String getMetric()
      Gets the metric.
      java.lang.String getMetricName()
      Gets the metricName.
      java.util.List<java.lang.Object> getPrice()
      Gets the price.
      java.lang.Double getQuantity()
      Gets the quantity.
      java.lang.Double getRateableQuantity()
      Gets the rateableQuantity.
      java.lang.Double getRatedCost()
      Gets the ratedCost.
      java.lang.String getUnit()
      Gets the unit.
      java.lang.String getUnitName()
      Gets the unitName.
      java.lang.Double getVolumeCost()
      Gets the volumeCost.
      java.lang.Double getVolumeDiscount()
      Gets the volumeDiscount.
      java.lang.Boolean isNonChargeable()
      Gets the nonChargeable.

      • Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

        equals, hashCode, toString

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • getMetric

        public java.lang.String getMetric()
        Gets the metric. The ID of the metric.
        Returns:
        the metric

      • getMetricName

        public java.lang.String getMetricName()
        Gets the metricName. The name of the metric.
        Returns:
        the metricName

      • getQuantity

        public java.lang.Double getQuantity()
        Gets the quantity. The aggregated value for the metric.
        Returns:
        the quantity

      • getRateableQuantity

        public java.lang.Double getRateableQuantity()
        Gets the rateableQuantity. The quantity that is used for calculating charges.
        Returns:
        the rateableQuantity

      • getCost

        public java.lang.Double getCost()
        Gets the cost. The cost incurred by the metric.
        Returns:
        the cost

      • getRatedCost

        public java.lang.Double getRatedCost()
        Gets the ratedCost. Pre-discounted cost incurred by the metric.
        Returns:
        the ratedCost

      • getPrice

        public java.util.List<java.lang.Object> getPrice()
        Gets the price. The price with which the cost was calculated.
        Returns:
        the price

      • getUnit

        public java.lang.String getUnit()
        Gets the unit. The unit that qualifies the quantity.
        Returns:
        the unit

      • getUnitName

        public java.lang.String getUnitName()
        Gets the unitName. The name of the unit.
        Returns:
        the unitName

      • isNonChargeable

        public java.lang.Boolean isNonChargeable()
        Gets the nonChargeable. When set to `true`, the cost is for informational purpose and is not included while calculating the plan charges.
        Returns:
        the nonChargeable

      • getDiscounts

        public java.util.List<Discount> getDiscounts()
        Gets the discounts. All the discounts applicable to the metric.
        Returns:
        the discounts

      • getVolumeDiscount

        public java.lang.Double getVolumeDiscount()
        Gets the volumeDiscount. This percentage reflects the reduction to the original cost that you receive under a volume based pricing structure.
        Returns:
        the volumeDiscount

      • getVolumeCost

        public java.lang.Double getVolumeCost()
        Gets the volumeCost. The original cost adjusted for volume based discounts that are applied at the account level.
        Returns:
        the volumeCost