Class ChargeSummary

java.lang.Object
software.amazon.awssdk.services.marketplaceagreement.model.ChargeSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ChargeSummary.Builder,ChargeSummary>
@Generated("software.amazon.awssdk:codegen") public final class ChargeSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ChargeSummary.Builder,ChargeSummary>

The ChargeSummary provides a detailed breakdown of charges that are associated with an agreement request. This is applicable only when a request is created for a PurchaseAgreement.

Tax and invoicing fields (such as estimatedTaxes, amountAfterTax, newAgreementValueAfterTax, and invoicingEntity) are returned on a best-effort basis and do not cause the request to fail if unavailable.

A null tax amount can have two meanings:

  • Tax estimation was unavailable at the time of the request.

  • The charge timing is BILLING_PERIOD, so the charge amount is not determined at request time. In this case, the tax breakdown may still include the tax rate and type.

See Also:

  • Method Details

    • currencyCode

      public final String currencyCode()

      The three-letter currency code for all charges (e.g., USD).

      Returns:
      The three-letter currency code for all charges (e.g., USD).

    • newAgreementValue

      public final String newAgreementValue()

      The total value of the agreement, which includes any amendments.

      Returns:
      The total value of the agreement, which includes any amendments.

    • newAgreementValueAfterTax

      public final String newAgreementValueAfterTax()

      Expected new agreement value after estimated taxes are applied.

      Returns:
      Expected new agreement value after estimated taxes are applied.

    • hasExpectedCharges

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

    • expectedCharges

      public final List<ExpectedCharge> expectedCharges()

      A list of expected charges for the agreement request.

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

      Returns:
      A list of expected charges for the agreement request.

    • estimatedTaxes

      public final EstimatedTaxes estimatedTaxes()

      Provides an aggregated view of estimated tax information for the agreement.

      Returns:
      Provides an aggregated view of estimated tax information for the agreement.

    • hasItemizedCharges

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

    • itemizedCharges

      public final List<ItemizedCharge> itemizedCharges()

      An itemized list of charges for the agreement request.

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

      Returns:
      An itemized list of charges for the agreement request.

    • invoicingEntity

      public final InvoicingEntity invoicingEntity()

      The entity responsible for issuing the invoice.

      Returns:
      The entity responsible for issuing the invoice.

    • toBuilder

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

    • builder

      public static ChargeSummary.Builder builder()

    • serializableBuilderClass

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