Class CreditMemoDetails

java.lang.Object
software.amazon.awssdk.services.payments.model.CreditMemoDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CreditMemoDetails.Builder,CreditMemoDetails>

@Generated("software.amazon.awssdk:codegen") public final class CreditMemoDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CreditMemoDetails.Builder,CreditMemoDetails>

The details of a credit memo: the invoice ID that Amazon Web Services Invoicing issued for it and the billing period that it applies to.

See Also:
  • Method Details

    • invoiceId

      public final String invoiceId()

      The invoice ID that Amazon Web Services Invoicing issued for the credit memo: the document number printed on it, shown in the Amazon Web Services Billing and Cost Management console and returned by the Amazon Web Services Invoicing API as InvoiceId. GetFinancialRecord and BatchGetFinancialRecord also accept it, as invoiceIdentifier.

      Returns:
      The invoice ID that Amazon Web Services Invoicing issued for the credit memo: the document number printed on it, shown in the Amazon Web Services Billing and Cost Management console and returned by the Amazon Web Services Invoicing API as InvoiceId. GetFinancialRecord and BatchGetFinancialRecord also accept it, as invoiceIdentifier.
    • billingPeriod

      public final BillingPeriod billingPeriod()

      The billing period the credit memo applies to: the period of the usage it credits.

      Returns:
      The billing period the credit memo applies to: the period of the usage it credits.
    • toBuilder

      public CreditMemoDetails.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<CreditMemoDetails.Builder,CreditMemoDetails>
      Returns:
      a builder for type T
    • builder

      public static CreditMemoDetails.Builder builder()
    • serializableBuilderClass

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