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 — the same wallet address may hold different token balances on different chains.

      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 — the same wallet address may hold different token balances on different chains.
      See Also:

    • chainAsString

      public final String chainAsString()

      The specific blockchain chain to query balance on. Required because balances are chain-specific — the same wallet address may hold different token balances on different chains.

      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 — the same wallet address may hold different token balances on different chains.
      See Also:

    • token

      public final InstrumentBalanceToken token()

      The token to query balance for. Required to specify which supported token's balance to return.

      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. Required to specify which supported token's balance to return.
      See Also:

    • tokenAsString

      public final String tokenAsString()

      The token to query balance for. Required to specify which supported token's balance to return.

      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. Required to specify which supported token's balance to return.
      See Also:

    • toBuilder

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

    • 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)
      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.