BudgetInner Class

public final class BudgetInner
extends ProxyResource

A budget resource.

Constructor Summary

Constructor Description
BudgetInner()

Method Summary

Modifier and Type Method and Description
BigDecimal amount()

Get the amount property: The total amount of cost to track with the budget.

CategoryType category()

Get the category property: The category of the budget, whether the budget tracks cost or usage.

CurrentSpend currentSpend()

Get the currentSpend property: The current amount of cost which is being tracked for a budget.

String etag()

Get the etag property: eTag of the resource.

BudgetFilter filter()

Get the filter property: May be used to filter budgets by user-specified dimensions and/or tags.

ForecastSpend forecastSpend()

Get the forecastSpend property: The forecasted cost which is being tracked for a budget.

Map<String,Notification> notifications()

Get the notifications property: Dictionary of notifications associated with the budget.

TimeGrainType timeGrain()

Get the timeGrain property: The time covered by a budget.

BudgetTimePeriod timePeriod()

Get the timePeriod property: Has start and end date of the budget.

void validate()

Validates the instance.

BudgetInner withAmount(BigDecimal amount)

Set the amount property: The total amount of cost to track with the budget.

BudgetInner withCategory(CategoryType category)

Set the category property: The category of the budget, whether the budget tracks cost or usage.

BudgetInner withEtag(String etag)

Set the etag property: eTag of the resource.

BudgetInner withFilter(BudgetFilter filter)

Set the filter property: May be used to filter budgets by user-specified dimensions and/or tags.

BudgetInner withNotifications(Map<String,Notification> notifications)

Set the notifications property: Dictionary of notifications associated with the budget.

BudgetInner withTimeGrain(TimeGrainType timeGrain)

Set the timeGrain property: The time covered by a budget.

BudgetInner withTimePeriod(BudgetTimePeriod timePeriod)

Set the timePeriod property: Has start and end date of the budget.

Methods inherited from ProxyResource

Methods inherited from java.lang.Object

Constructor Details

BudgetInner

public BudgetInner()

Method Details

amount

public BigDecimal amount()

Get the amount property: The total amount of cost to track with the budget.

Returns:

the amount value.

category

public CategoryType category()

Get the category property: The category of the budget, whether the budget tracks cost or usage.

Returns:

the category value.

currentSpend

public CurrentSpend currentSpend()

Get the currentSpend property: The current amount of cost which is being tracked for a budget.

Returns:

the currentSpend value.

etag

public String etag()

Get the etag property: eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.

Returns:

the etag value.

filter

public BudgetFilter filter()

Get the filter property: May be used to filter budgets by user-specified dimensions and/or tags.

Returns:

the filter value.

forecastSpend

public ForecastSpend forecastSpend()

Get the forecastSpend property: The forecasted cost which is being tracked for a budget.

Returns:

the forecastSpend value.

notifications

public Map notifications()

Get the notifications property: Dictionary of notifications associated with the budget. Budget can have up to five notifications.

Returns:

the notifications value.

timeGrain

public TimeGrainType timeGrain()

Get the timeGrain property: The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers.

Returns:

the timeGrain value.

timePeriod

public BudgetTimePeriod timePeriod()

Get the timePeriod property: Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.

Returns:

the timePeriod value.

validate

public void validate()

Validates the instance.

withAmount

public BudgetInner withAmount(BigDecimal amount)

Set the amount property: The total amount of cost to track with the budget.

Parameters:

amount - the amount value to set.

Returns:

the BudgetInner object itself.

withCategory

public BudgetInner withCategory(CategoryType category)

Set the category property: The category of the budget, whether the budget tracks cost or usage.

Parameters:

category - the category value to set.

Returns:

the BudgetInner object itself.

withEtag

public BudgetInner withEtag(String etag)

Set the etag property: eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.

Parameters:

etag - the etag value to set.

Returns:

the BudgetInner object itself.

withFilter

public BudgetInner withFilter(BudgetFilter filter)

Set the filter property: May be used to filter budgets by user-specified dimensions and/or tags.

Parameters:

filter - the filter value to set.

Returns:

the BudgetInner object itself.

withNotifications

public BudgetInner withNotifications(Map notifications)

Set the notifications property: Dictionary of notifications associated with the budget. Budget can have up to five notifications.

Parameters:

notifications - the notifications value to set.

Returns:

the BudgetInner object itself.

withTimeGrain

public BudgetInner withTimeGrain(TimeGrainType timeGrain)

Set the timeGrain property: The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers.

Parameters:

timeGrain - the timeGrain value to set.

Returns:

the BudgetInner object itself.

withTimePeriod

public BudgetInner withTimePeriod(BudgetTimePeriod timePeriod)

Set the timePeriod property: Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.

Parameters:

timePeriod - the timePeriod value to set.

Returns:

the BudgetInner object itself.

Applies to