Class CancelAgreementPaymentRequestResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.marketplaceagreement.model.MarketplaceAgreementResponse
software.amazon.awssdk.services.marketplaceagreement.model.CancelAgreementPaymentRequestResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CancelAgreementPaymentRequestResponse.Builder,CancelAgreementPaymentRequestResponse>
@Generated("software.amazon.awssdk:codegen") public final class CancelAgreementPaymentRequestResponse extends MarketplaceAgreementResponse implements ToCopyableBuilder<CancelAgreementPaymentRequestResponse.Builder,CancelAgreementPaymentRequestResponse>

  • Method Details

    • paymentRequestId

      public final String paymentRequestId()

      The unique identifier of the cancelled payment request.

      Returns:
      The unique identifier of the cancelled 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 updated status of the payment request, which is 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 updated status of the payment request, which is CANCELLED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The updated status of the payment request, which is 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 updated status of the payment request, which is CANCELLED.
      See Also:

    • name

      public final String name()

      The descriptive name of the payment request.

      Returns:
      The descriptive name of the payment request.

    • description

      public final String description()

      The detailed description of the payment request, if provided.

      Returns:
      The detailed description of the payment request, if provided.

    • chargeAmount

      public final String chargeAmount()

      The amount that was requested to be charged.

      Returns:
      The amount that was requested to be charged.

    • 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 originally created, in ISO 8601 format.

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

    • updatedAt

      public final Instant updatedAt()

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

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

    • toBuilder

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

    • builder

      public static CancelAgreementPaymentRequestResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CancelAgreementPaymentRequestResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.