Class ProcessPaymentRequest

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

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

Request structure for processing a payment.

  • Method Details

    • userId

      public final String userId()

      The user ID associated with this payment.

      Returns:
      The user ID associated with this payment.
    • agentName

      public final String agentName()

      The agent name associated with this request, used for observability.

      Returns:
      The agent name associated with this request, used for observability.
    • 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.

      Returns:
      The ID of the payment session.
    • paymentInstrumentId

      public final String paymentInstrumentId()

      The ID of the payment instrument to use.

      Returns:
      The ID of the payment instrument to use.
    • paymentType

      public final PaymentType paymentType()

      The type of payment to process.

      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 to process.
      See Also:
    • paymentTypeAsString

      public final String paymentTypeAsString()

      The type of payment to process.

      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 to process.
      See Also:
    • paymentInput

      public final PaymentInput paymentInput()

      The payment input details specific to the payment type.

      Returns:
      The payment input details specific to the payment type.
    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    • toBuilder

      public ProcessPaymentRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ProcessPaymentRequest.Builder,ProcessPaymentRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreRequest
    • builder

      public static ProcessPaymentRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ProcessPaymentRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo
    • 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)
      Overrides:
      getValueForField in class SdkRequest
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo