Class GetOfferResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.marketplacediscovery.model.MarketplaceDiscoveryResponse
software.amazon.awssdk.services.marketplacediscovery.model.GetOfferResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetOfferResponse.Builder,GetOfferResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetOfferResponse extends MarketplaceDiscoveryResponse implements ToCopyableBuilder<GetOfferResponse.Builder,GetOfferResponse>

  • Method Details

    • offerId

      public final String offerId()

      The unique identifier of the offer.

      Returns:
      The unique identifier of the offer.

    • catalog

      public final String catalog()

      The name of the catalog that the offer belongs to.

      Returns:
      The name of the catalog that the offer belongs to.

    • offerName

      public final String offerName()

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

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

    • agreementProposalId

      public final String agreementProposalId()

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

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

    • expirationTime

      public final Instant expirationTime()

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

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

    • availableFromTime

      public final Instant availableFromTime()

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

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

    • sellerOfRecord

      public final SellerInformation sellerOfRecord()

      The entity responsible for selling the product under this offer.

      Returns:
      The entity responsible for selling the product under this offer.

    • replacementAgreementId

      public final String replacementAgreementId()

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

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

    • pricingModel

      public final PricingModel pricingModel()

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

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

    • hasBadges

      public final boolean hasBadges()
      For responses, this returns true if the service returned a value for the Badges property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • badges

      public final List<PurchaseOptionBadge> badges()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBadges() method.

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

    • hasAssociatedEntities

      public final boolean hasAssociatedEntities()
      For responses, this returns true if the service returned a value for the AssociatedEntities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • associatedEntities

      public final List<OfferAssociatedEntity> associatedEntities()

      The products and offer sets associated with this offer.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssociatedEntities() method.

      Returns:
      The products and offer sets associated with this offer.

    • toBuilder

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

    • builder

      public static GetOfferResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetOfferResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.