Class PaymentRequestSummary

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

Summary view of a payment request.

See Also:

  • Method Details

    • paymentRequestId

      public final String paymentRequestId()

      The unique identifier of the payment request.

      Returns:
      The unique identifier of the payment request.

    • agreementId

      public final String agreementId()

      The unique identifier of the agreement associated with this payment request.

      Returns:
      The unique identifier of the agreement associated with this payment request.

    • status

      public final PaymentRequestStatus status()

      The current status of the payment request. Possible values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED.

      If the service returns an enum value that is not available in the current SDK version, status will return PaymentRequestStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the payment request. Possible values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the payment request. Possible values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED.

      If the service returns an enum value that is not available in the current SDK version, status will return PaymentRequestStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the payment request. Possible values include VALIDATING, VALIDATION_FAILED, PENDING_APPROVAL, APPROVED, REJECTED, and CANCELLED.
      See Also:

    • name

      public final String name()

      The descriptive name of the payment request.

      Returns:
      The descriptive name of the payment request.

    • chargeId

      public final String chargeId()

      The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests.

      Returns:
      The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests.

    • chargeAmount

      public final String chargeAmount()

      The amount charged or to be charged to the buyer.

      Returns:
      The amount charged or to be charged to the buyer.

    • currencyCode

      public final String currencyCode()

      The currency code for the charge amount.

      Returns:
      The currency code for the charge amount.

    • createdAt

      public final Instant createdAt()

      The date and time when the payment request was created, in ISO 8601 format.

      Returns:
      The date and time when the payment request was created, in ISO 8601 format.

    • updatedAt

      public final Instant updatedAt()

      The date and time when the payment request was last updated, in ISO 8601 format.

      Returns:
      The date and time when the payment request was last updated, in ISO 8601 format.

    • toBuilder

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

    • builder

      public static PaymentRequestSummary.Builder builder()

    • serializableBuilderClass

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