Package software.amazon.awssdk.services.bedrockagentcore.model

Class GetPaymentInstrumentBalanceRequest

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

Request structure for getting payment instrument balance.

  • 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 associated with this instrument.

      Returns:
      The ID of the payment connector associated with this instrument.

    • paymentInstrumentId

      public final String paymentInstrumentId()

      The ID of the payment instrument to query balance for.

      Returns:
      The ID of the payment instrument to query balance for.

    • chain

      public final BlockchainChainId chain()

      The specific blockchain chain to query balance on. Required because balances are chain-specific.

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

      Returns:
      The specific blockchain chain to query balance on. Required because balances are chain-specific.
      See Also:

    • chainAsString

      public final String chainAsString()

      The specific blockchain chain to query balance on. Required because balances are chain-specific.

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

      Returns:
      The specific blockchain chain to query balance on. Required because balances are chain-specific.
      See Also:

    • token

      public final InstrumentBalanceToken token()

      The token to query balance for. Only tokens supported for X402 payments are returned.

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

      Returns:
      The token to query balance for. Only tokens supported for X402 payments are returned.
      See Also:

    • tokenAsString

      public final String tokenAsString()

      The token to query balance for. Only tokens supported for X402 payments are returned.

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

      Returns:
      The token to query balance for. Only tokens supported for X402 payments are returned.
      See Also:

    • toBuilder

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

    • builder

      public static GetPaymentInstrumentBalanceRequest.Builder builder()

    • serializableBuilderClass

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