Class BalanceProperties


  • public final class BalanceProperties
    extends Object
    The properties of the balance.
    • Constructor Detail

      • BalanceProperties

        public BalanceProperties()
    • Method Detail

      • currency

        public String currency()
        Get the currency property: The ISO currency in which the meter is charged, for example, USD.
        Returns:
        the currency value.
      • beginningBalance

        public BigDecimal beginningBalance()
        Get the beginningBalance property: The beginning balance for the billing period.
        Returns:
        the beginningBalance value.
      • endingBalance

        public BigDecimal endingBalance()
        Get the endingBalance property: The ending balance for the billing period (for open periods this will be updated daily).
        Returns:
        the endingBalance value.
      • newPurchases

        public BigDecimal newPurchases()
        Get the newPurchases property: Total new purchase amount.
        Returns:
        the newPurchases value.
      • adjustments

        public BigDecimal adjustments()
        Get the adjustments property: Total adjustment amount.
        Returns:
        the adjustments value.
      • utilized

        public BigDecimal utilized()
        Get the utilized property: Total Commitment usage.
        Returns:
        the utilized value.
      • serviceOverage

        public BigDecimal serviceOverage()
        Get the serviceOverage property: Overage for Azure services.
        Returns:
        the serviceOverage value.
      • chargesBilledSeparately

        public BigDecimal chargesBilledSeparately()
        Get the chargesBilledSeparately property: Charges Billed separately.
        Returns:
        the chargesBilledSeparately value.
      • totalOverage

        public BigDecimal totalOverage()
        Get the totalOverage property: serviceOverage + chargesBilledSeparately.
        Returns:
        the totalOverage value.
      • totalUsage

        public BigDecimal totalUsage()
        Get the totalUsage property: Azure service commitment + total Overage.
        Returns:
        the totalUsage value.
      • azureMarketplaceServiceCharges

        public BigDecimal azureMarketplaceServiceCharges()
        Get the azureMarketplaceServiceCharges property: Total charges for Azure Marketplace.
        Returns:
        the azureMarketplaceServiceCharges value.
      • billingFrequency

        public BillingFrequency billingFrequency()
        Get the billingFrequency property: The billing frequency.
        Returns:
        the billingFrequency value.
      • withBillingFrequency

        public BalanceProperties withBillingFrequency​(BillingFrequency billingFrequency)
        Set the billingFrequency property: The billing frequency.
        Parameters:
        billingFrequency - the billingFrequency value to set.
        Returns:
        the BalanceProperties object itself.
      • priceHidden

        public Boolean priceHidden()
        Get the priceHidden property: Price is hidden or not.
        Returns:
        the priceHidden value.
      • adjustmentDetails

        public List<BalancePropertiesAdjustmentDetailsItem> adjustmentDetails()
        Get the adjustmentDetails property: List of Adjustments (Promo credit, SIE credit etc.).
        Returns:
        the adjustmentDetails value.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.