Class GetBudgetResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.deadline.model.DeadlineResponse
software.amazon.awssdk.services.deadline.model.GetBudgetResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetBudgetResponse.Builder,GetBudgetResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetBudgetResponse extends DeadlineResponse implements ToCopyableBuilder<GetBudgetResponse.Builder,GetBudgetResponse>

  • Method Details

    • budgetId

      public final String budgetId()

      The budget ID.

      Returns:
      The budget ID.

    • usageTrackingResource

      public final UsageTrackingResource usageTrackingResource()

      The resource that the budget is tracking usage for.

      Returns:
      The resource that the budget is tracking usage for.

    • status

      public final BudgetStatus status()

      The status of the budget.

      • ACTIVE–Get a budget being evaluated.

      • INACTIVE–Get an inactive budget. This can include expired, canceled, or 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–Get a budget being evaluated.

      • INACTIVE–Get an inactive budget. This can include expired, canceled, or deleted statuses.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the budget.

      • ACTIVE–Get a budget being evaluated.

      • INACTIVE–Get an inactive budget. This can include expired, canceled, or 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–Get a budget being evaluated.

      • INACTIVE–Get an inactive budget. This can include expired, canceled, or deleted statuses.

      See Also:

    • displayName

      public final String displayName()

      The display name of the budget.

      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.

      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

      public final String description()

      The description of the budget.

      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.

      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 consumed usage limit for the budget.

      Returns:
      The consumed usage limit for the budget.

    • usages

      public final ConsumedUsages usages()

      The usages of the budget.

      Returns:
      The usages of the budget.

    • hasActions

      public final boolean hasActions()
      For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • actions

      public final List<ResponseBudgetAction> actions()

      The budget actions for the budget.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActions() method.

      Returns:
      The budget actions for the budget.

    • schedule

      public final BudgetSchedule schedule()

      The budget schedule.

      Returns:
      The budget schedule.

    • 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.

    • queueStoppedAt

      public final Instant queueStoppedAt()

      The date and time the queue stopped.

      Returns:
      The date and time the queue stopped.

    • toBuilder

      public GetBudgetResponse.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<GetBudgetResponse.Builder,GetBudgetResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetBudgetResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.