Class ProcessPaymentResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ProcessPaymentResponse.Builder,ProcessPaymentResponse>

@Generated("software.amazon.awssdk:codegen") public final class ProcessPaymentResponse extends BedrockAgentCoreResponse implements ToCopyableBuilder<ProcessPaymentResponse.Builder,ProcessPaymentResponse>

Response structure for processing a payment.

  • Method Details

    • processPaymentId

      public final String processPaymentId()

      The unique identifier of the processed payment.

      Returns:
      The unique identifier of the processed payment.
    • paymentManagerArn

      public final String paymentManagerArn()

      The ARN of the payment manager.

      Returns:
      The ARN of the payment manager.
    • paymentSessionId

      public final String paymentSessionId()

      The ID of the payment session used.

      Returns:
      The ID of the payment session used.
    • paymentInstrumentId

      public final String paymentInstrumentId()

      The ID of the payment instrument used.

      Returns:
      The ID of the payment instrument used.
    • paymentType

      public final PaymentType paymentType()

      The type of payment processed.

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

      Returns:
      The type of payment processed.
      See Also:
    • paymentTypeAsString

      public final String paymentTypeAsString()

      The type of payment processed.

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

      Returns:
      The type of payment processed.
      See Also:
    • status

      public final PaymentStatus status()

      The status of the payment.

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

      Returns:
      The status of the payment.
      See Also:
    • statusAsString

      public final String statusAsString()

      The status of the payment.

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

      Returns:
      The status of the payment.
      See Also:
    • paymentOutput

      public final PaymentOutput paymentOutput()

      The payment output details specific to the payment type.

      Returns:
      The payment output details specific to the payment type.
    • createdAt

      public final Instant createdAt()

      The timestamp when the payment was created.

      Returns:
      The timestamp when the payment was created.
    • updatedAt

      public final Instant updatedAt()

      The timestamp when the payment was last updated.

      Returns:
      The timestamp when the payment was last updated.
    • toBuilder

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

      public static ProcessPaymentResponse.Builder builder()
    • serializableBuilderClass

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