Interface CreateAgreementRequestRequest.Builder

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

  • Method Details

    • clientToken

      CreateAgreementRequestRequest.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.

    • intent

      CreateAgreementRequestRequest.Builder intent(String intent)

      The purpose and desired outcome of the agreement request. This is a required parameter that determines how the agreement request is processed.

      • NEW – Creates a new agreement for terms in the request.

      • AMEND – Modifies an existing agreement with terms that are accepted in the request.

      • REPLACE – Creates a new agreement with accepted terms and replaces the existing agreement.

      Parameters:
      intent - The purpose and desired outcome of the agreement request. This is a required parameter that determines how the agreement request is processed.

      • NEW – Creates a new agreement for terms in the request.

      • AMEND – Modifies an existing agreement with terms that are accepted in the request.

      • REPLACE – Creates a new agreement with accepted terms and replaces the existing agreement.

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

    • intent

      CreateAgreementRequestRequest.Builder intent(Intent intent)

      The purpose and desired outcome of the agreement request. This is a required parameter that determines how the agreement request is processed.

      • NEW – Creates a new agreement for terms in the request.

      • AMEND – Modifies an existing agreement with terms that are accepted in the request.

      • REPLACE – Creates a new agreement with accepted terms and replaces the existing agreement.

      Parameters:
      intent - The purpose and desired outcome of the agreement request. This is a required parameter that determines how the agreement request is processed.

      • NEW – Creates a new agreement for terms in the request.

      • AMEND – Modifies an existing agreement with terms that are accepted in the request.

      • REPLACE – Creates a new agreement with accepted terms and replaces the existing agreement.

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

    • requestedTerms

      CreateAgreementRequestRequest.Builder requestedTerms(Collection<RequestedTerm> requestedTerms)

      A list of terms that define what is being accepted as part of the agreement. Some terms require configuration.

      Parameters:
      requestedTerms - A list of terms that define what is being accepted as part of the agreement. Some terms require configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestedTerms

      CreateAgreementRequestRequest.Builder requestedTerms(RequestedTerm... requestedTerms)

      A list of terms that define what is being accepted as part of the agreement. Some terms require configuration.

      Parameters:
      requestedTerms - A list of terms that define what is being accepted as part of the agreement. Some terms require configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestedTerms

      CreateAgreementRequestRequest.Builder requestedTerms(Consumer<RequestedTerm.Builder>... requestedTerms)

      A list of terms that define what is being accepted as part of the agreement. Some terms require configuration.

      This is a convenience method that creates an instance of the RequestedTerm.Builder avoiding the need to create one manually via RequestedTerm.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to requestedTerms(List<RequestedTerm>).

      Parameters:
      requestedTerms - a consumer that will call methods on RequestedTerm.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceAgreementIdentifier

      CreateAgreementRequestRequest.Builder sourceAgreementIdentifier(String sourceAgreementIdentifier)

      The agreement's identifier that the request acts upon.

      This parameter is required for all non-NEW intents (i.e., AMEND or REPLACE). Don't provide this parameter if the intent is NEW.

      Parameters:
      sourceAgreementIdentifier - The agreement's identifier that the request acts upon.

      This parameter is required for all non-NEW intents (i.e., AMEND or REPLACE). Don't provide this parameter if the intent is NEW.

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

    • agreementProposalIdentifier

      CreateAgreementRequestRequest.Builder agreementProposalIdentifier(String agreementProposalIdentifier)

      The agreement proposal signed by the proposer. The proposal includes the requested resources and the terms that outline an agreement outcome.

      This parameter is required if the intent is not AMEND.

      Parameters:
      agreementProposalIdentifier - The agreement proposal signed by the proposer. The proposal includes the requested resources and the terms that outline an agreement outcome.

      This parameter is required if the intent is not AMEND.

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

    • taxConfiguration

      CreateAgreementRequestRequest.Builder taxConfiguration(TaxConfiguration taxConfiguration)

      Configuration for tax estimation in the agreement request response.

      Parameters:
      taxConfiguration - Configuration for tax estimation in the agreement request response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taxConfiguration

      default CreateAgreementRequestRequest.Builder taxConfiguration(Consumer<TaxConfiguration.Builder> taxConfiguration)

      Configuration for tax estimation in the agreement request response.

      This is a convenience method that creates an instance of the TaxConfiguration.Builder avoiding the need to create one manually via TaxConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to taxConfiguration(TaxConfiguration).

      Parameters:
      taxConfiguration - a consumer that will call methods on TaxConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateAgreementRequestRequest.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

      CreateAgreementRequestRequest.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.