@Generated(value="OracleSDKGenerator", comments="API Version: 20190111") public final class Budget extends Object
A budget.
Note: Objects should always be created or deserialized using the Budget.Builder. This model distinguishes fields
that are null because they are unset from fields that are explicitly set to null. This is done in
the setter methods of the Budget.Builder, which maintain a set of all explicitly set fields called
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Budget.Builder |
| Constructor and Description |
|---|
Budget(String id,
String compartmentId,
String targetCompartmentId,
String displayName,
String description,
BigDecimal amount,
ResetPeriod resetPeriod,
Integer budgetProcessingPeriodStartOffset,
TargetType targetType,
List<String> targets,
LifecycleState lifecycleState,
Integer alertRuleCount,
Integer version,
BigDecimal actualSpend,
BigDecimal forecastedSpend,
Date timeSpendComputed,
Date timeCreated,
Date timeUpdated,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Budget.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
BigDecimal |
getActualSpend()
The actual spend in currency for the current budget cycle
|
Integer |
getAlertRuleCount()
Total number of alert rules in the budget
|
BigDecimal |
getAmount()
The amount of the budget expressed in the currency of the customer’s rate card.
|
Integer |
getBudgetProcessingPeriodStartOffset()
The number of days offset from the first day of the month, at which the budget processing period starts.
|
String |
getCompartmentId()
The OCID of the compartment
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description of the budget.
|
String |
getDisplayName()
The display name of the budget.
|
BigDecimal |
getForecastedSpend()
The forecasted spend in currency by the end of the current budget cycle
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the budget
|
LifecycleState |
getLifecycleState()
The current state of the budget.
|
ResetPeriod |
getResetPeriod()
The reset period for the budget.
|
String |
getTargetCompartmentId()
This is DEPRECATED.
|
List<String> |
getTargets()
The list of targets on which the budget is applied.
|
TargetType |
getTargetType()
The type of target on which the budget is applied.
|
Date |
getTimeCreated()
Time that budget was created
|
Date |
getTimeSpendComputed()
The time that the budget spend was last computed
|
Date |
getTimeUpdated()
Time that budget was updated
|
Integer |
getVersion()
Version of the budget.
|
int |
hashCode() |
Budget.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"id","compartmentId","targetCompartmentId","displayName","description","amount","resetPeriod","budgetProcessingPeriodStartOffset","targetType","targets","lifecycleState","alertRuleCount","version","actualSpend","forecastedSpend","timeSpendComputed","timeCreated","timeUpdated","freeformTags","definedTags"}) @Deprecated public Budget(String id, String compartmentId, String targetCompartmentId, String displayName, String description, BigDecimal amount, ResetPeriod resetPeriod, Integer budgetProcessingPeriodStartOffset, TargetType targetType, List<String> targets, LifecycleState lifecycleState, Integer alertRuleCount, Integer version, BigDecimal actualSpend, BigDecimal forecastedSpend, Date timeSpendComputed, Date timeCreated, Date timeUpdated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static Budget.Builder builder()
Create a new builder.
public Budget.Builder toBuilder()
public String getId()
The OCID of the budget
public String getCompartmentId()
The OCID of the compartment
public String getTargetCompartmentId()
This is DEPRECATED. For backwards compatability, the property will be populated when targetType is "COMPARTMENT" AND targets contains EXACT ONE target compartment ocid. For all other scenarios, this property will be left empty.
public String getDisplayName()
The display name of the budget.
public String getDescription()
The description of the budget.
public BigDecimal getAmount()
The amount of the budget expressed in the currency of the customer’s rate card.
public ResetPeriod getResetPeriod()
The reset period for the budget.
public Integer getBudgetProcessingPeriodStartOffset()
The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.
public TargetType getTargetType()
The type of target on which the budget is applied.
public List<String> getTargets()
The list of targets on which the budget is applied. If targetType is "COMPARTMENT", targets contains list of compartment OCIDs. If targetType is "TAG", targets contains list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".
public LifecycleState getLifecycleState()
The current state of the budget.
public Integer getAlertRuleCount()
Total number of alert rules in the budget
public Integer getVersion()
Version of the budget. Starts from 1 and increments by 1.
public BigDecimal getActualSpend()
The actual spend in currency for the current budget cycle
public BigDecimal getForecastedSpend()
The forecasted spend in currency by the end of the current budget cycle
public Date getTimeSpendComputed()
The time that the budget spend was last computed
public Date getTimeCreated()
Time that budget was created
public Date getTimeUpdated()
Time that budget was updated
public Map<String,String> getFreeformTags()
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{\"Department\": \"Finance\"}`
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
Copyright © 2016–2021. All rights reserved.