Class UpdateBudgetRequest

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

  • Method Details

    • clientToken

      public final String clientToken()

      The unique token which the server uses to recognize retries of the same request.

      Returns:
      The unique token which the server uses to recognize retries of the same request.

    • farmId

      public final String farmId()

      The farm ID of the budget to update.

      Returns:
      The farm ID of the budget to update.

    • budgetId

      public final String budgetId()

      The budget ID to update.

      Returns:
      The budget ID to update.

    • displayName

      public final String displayName()

      The display name of the budget 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 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

      public final String description()

      The description of the budget 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 description of the budget 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.

    • status

      public final BudgetStatus status()

      Updates 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:
      Updates 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()

      Updates 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:
      Updates 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:

    • approximateDollarLimit

      public final Float approximateDollarLimit()

      The dollar limit to update on the budget. Based on consumed usage.

      Returns:
      The dollar limit to update on the budget. Based on consumed usage.

    • hasActionsToAdd

      public final boolean hasActionsToAdd()
      For responses, this returns true if the service returned a value for the ActionsToAdd 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.

    • actionsToAdd

      public final List<BudgetActionToAdd> actionsToAdd()

      The budget actions to add. Budget actions specify what happens when the budget runs out.

      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 hasActionsToAdd() method.

      Returns:
      The budget actions to add. Budget actions specify what happens when the budget runs out.

    • hasActionsToRemove

      public final boolean hasActionsToRemove()
      For responses, this returns true if the service returned a value for the ActionsToRemove 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.

    • actionsToRemove

      public final List<BudgetActionToRemove> actionsToRemove()

      The budget actions to remove from 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 hasActionsToRemove() method.

      Returns:
      The budget actions to remove from the budget.

    • schedule

      public final BudgetSchedule schedule()

      The schedule to update.

      Returns:
      The schedule to update.

    • toBuilder

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

    • builder

      public static UpdateBudgetRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.