Class CryptoX402PaymentInput

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

The input for a crypto X402 payment.

See Also:

  • Method Details

    • version

      public final String version()

      The version of the X402 protocol.

      Returns:
      The version of the X402 protocol.

    • payload

      public final Document payload()

      The X402 payment payload.

      Returns:
      The X402 payment payload.

    • permit2AllowanceLimit

      public final String permit2AllowanceLimit()

      The maximum on-chain Permit2 allowance to grant before signing the payment authorization, in the asset's smallest denomination. This field is valid only for the upto (metered) scheme; supplying it for the exact scheme returns a validation error.

      When set, the service approves an ERC-20 allowance for this amount before processing the payment. The approval sets, rather than adds to, the wallet's allowance. Set this field only when the wallet needs approving, for example on its first upto payment, to avoid a redundant on-chain transaction. Omit the field to skip allowance handling. This is the default, and the only behavior for the exact scheme.

      Returns:
      The maximum on-chain Permit2 allowance to grant before signing the payment authorization, in the asset's smallest denomination. This field is valid only for the upto (metered) scheme; supplying it for the exact scheme returns a validation error.

      When set, the service approves an ERC-20 allowance for this amount before processing the payment. The approval sets, rather than adds to, the wallet's allowance. Set this field only when the wallet needs approving, for example on its first upto payment, to avoid a redundant on-chain transaction. Omit the field to skip allowance handling. This is the default, and the only behavior for the exact scheme.

    • toBuilder

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

    • builder

      public static CryptoX402PaymentInput.Builder builder()

    • serializableBuilderClass

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