Interface GetOfferResponse.Builder

  • Method Details

    • offerId

      GetOfferResponse.Builder offerId(String offerId)

      The unique identifier of the offer.

      Parameters:
      offerId - The unique identifier of the offer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • catalog

      GetOfferResponse.Builder catalog(String catalog)

      The name of the catalog that the offer belongs to.

      Parameters:
      catalog - The name of the catalog that the offer belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • offerName

      GetOfferResponse.Builder offerName(String offerName)

      The display name of the offer. This is free-form text provided by the seller.

      Parameters:
      offerName - The display name of the offer. This is free-form text provided by the seller.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • agreementProposalId

      GetOfferResponse.Builder agreementProposalId(String agreementProposalId)

      An encoded string to be passed by the acceptor of the terms when creating an agreement.

      Parameters:
      agreementProposalId - An encoded string to be passed by the acceptor of the terms when creating an agreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • expirationTime

      GetOfferResponse.Builder expirationTime(Instant expirationTime)

      The date and time until when the offer can be procured. This value is null for offers that never expire.

      Parameters:
      expirationTime - The date and time until when the offer can be procured. This value is null for offers that never expire.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • availableFromTime

      GetOfferResponse.Builder availableFromTime(Instant availableFromTime)

      The date and time when the offer became available to the buyer.

      Parameters:
      availableFromTime - The date and time when the offer became available to the buyer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sellerOfRecord

      GetOfferResponse.Builder sellerOfRecord(SellerInformation sellerOfRecord)

      The entity responsible for selling the product under this offer.

      Parameters:
      sellerOfRecord - The entity responsible for selling the product under this offer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sellerOfRecord

      default GetOfferResponse.Builder sellerOfRecord(Consumer<SellerInformation.Builder> sellerOfRecord)

      The entity responsible for selling the product under this offer.

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

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

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

      GetOfferResponse.Builder replacementAgreementId(String replacementAgreementId)

      The identifier of the existing agreement that this offer would replace. Enables agreement-based offer functionality.

      Parameters:
      replacementAgreementId - The identifier of the existing agreement that this offer would replace. Enables agreement-based offer functionality.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • pricingModel

      GetOfferResponse.Builder pricingModel(PricingModel pricingModel)

      The pricing model that determines how buyers are charged, such as usage-based, contract, BYOL, or free.

      Parameters:
      pricingModel - The pricing model that determines how buyers are charged, such as usage-based, contract, BYOL, or free.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • pricingModel

      default GetOfferResponse.Builder pricingModel(Consumer<PricingModel.Builder> pricingModel)

      The pricing model that determines how buyers are charged, such as usage-based, contract, BYOL, or free.

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

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

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

      Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer.

      Parameters:
      badges - Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • badges

      Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer.

      Parameters:
      badges - Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • badges

      Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer.

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

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

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

      GetOfferResponse.Builder associatedEntities(Collection<OfferAssociatedEntity> associatedEntities)

      The products and offer sets associated with this offer.

      Parameters:
      associatedEntities - The products and offer sets associated with this offer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • associatedEntities

      GetOfferResponse.Builder associatedEntities(OfferAssociatedEntity... associatedEntities)

      The products and offer sets associated with this offer.

      Parameters:
      associatedEntities - The products and offer sets associated with this offer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • associatedEntities

      GetOfferResponse.Builder associatedEntities(Consumer<OfferAssociatedEntity.Builder>... associatedEntities)

      The products and offer sets associated with this offer.

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

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

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