Budget (AWS Java SDK for AWS Budgets 1.11.297 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Budget
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget.

The ARN pattern for a budget is: arn:aws:budgetservice::AccountId:budget/budgetName

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Budget()

Constructors
Constructor and Description
`Budget()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Budget`	`addCostFiltersEntry(String key, List<String> value)`
`Budget`	`clearCostFiltersEntries()` Removes all the entries added into CostFilters.
`Budget`	`clone()`
`boolean`	`equals(Object obj)`
`Spend`	`getBudgetLimit()` The total amount of cost, usage, or RI utilization that you want to track with your budget.
`String`	`getBudgetName()` The name of a budget.
`String`	`getBudgetType()` Whether this budget tracks monetary costs, usage, or RI utilization.
`CalculatedSpend`	`getCalculatedSpend()` The actual and forecasted cost or usage being tracked by a budget.
`Map<String,List<String>>`	`getCostFilters()` The cost filters applied to a budget, such as service or region.
`CostTypes`	`getCostTypes()` The types of costs included in this budget.
`TimePeriod`	`getTimePeriod()` The period of time covered by a budget.
`String`	`getTimeUnit()` The length of time until a budget resets the actual and forecasted spend.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setBudgetLimit(Spend budgetLimit)` The total amount of cost, usage, or RI utilization that you want to track with your budget.
`void`	`setBudgetName(String budgetName)` The name of a budget.
`void`	`setBudgetType(BudgetType budgetType)` Whether this budget tracks monetary costs, usage, or RI utilization.
`void`	`setBudgetType(String budgetType)` Whether this budget tracks monetary costs, usage, or RI utilization.
`void`	`setCalculatedSpend(CalculatedSpend calculatedSpend)` The actual and forecasted cost or usage being tracked by a budget.
`void`	`setCostFilters(Map<String,List<String>> costFilters)` The cost filters applied to a budget, such as service or region.
`void`	`setCostTypes(CostTypes costTypes)` The types of costs included in this budget.
`void`	`setTimePeriod(TimePeriod timePeriod)` The period of time covered by a budget.
`void`	`setTimeUnit(String timeUnit)` The length of time until a budget resets the actual and forecasted spend.
`void`	`setTimeUnit(TimeUnit timeUnit)` The length of time until a budget resets the actual and forecasted spend.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Budget`	`withBudgetLimit(Spend budgetLimit)` The total amount of cost, usage, or RI utilization that you want to track with your budget.
`Budget`	`withBudgetName(String budgetName)` The name of a budget.
`Budget`	`withBudgetType(BudgetType budgetType)` Whether this budget tracks monetary costs, usage, or RI utilization.
`Budget`	`withBudgetType(String budgetType)` Whether this budget tracks monetary costs, usage, or RI utilization.
`Budget`	`withCalculatedSpend(CalculatedSpend calculatedSpend)` The actual and forecasted cost or usage being tracked by a budget.
`Budget`	`withCostFilters(Map<String,List<String>> costFilters)` The cost filters applied to a budget, such as service or region.
`Budget`	`withCostTypes(CostTypes costTypes)` The types of costs included in this budget.
`Budget`	`withTimePeriod(TimePeriod timePeriod)` The period of time covered by a budget.
`Budget`	`withTimeUnit(String timeUnit)` The length of time until a budget resets the actual and forecasted spend.
`Budget`	`withTimeUnit(TimeUnit timeUnit)` The length of time until a budget resets the actual and forecasted spend.

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

- Constructor Detail
  - Budget
```
public Budget()
```
- Method Detail
  - setBudgetName
```
public void setBudgetName(String budgetName)
```
    The name of a budget. Unique within accounts. : and \ characters are not allowed in the BudgetName.
    
    Parameters:
    
    budgetName - The name of a budget. Unique within accounts. : and \ characters are not allowed in the BudgetName.
  - getBudgetName
```
public String getBudgetName()
```
    The name of a budget. Unique within accounts. : and \ characters are not allowed in the BudgetName.
    
    Returns:
    
    The name of a budget. Unique within accounts. : and \ characters are not allowed in the BudgetName.
  - withBudgetName
```
public Budget withBudgetName(String budgetName)
```
    The name of a budget. Unique within accounts. : and \ characters are not allowed in the BudgetName.
    
    Parameters:
    
    budgetName - The name of a budget. Unique within accounts. : and \ characters are not allowed in the BudgetName.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBudgetLimit
```
public void setBudgetLimit(Spend budgetLimit)
```
    The total amount of cost, usage, or RI utilization that you want to track with your budget.
    
    BudgetLimit is required for cost or usage budgets, but optional for RI utilization budgets. RI utilization budgets default to the only valid value for RI utilization budgets, which is 100.
    
    Parameters:
    
    budgetLimit - The total amount of cost, usage, or RI utilization that you want to track with your budget.
    
    BudgetLimit is required for cost or usage budgets, but optional for RI utilization budgets. RI utilization budgets default to the only valid value for RI utilization budgets, which is 100.
  - getBudgetLimit
```
public Spend getBudgetLimit()
```
    The total amount of cost, usage, or RI utilization that you want to track with your budget.
    
    BudgetLimit is required for cost or usage budgets, but optional for RI utilization budgets. RI utilization budgets default to the only valid value for RI utilization budgets, which is 100.
    
    Returns:
    
    The total amount of cost, usage, or RI utilization that you want to track with your budget.
    
    BudgetLimit is required for cost or usage budgets, but optional for RI utilization budgets. RI utilization budgets default to the only valid value for RI utilization budgets, which is 100.
  - withBudgetLimit
```
public Budget withBudgetLimit(Spend budgetLimit)
```
    The total amount of cost, usage, or RI utilization that you want to track with your budget.
    
    BudgetLimit is required for cost or usage budgets, but optional for RI utilization budgets. RI utilization budgets default to the only valid value for RI utilization budgets, which is 100.
    
    Parameters:
    
    budgetLimit - The total amount of cost, usage, or RI utilization that you want to track with your budget.
    
    BudgetLimit is required for cost or usage budgets, but optional for RI utilization budgets. RI utilization budgets default to the only valid value for RI utilization budgets, which is 100.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCostFilters
```
public Map<String,List<String>> getCostFilters()
```
    The cost filters applied to a budget, such as service or region.
    
    Returns:
    
    The cost filters applied to a budget, such as service or region.
  - setCostFilters
```
public void setCostFilters(Map<String,List<String>> costFilters)
```
    The cost filters applied to a budget, such as service or region.
    
    Parameters:
    
    costFilters - The cost filters applied to a budget, such as service or region.
  - withCostFilters
```
public Budget withCostFilters(Map<String,List<String>> costFilters)
```
    The cost filters applied to a budget, such as service or region.
    
    Parameters:
    
    costFilters - The cost filters applied to a budget, such as service or region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addCostFiltersEntry
```
public Budget addCostFiltersEntry(String key,
                                  List<String> value)
```
  - clearCostFiltersEntries
```
public Budget clearCostFiltersEntries()
```
    Removes all the entries added into CostFilters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCostTypes
```
public void setCostTypes(CostTypes costTypes)
```
    The types of costs included in this budget.
    
    Parameters:
    
    costTypes - The types of costs included in this budget.
  - getCostTypes
```
public CostTypes getCostTypes()
```
    The types of costs included in this budget.
    
    Returns:
    
    The types of costs included in this budget.
  - withCostTypes
```
public Budget withCostTypes(CostTypes costTypes)
```
    The types of costs included in this budget.
    
    Parameters:
    
    costTypes - The types of costs included in this budget.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeUnit
```
public void setTimeUnit(String timeUnit)
```
    The length of time until a budget resets the actual and forecasted spend.
    
    Parameters:
    
    timeUnit - The length of time until a budget resets the actual and forecasted spend.
    
    See Also:
    
    TimeUnit
  - getTimeUnit
```
public String getTimeUnit()
```
    The length of time until a budget resets the actual and forecasted spend.
    
    Returns:
    
    The length of time until a budget resets the actual and forecasted spend.
    
    See Also:
    
    TimeUnit
  - withTimeUnit
```
public Budget withTimeUnit(String timeUnit)
```
    The length of time until a budget resets the actual and forecasted spend.
    
    Parameters:
    
    timeUnit - The length of time until a budget resets the actual and forecasted spend.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeUnit
  - setTimeUnit
```
public void setTimeUnit(TimeUnit timeUnit)
```
    The length of time until a budget resets the actual and forecasted spend.
    
    Parameters:
    
    timeUnit - The length of time until a budget resets the actual and forecasted spend.
    
    See Also:
    
    TimeUnit
  - withTimeUnit
```
public Budget withTimeUnit(TimeUnit timeUnit)
```
    The length of time until a budget resets the actual and forecasted spend.
    
    Parameters:
    
    timeUnit - The length of time until a budget resets the actual and forecasted spend.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeUnit
  - setTimePeriod
```
public void setTimePeriod(TimePeriod timePeriod)
```
    The period of time covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.
    
    If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
    
    You can change either date with the UpdateBudget operation.
    
    After the end date, AWS deletes the budget and all associated notifications and subscribers.
    
    Parameters:
    
    timePeriod - The period of time covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.
    
    If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
    
    You can change either date with the UpdateBudget operation.
    
    After the end date, AWS deletes the budget and all associated notifications and subscribers.
  - getTimePeriod
```
public TimePeriod getTimePeriod()
```
    The period of time covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.
    
    If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
    
    You can change either date with the UpdateBudget operation.
    
    After the end date, AWS deletes the budget and all associated notifications and subscribers.
    
    Returns:
    
    The period of time covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.
    
    If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
    
    You can change either date with the UpdateBudget operation.
    
    After the end date, AWS deletes the budget and all associated notifications and subscribers.
  - withTimePeriod
```
public Budget withTimePeriod(TimePeriod timePeriod)
```
    The period of time covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.
    
    If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
    
    You can change either date with the UpdateBudget operation.
    
    After the end date, AWS deletes the budget and all associated notifications and subscribers.
    
    Parameters:
    
    timePeriod - The period of time covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.
    
    If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
    
    You can change either date with the UpdateBudget operation.
    
    After the end date, AWS deletes the budget and all associated notifications and subscribers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCalculatedSpend
```
public void setCalculatedSpend(CalculatedSpend calculatedSpend)
```
    The actual and forecasted cost or usage being tracked by a budget.
    
    Parameters:
    
    calculatedSpend - The actual and forecasted cost or usage being tracked by a budget.
  - getCalculatedSpend
```
public CalculatedSpend getCalculatedSpend()
```
    The actual and forecasted cost or usage being tracked by a budget.
    
    Returns:
    
    The actual and forecasted cost or usage being tracked by a budget.
  - withCalculatedSpend
```
public Budget withCalculatedSpend(CalculatedSpend calculatedSpend)
```
    The actual and forecasted cost or usage being tracked by a budget.
    
    Parameters:
    
    calculatedSpend - The actual and forecasted cost or usage being tracked by a budget.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBudgetType
```
public void setBudgetType(String budgetType)
```
    Whether this budget tracks monetary costs, usage, or RI utilization.
    
    Parameters:
    
    budgetType - Whether this budget tracks monetary costs, usage, or RI utilization.
    
    See Also:
    
    BudgetType
  - getBudgetType
```
public String getBudgetType()
```
    Whether this budget tracks monetary costs, usage, or RI utilization.
    
    Returns:
    
    Whether this budget tracks monetary costs, usage, or RI utilization.
    
    See Also:
    
    BudgetType
  - withBudgetType
```
public Budget withBudgetType(String budgetType)
```
    Whether this budget tracks monetary costs, usage, or RI utilization.
    
    Parameters:
    
    budgetType - Whether this budget tracks monetary costs, usage, or RI utilization.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BudgetType
  - setBudgetType
```
public void setBudgetType(BudgetType budgetType)
```
    Whether this budget tracks monetary costs, usage, or RI utilization.
    
    Parameters:
    
    budgetType - Whether this budget tracks monetary costs, usage, or RI utilization.
    
    See Also:
    
    BudgetType
  - withBudgetType
```
public Budget withBudgetType(BudgetType budgetType)
```
    Whether this budget tracks monetary costs, usage, or RI utilization.
    
    Parameters:
    
    budgetType - Whether this budget tracks monetary costs, usage, or RI utilization.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BudgetType
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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 Budget clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Budget

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Budget

Method Detail

setBudgetName

getBudgetName

withBudgetName

setBudgetLimit

getBudgetLimit

withBudgetLimit

getCostFilters

setCostFilters

withCostFilters

addCostFiltersEntry

clearCostFiltersEntries

setCostTypes

getCostTypes

withCostTypes

setTimeUnit

getTimeUnit

withTimeUnit

setTimeUnit

withTimeUnit

setTimePeriod

getTimePeriod

withTimePeriod

setCalculatedSpend

getCalculatedSpend

withCalculatedSpend

setBudgetType

getBudgetType

withBudgetType

setBudgetType

withBudgetType

toString

equals

hashCode

clone

marshall