HistoricalOptions (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.budgets.model.HistoricalOptions

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HistoricalOptions
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The parameters that define or describe the historical data that your auto-adjusting budget is based on.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

HistoricalOptions()

Constructors
Constructor and Description
`HistoricalOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HistoricalOptions`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getBudgetAdjustmentPeriod()` The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount.
`Integer`	`getLookBackAvailablePeriods()` The integer that describes how many budget periods in your `BudgetAdjustmentPeriod` are included in the calculation of your current `BudgetLimit`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBudgetAdjustmentPeriod(Integer budgetAdjustmentPeriod)` The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount.
`void`	`setLookBackAvailablePeriods(Integer lookBackAvailablePeriods)` The integer that describes how many budget periods in your `BudgetAdjustmentPeriod` are included in the calculation of your current `BudgetLimit`.
`String`	`toString()` Returns a string representation of this object.
`HistoricalOptions`	`withBudgetAdjustmentPeriod(Integer budgetAdjustmentPeriod)` The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount.
`HistoricalOptions`	`withLookBackAvailablePeriods(Integer lookBackAvailablePeriods)` The integer that describes how many budget periods in your `BudgetAdjustmentPeriod` are included in the calculation of your current `BudgetLimit`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HistoricalOptions
```
public HistoricalOptions()
```
- Method Detail
  - setBudgetAdjustmentPeriod
```
public void setBudgetAdjustmentPeriod(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.
    Parameters:
    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.
  - getBudgetAdjustmentPeriod
```
public Integer getBudgetAdjustmentPeriod()
```
    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.
  - withBudgetAdjustmentPeriod
```
public HistoricalOptions withBudgetAdjustmentPeriod(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLookBackAvailablePeriods
```
public void setLookBackAvailablePeriods(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.
    
    Parameters:
    
    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.
  - getLookBackAvailablePeriods
```
public Integer getLookBackAvailablePeriods()
```
    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.
  - withLookBackAvailablePeriods
```
public HistoricalOptions withLookBackAvailablePeriods(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public HistoricalOptions clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class HistoricalOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HistoricalOptions

Method Detail

setBudgetAdjustmentPeriod

getBudgetAdjustmentPeriod

withBudgetAdjustmentPeriod

setLookBackAvailablePeriods

getLookBackAvailablePeriods

withLookBackAvailablePeriods

toString

equals

hashCode

clone

marshall