Class MppPaymentInput

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

Contains the payment challenge from a 402 Payment Required response. Forward the raw WWW-Authenticate: Payment header value verbatim. In response, you receive a payment credential that satisfies the challenge. Provide exactly one challenge per request.

See Also:

  • Method Details

    • version

      public final String version()

      The MPP protocol version, for example "1" or "2".

      Returns:
      The MPP protocol version, for example "1" or "2".

    • hasWwwAuthenticateHeaders

      public final boolean hasWwwAuthenticateHeaders()
      For responses, this returns true if the service returned a value for the WwwAuthenticateHeaders property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • wwwAuthenticateHeaders

      public final List<String> wwwAuthenticateHeaders()

      The raw WWW-Authenticate: Payment header value from the 402 response, passed verbatim. Provide exactly one entry. The service uses this value to generate the payment credential.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWwwAuthenticateHeaders() method.

      Returns:
      The raw WWW-Authenticate: Payment header value from the 402 response, passed verbatim. Provide exactly one entry. The service uses this value to generate the payment credential.

    • buyerPaysGasFees

      public final Boolean buyerPaysGasFees()

      Authorizes the service to sign a payment whose blockchain network (gas) fees are charged to your wallet, on top of the payment amount.

      The challenge indicates who sponsors the network fees. When the challenge does not sponsor them, the service signs the payment only if this field is true. Otherwise it returns a validation error, so you can decide whether to pay the fees or obtain a challenge that sponsors them.

      Optional. When omitted or false, you decline to pay network fees. This field has no effect on challenges that already sponsor the fees.

      Returns:
      Authorizes the service to sign a payment whose blockchain network (gas) fees are charged to your wallet, on top of the payment amount.

      The challenge indicates who sponsors the network fees. When the challenge does not sponsor them, the service signs the payment only if this field is true. Otherwise it returns a validation error, so you can decide whether to pay the fees or obtain a challenge that sponsors them.

      Optional. When omitted or false, you decline to pay network fees. This field has no effect on challenges that already sponsor the fees.

    • toBuilder

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

    • builder

      public static MppPaymentInput.Builder builder()

    • serializableBuilderClass

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