Class HistoricalOptions

java.lang.Object
software.amazon.awssdk.services.budgets.model.HistoricalOptions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HistoricalOptions.Builder,HistoricalOptions>
@Generated("software.amazon.awssdk:codegen") public final class HistoricalOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HistoricalOptions.Builder,HistoricalOptions>

The parameters that define or describe the historical data that your auto-adjusting budget is based on.

See Also:

  • Method Details

    • budgetAdjustmentPeriod

      public final Integer budgetAdjustmentPeriod()

      The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget:

      • For the DAILY granularity, the maximum value is 60.

      • For the MONTHLY granularity, the maximum value is 12.

      • For the QUARTERLY granularity, the maximum value is 4.

      • For the ANNUALLY granularity, the maximum value is 1.

      Returns:
      The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget:

      • For the DAILY granularity, the maximum value is 60.

      • For the MONTHLY granularity, the maximum value is 12.

      • For the QUARTERLY granularity, the maximum value is 4.

      • For the ANNUALLY granularity, the maximum value is 1.

    • lookBackAvailablePeriods

      public final Integer lookBackAvailablePeriods()

      The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit.

      For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3.

      You can’t set your own LookBackAvailablePeriods. The value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.

      Returns:
      The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit.

      For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3.

      You can’t set your own LookBackAvailablePeriods. The value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.

    • toBuilder

      public HistoricalOptions.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HistoricalOptions.Builder,HistoricalOptions>
      Returns:
      a builder for type T

    • builder

      public static HistoricalOptions.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HistoricalOptions.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.