Class BudgetSummary

java.lang.Object
software.amazon.awssdk.services.deadline.model.BudgetSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BudgetSummary.Builder,BudgetSummary>
@Generated("software.amazon.awssdk:codegen") public final class BudgetSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BudgetSummary.Builder,BudgetSummary>

The budget summary.

See Also:

  • Method Details

    • budgetId

      public final String budgetId()

      The budget ID.

      Returns:
      The budget ID.

    • usageTrackingResource

      public final UsageTrackingResource usageTrackingResource()

      The resource used to track expenditure in the budget.

      Returns:
      The resource used to track expenditure in the budget.

    • status

      public final BudgetStatus status()

      The status of the budget.

      • ACTIVE–The budget is being evaluated.

      • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

      If the service returns an enum value that is not available in the current SDK version, status will return BudgetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the budget.

      • ACTIVE–The budget is being evaluated.

      • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the budget.

      • ACTIVE–The budget is being evaluated.

      • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

      If the service returns an enum value that is not available in the current SDK version, status will return BudgetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the budget.

      • ACTIVE–The budget is being evaluated.

      • INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

      See Also:

    • displayName

      public final String displayName()

      The display name of the budget summary to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      The display name of the budget summary to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • description

      @Deprecated public final String description()
      Deprecated.
      ListBudgets no longer supports description. Use GetBudget if description is needed.

      The description of the budget summary.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      The description of the budget summary.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

    • approximateDollarLimit

      public final Float approximateDollarLimit()

      The approximate dollar limit of the budget.

      Returns:
      The approximate dollar limit of the budget.

    • usages

      public final ConsumedUsages usages()

      The consumed usage for the budget.

      Returns:
      The consumed usage for the budget.

    • createdBy

      public final String createdBy()

      The user or system that created this resource.

      Returns:
      The user or system that created this resource.

    • createdAt

      public final Instant createdAt()

      The date and time the resource was created.

      Returns:
      The date and time the resource was created.

    • updatedBy

      public final String updatedBy()

      The user or system that updated this resource.

      Returns:
      The user or system that updated this resource.

    • updatedAt

      public final Instant updatedAt()

      The date and time the resource was updated.

      Returns:
      The date and time the resource was updated.

    • toBuilder

      public BudgetSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<BudgetSummary.Builder,BudgetSummary>
      Returns:
      a builder for type T

    • builder

      public static BudgetSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BudgetSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.