Class ProcessPaymentRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest
software.amazon.awssdk.services.bedrockagentcore.model.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()
      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<ProcessPaymentRequest.Builder,ProcessPaymentRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreRequest
      Returns:
      a builder for type T

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