Package com.azure.resourcemanager.costmanagement.models

Class SavingsPlanUtilizationSummary

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.costmanagement.fluent.models.BenefitUtilizationSummaryInner
com.azure.resourcemanager.costmanagement.models.SavingsPlanUtilizationSummary
public final class SavingsPlanUtilizationSummary extends BenefitUtilizationSummaryInner
Savings plan utilization summary resource.

  • Constructor Details

    • SavingsPlanUtilizationSummary

      public SavingsPlanUtilizationSummary()
      Creates an instance of SavingsPlanUtilizationSummary class.

  • Method Details

    • avgUtilizationPercentage

      public BigDecimal avgUtilizationPercentage()
      Get the avgUtilizationPercentage property: This is the average hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2022-10-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the avgUtilizationPercentage value will be equal to the average of the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day.
      Returns:
      the avgUtilizationPercentage value.

    • minUtilizationPercentage

      public BigDecimal minUtilizationPercentage()
      Get the minUtilizationPercentage property: This is the minimum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2022-10-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the minUtilizationPercentage value will be equal to the smallest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the lowest utilization percentage was 10% at hour 4, then the value for the minUtilizationPercentage in the response will be 10%.
      Returns:
      the minUtilizationPercentage value.

    • maxUtilizationPercentage

      public BigDecimal maxUtilizationPercentage()
      Get the maxUtilizationPercentage property: This is the maximum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2022-10-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the maxUtilizationPercentage value will be equal to the largest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the largest utilization percentage was 90% at hour 5, then the value for the maxUtilizationPercentage in the response will be 90%.
      Returns:
      the maxUtilizationPercentage value.

    • armSkuName

      public String armSkuName()
      Get the armSkuName property: ARM SKU name. For example, 'Compute_Savings_Plan' for savings plan.
      Returns:
      the armSkuName value.

    • benefitId

      public String benefitId()
      Get the benefitId property: The benefit ID is the identifier of the benefit.
      Returns:
      the benefitId value.

    • benefitOrderId

      public String benefitOrderId()
      Get the benefitOrderId property: The benefit order ID is the identifier for a benefit purchase.
      Returns:
      the benefitOrderId value.

    • benefitType

      public BenefitKind benefitType()
      Get the benefitType property: The benefit type. Supported values: 'SavingsPlan'.
      Returns:
      the benefitType value.

    • withBenefitType

      public SavingsPlanUtilizationSummary withBenefitType(BenefitKind benefitType)
      Set the benefitType property: The benefit type. Supported values: 'SavingsPlan'.
      Parameters:
      benefitType - the benefitType value to set.
      Returns:
      the SavingsPlanUtilizationSummary object itself.

    • usageDate

      public OffsetDateTime usageDate()
      Get the usageDate property: Date corresponding to the utilization summary record. If the grain of data is monthly, value for this field will be first day of the month.
      Returns:
      the usageDate value.

    • validate

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