Interface DescribeAgreementResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeAgreementResponse.Builder,DescribeAgreementResponse>, MarketplaceAgreementResponse.Builder, SdkBuilder<DescribeAgreementResponse.Builder,DescribeAgreementResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeAgreementResponse
@Mutable @NotThreadSafe public static interface DescribeAgreementResponse.Builder extends MarketplaceAgreementResponse.Builder, SdkPojo, CopyableBuilder<DescribeAgreementResponse.Builder,DescribeAgreementResponse>

  • Method Details

    • agreementId

      DescribeAgreementResponse.Builder agreementId(String agreementId)

      The unique identifier of the agreement.

      Parameters:
      agreementId - The unique identifier of the agreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceptor

      DescribeAgreementResponse.Builder acceptor(Acceptor acceptor)

      The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

      Parameters:
      acceptor - The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceptor

      default DescribeAgreementResponse.Builder acceptor(Consumer<Acceptor.Builder> acceptor)

      The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

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

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

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

    • proposer

      DescribeAgreementResponse.Builder proposer(Proposer proposer)

      The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.

      Parameters:
      proposer - The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • proposer

      default DescribeAgreementResponse.Builder proposer(Consumer<Proposer.Builder> proposer)

      The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.

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

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

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

    • startTime

      DescribeAgreementResponse.Builder startTime(Instant startTime)

      The date and time when the agreement starts.

      Parameters:
      startTime - The date and time when the agreement starts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      DescribeAgreementResponse.Builder endTime(Instant endTime)

      The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.

      Parameters:
      endTime - The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceptanceTime

      DescribeAgreementResponse.Builder acceptanceTime(Instant acceptanceTime)

      The date and time the offer was accepted or the agreement was created.

      AcceptanceTime and StartTime can differ for future dated agreements (FDAs).

      Parameters:
      acceptanceTime - The date and time the offer was accepted or the agreement was created.

      AcceptanceTime and StartTime can differ for future dated agreements (FDAs).

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

    • agreementType

      DescribeAgreementResponse.Builder agreementType(String agreementType)

      The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.

      Parameters:
      agreementType - The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • estimatedCharges

      DescribeAgreementResponse.Builder estimatedCharges(EstimatedCharges estimatedCharges)

      The estimated cost of the agreement.

      Parameters:
      estimatedCharges - The estimated cost of the agreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • estimatedCharges

      default DescribeAgreementResponse.Builder estimatedCharges(Consumer<EstimatedCharges.Builder> estimatedCharges)

      The estimated cost of the agreement.

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

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

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

    • proposalSummary

      DescribeAgreementResponse.Builder proposalSummary(ProposalSummary proposalSummary)

      A summary of the proposal received from the proposer.

      Parameters:
      proposalSummary - A summary of the proposal received from the proposer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • proposalSummary

      default DescribeAgreementResponse.Builder proposalSummary(Consumer<ProposalSummary.Builder> proposalSummary)

      A summary of the proposal received from the proposer.

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

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

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

    • status

      DescribeAgreementResponse.Builder status(String status)

      The current status of the agreement.

      Statuses include:

      • ACTIVE – The terms of the agreement are active.

      • CANCELLED – The acceptor ended the agreement before the defined end date.

      • EXPIRED – The agreement ended on the defined end date.

      • RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).

      • REPLACED – The agreement was replaced using an agreement replacement offer.

      • TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).

      Parameters:
      status - The current status of the agreement.

      Statuses include:

      • ACTIVE – The terms of the agreement are active.

      • CANCELLED – The acceptor ended the agreement before the defined end date.

      • EXPIRED – The agreement ended on the defined end date.

      • RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).

      • REPLACED – The agreement was replaced using an agreement replacement offer.

      • TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).

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

    • status

      DescribeAgreementResponse.Builder status(AgreementStatus status)

      The current status of the agreement.

      Statuses include:

      • ACTIVE – The terms of the agreement are active.

      • CANCELLED – The acceptor ended the agreement before the defined end date.

      • EXPIRED – The agreement ended on the defined end date.

      • RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).

      • REPLACED – The agreement was replaced using an agreement replacement offer.

      • TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).

      Parameters:
      status - The current status of the agreement.

      Statuses include:

      • ACTIVE – The terms of the agreement are active.

      • CANCELLED – The acceptor ended the agreement before the defined end date.

      • EXPIRED – The agreement ended on the defined end date.

      • RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).

      • REPLACED – The agreement was replaced using an agreement replacement offer.

      • TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).

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

    • initialAgreementId

      DescribeAgreementResponse.Builder initialAgreementId(String initialAgreementId)

      The unique identifier of the very first agreement in a chain of related agreements, such as renewals or replacements. It stays the same across all agreements in that chain, which lets you trace an agreement back to the original. When an agreement isn't derived from another agreement, its InitialAgreementId is its own AgreementId.

      Parameters:
      initialAgreementId - The unique identifier of the very first agreement in a chain of related agreements, such as renewals or replacements. It stays the same across all agreements in that chain, which lets you trace an agreement back to the original. When an agreement isn't derived from another agreement, its InitialAgreementId is its own AgreementId.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTimeBehavior

      DescribeAgreementResponse.Builder endTimeBehavior(EndTimeBehavior endTimeBehavior)

      The behavior of the agreement when it reaches its end date. For example, whether the agreement renews, and if it doesn't, the reason why.

      This field is present for every active agreement that has an end date. It is not present for an agreement that has no end date, because such an agreement never reaches an end time. Pay-as-you-go agreements are the most common example. It is also not present for an agreement that is no longer active.

      Parameters:
      endTimeBehavior - The behavior of the agreement when it reaches its end date. For example, whether the agreement renews, and if it doesn't, the reason why.

      This field is present for every active agreement that has an end date. It is not present for an agreement that has no end date, because such an agreement never reaches an end time. Pay-as-you-go agreements are the most common example. It is also not present for an agreement that is no longer active.

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

    • endTimeBehavior

      default DescribeAgreementResponse.Builder endTimeBehavior(Consumer<EndTimeBehavior.Builder> endTimeBehavior)

      The behavior of the agreement when it reaches its end date. For example, whether the agreement renews, and if it doesn't, the reason why.

      This field is present for every active agreement that has an end date. It is not present for an agreement that has no end date, because such an agreement never reaches an end time. Pay-as-you-go agreements are the most common example. It is also not present for an agreement that is no longer active.

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

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

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