Package com.oracle.bmc.budget.model

Class Budget

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190111")
public final class Budget
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    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 Budget.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • builder

        public static Budget.Builder builder()
        Create a new builder.

      • getId

        public String getId()
        The OCID of the budget.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        Returns:
        the value

      • getTargetCompartmentId

        public String getTargetCompartmentId()
        This is DEPRECATED.

        For backwards compatability, the property is populated when the targetType is “COMPARTMENT”, and targets contain the specific target compartment OCID. For all other scenarios, this property will be left empty.

        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The display name of the budget.

        Avoid entering confidential information.

        Returns:
        the value

      • getDescription

        public String getDescription()
        The description of the budget.
        Returns:
        the value

      • getAmount

        public BigDecimal getAmount()
        The amount of the budget expressed in the currency of the customer’s rate card.
        Returns:
        the value

      • getResetPeriod

        public ResetPeriod getResetPeriod()
        The reset period for the budget.
        Returns:
        the value

      • getBudgetProcessingPeriodStartOffset

        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.

        Returns:
        the value

      • getProcessingPeriodType

        public ProcessingPeriodType getProcessingPeriodType()
        The budget processing period type.

        Valid values are INVOICE, MONTH, and SINGLE_USE.

        Returns:
        the value

      • getStartDate

        public Date getStartDate()
        The date when the one-time budget begins.

        For example, 2023-03-23. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.

        Returns:
        the value

      • getEndDate

        public Date getEndDate()
        The time when the one-time budget concludes.

        For example, 2023-03-23. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.

        Returns:
        the value

      • getTargetType

        public TargetType getTargetType()
        The type of target on which the budget is applied.
        Returns:
        the value

      • getTargets

        public List<String> getTargets()
        The list of targets on which the budget is applied.

        If the targetType is “COMPARTMENT”, the targets contain the list of compartment OCIDs. If the targetType is “TAG”, the targets contain the list of cost tracking tag identifiers in the form of “{tagNamespace}.{tagKey}.{tagValue}”.

        Returns:
        the value

      • getLifecycleState

        public LifecycleState getLifecycleState()
        The current state of the budget.
        Returns:
        the value

      • getAlertRuleCount

        public Integer getAlertRuleCount()
        The total number of alert rules in the budget.
        Returns:
        the value

      • getVersion

        public Integer getVersion()
        The version of the budget.

        Starts from 1 and increments by 1.

        Returns:
        the value

      • getActualSpend

        public BigDecimal getActualSpend()
        The actual spend in currency for the current budget cycle.
        Returns:
        the value

      • getForecastedSpend

        public BigDecimal getForecastedSpend()
        The forecasted spend in currency by the end of the current budget cycle.
        Returns:
        the value

      • getTimeSpendComputed

        public Date getTimeSpendComputed()
        The time that the budget spend was last computed.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time that the budget was created.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time that the budget was updated.
        Returns:
        the value

      • getFreeformTags

        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"}

        Returns:
        the value

      • getDefinedTags

        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"}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel