Class CreatePaymentInstrumentRequest

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.CreatePaymentInstrumentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePaymentInstrumentRequest.Builder,CreatePaymentInstrumentRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePaymentInstrumentRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<CreatePaymentInstrumentRequest.Builder,CreatePaymentInstrumentRequest>

Request structure for creating a payment instrument

  • Method Details

    • userId

      public final String userId()

      The user ID associated with this payment instrument.

      Returns:
      The user ID associated with this payment instrument.

    • 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 that owns this payment instrument.

      Returns:
      The ARN of the payment manager that owns this payment instrument.

    • paymentConnectorId

      public final String paymentConnectorId()

      The ID of the payment connector to use for this instrument.

      Returns:
      The ID of the payment connector to use for this instrument.

    • paymentInstrumentType

      public final PaymentInstrumentType paymentInstrumentType()

      The type of payment instrument being created.

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

      Returns:
      The type of payment instrument being created.
      See Also:

    • paymentInstrumentTypeAsString

      public final String paymentInstrumentTypeAsString()

      The type of payment instrument being created.

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

      Returns:
      The type of payment instrument being created.
      See Also:

    • paymentInstrumentDetails

      public final PaymentInstrumentDetails paymentInstrumentDetails()

      The details of the payment instrument.

      Returns:
      The details of the payment instrument.

    • clientToken

      public final String clientToken()

      Idempotency token to ensure request uniqueness.

      Returns:
      Idempotency token to ensure request uniqueness.

    • toBuilder

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

    • builder

      public static CreatePaymentInstrumentRequest.Builder builder()

    • serializableBuilderClass

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