Class GetCreditsRequest

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

  • Method Details

    • accountId

      public final String accountId()

      The Amazon Web Services account ID. Must be a 12-digit numeric string.

      Returns:
      The Amazon Web Services account ID. Must be a 12-digit numeric string.

    • startDate

      public final Instant startDate()

      The start date for the credit period as Unix epoch seconds. Must be a past date that is not more than one year before the current date.

      Returns:
      The start date for the credit period as Unix epoch seconds. Must be a past date that is not more than one year before the current date.

    • endDate

      public final Instant endDate()

      The end date for the credit period as Unix epoch seconds. Must not be a future date and must be on or after startDate. Defaults to the current date when omitted.

      Returns:
      The end date for the credit period as Unix epoch seconds. Must not be a future date and must be on or after startDate. Defaults to the current date when omitted.

    • payerAccountFlag

      public final Boolean payerAccountFlag()

      When true and the caller is the management account, the response aggregates credits across the entire consolidated billing family. When false or omitted, returns only credits for the specified accountId.

      Returns:
      When true and the caller is the management account, the response aggregates credits across the entire consolidated billing family. When false or omitted, returns only credits for the specified accountId.

    • toBuilder

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

    • builder

      public static GetCreditsRequest.Builder builder()

    • serializableBuilderClass

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