Package software.amazon.awssdk.services.budgets.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HistoricalOptions.Builder

Method Summary

Modifier and Type	Method	Description
Integer	budgetAdjustmentPeriod()	The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount.
static HistoricalOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	lookBackAvailablePeriods()	The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends HistoricalOptions.Builder>	serializableBuilderClass()
HistoricalOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<HistoricalOptions.Builder,HistoricalOptions>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo