Interface SendAgreementPaymentRequestRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SendAgreementPaymentRequestRequest.Builder,SendAgreementPaymentRequestRequest>, MarketplaceAgreementRequest.Builder, SdkBuilder<SendAgreementPaymentRequestRequest.Builder,SendAgreementPaymentRequestRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SendAgreementPaymentRequestRequest
@Mutable @NotThreadSafe public static interface SendAgreementPaymentRequestRequest.Builder extends MarketplaceAgreementRequest.Builder, SdkPojo, CopyableBuilder<SendAgreementPaymentRequestRequest.Builder,SendAgreementPaymentRequestRequest>

  • Method Details

    • clientToken

      SendAgreementPaymentRequestRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agreementId

      SendAgreementPaymentRequestRequest.Builder agreementId(String agreementId)

      The unique identifier of the agreement for which the payment request is being submitted. Use GetAgreementTerms to retrieve agreement term details.

      Parameters:
      agreementId - The unique identifier of the agreement for which the payment request is being submitted. Use GetAgreementTerms to retrieve agreement term details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • termId

      SendAgreementPaymentRequestRequest.Builder termId(String termId)

      The unique identifier of the VariablePaymentTerm for the agreement that the payment request is being sent for.

      Parameters:
      termId - The unique identifier of the VariablePaymentTerm for the agreement that the payment request is being sent for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      SendAgreementPaymentRequestRequest.Builder name(String name)

      A descriptive name for the payment request (5-64 characters).

      Parameters:
      name - A descriptive name for the payment request (5-64 characters).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • chargeAmount

      SendAgreementPaymentRequestRequest.Builder chargeAmount(String chargeAmount)

      The amount requested to be charged to the buyer, positive decimal value in the currency of the accepted term.

      A ValidationException is returned if the chargeAmount exceeds the available balance, if the agreement doesn't have an active VariablePaymentTerm, or if the termId is invalid.

      Parameters:
      chargeAmount - The amount requested to be charged to the buyer, positive decimal value in the currency of the accepted term.

      A ValidationException is returned if the chargeAmount exceeds the available balance, if the agreement doesn't have an active VariablePaymentTerm, or if the termId is invalid.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      SendAgreementPaymentRequestRequest.Builder description(String description)

      An optional detailed description of the payment request (1-2000 characters).

      Parameters:
      description - An optional detailed description of the payment request (1-2000 characters).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      SendAgreementPaymentRequestRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SendAgreementPaymentRequestRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.