Class DescribeBudgetsRequest

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

Request of DescribeBudgets

  • Method Details

    • accountId

      public final String accountId()

      The accountId that is associated with the budgets that you want to describe.

      Returns:
      The accountId that is associated with the budgets that you want to describe.

    • maxResults

      public final Integer maxResults()

      An integer that represents how many budgets a paginated response contains. The default is 100.

      Returns:
      An integer that represents how many budgets a paginated response contains. The default is 100.

    • nextToken

      public final String nextToken()

      The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

      Returns:
      The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

    • showFilterExpression

      public final Boolean showFilterExpression()

      Specifies whether the response includes the filter expression associated with the budgets. By showing the filter expression, you can see detailed filtering logic applied to the budgets, such as Amazon Web Services services or tags that are being tracked.

      Returns:
      Specifies whether the response includes the filter expression associated with the budgets. By showing the filter expression, you can see detailed filtering logic applied to the budgets, such as Amazon Web Services services or tags that are being tracked.

    • toBuilder

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

    • builder

      public static DescribeBudgetsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeBudgetsRequest.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.