Class GetListingResponse

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.GetListingResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetListingResponse.Builder,GetListingResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetListingResponse extends MarketplaceDiscoveryResponse implements ToCopyableBuilder<GetListingResponse.Builder,GetListingResponse>

  • Method Details

    • 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<ListingAssociatedEntity> associatedEntities()

      The products and offers associated with this listing. Each entity contains product and offer information.

      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 offers associated with this listing. Each entity contains product and offer information.

    • 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<ListingBadge> badges()

      Badges indicating special attributes of the listing, such as free tier eligibility, free trial availability, or Quick Launch support.

      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 listing, such as free tier eligibility, free trial availability, or Quick Launch support.

    • catalog

      public final String catalog()

      The name of the catalog that the listing belongs to.

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

    • hasCategories

      public final boolean hasCategories()
      For responses, this returns true if the service returned a value for the Categories 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.

    • categories

      public final List<Category> categories()

      The categories used to classify this listing into logical groups.

      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 hasCategories() method.

      Returns:
      The categories used to classify this listing into logical groups.

    • hasFulfillmentOptionSummaries

      public final boolean hasFulfillmentOptionSummaries()
      For responses, this returns true if the service returned a value for the FulfillmentOptionSummaries 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.

    • fulfillmentOptionSummaries

      public final List<FulfillmentOptionSummary> fulfillmentOptionSummaries()

      A summary of fulfillment options available for deploying or accessing the listing, such as AMI, SaaS, or Container.

      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 hasFulfillmentOptionSummaries() method.

      Returns:
      A summary of fulfillment options available for deploying or accessing the listing, such as AMI, SaaS, or Container.

    • hasHighlights

      public final boolean hasHighlights()
      For responses, this returns true if the service returned a value for the Highlights 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.

    • highlights

      public final List<String> highlights()

      A list of key features that the listing offers to customers.

      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 hasHighlights() method.

      Returns:
      A list of key features that the listing offers to customers.

    • integrationGuide

      public final String integrationGuide()

      Optional guidance explaining how to use data in this listing. Primarily defines how to integrate with a multi-product listing.

      Returns:
      Optional guidance explaining how to use data in this listing. Primarily defines how to integrate with a multi-product listing.

    • listingId

      public final String listingId()

      The unique identifier of the listing.

      Returns:
      The unique identifier of the listing.

    • listingName

      public final String listingName()

      The human-readable display name of the listing.

      Returns:
      The human-readable display name of the listing.

    • logoThumbnailUrl

      public final String logoThumbnailUrl()

      The URL of the logo thumbnail image for the listing.

      Returns:
      The URL of the logo thumbnail image for the listing.

    • longDescription

      public final String longDescription()

      A detailed description of what the listing offers, in paragraph format.

      Returns:
      A detailed description of what the listing offers, in paragraph format.

    • hasPricingModels

      public final boolean hasPricingModels()
      For responses, this returns true if the service returned a value for the PricingModels 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.

    • pricingModels

      public final List<PricingModel> pricingModels()

      The pricing models for offers associated with this listing, such as usage-based, contract, BYOL, or free.

      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 hasPricingModels() method.

      Returns:
      The pricing models for offers associated with this listing, such as usage-based, contract, BYOL, or free.

    • hasPricingUnits

      public final boolean hasPricingUnits()
      For responses, this returns true if the service returned a value for the PricingUnits 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.

    • pricingUnits

      public final List<PricingUnit> pricingUnits()

      The pricing units that define the billing dimensions for offers associated with this listing, such as users, hosts, or data.

      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 hasPricingUnits() method.

      Returns:
      The pricing units that define the billing dimensions for offers associated with this listing, such as users, hosts, or data.

    • hasPromotionalMedia

      public final boolean hasPromotionalMedia()
      For responses, this returns true if the service returned a value for the PromotionalMedia 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.

    • promotionalMedia

      public final List<PromotionalMedia> promotionalMedia()

      Embedded promotional media provided by the creator of the product, such as images and videos.

      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 hasPromotionalMedia() method.

      Returns:
      Embedded promotional media provided by the creator of the product, such as images and videos.

    • publisher

      public final SellerInformation publisher()

      The entity who created and published the listing.

      Returns:
      The entity who created and published the listing.

    • hasResources

      public final boolean hasResources()
      For responses, this returns true if the service returned a value for the Resources 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.

    • resources

      public final List<Resource> resources()

      Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.

      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 hasResources() method.

      Returns:
      Resources that provide further information about using the product or requesting support, such as documentation links, support contacts, and usage instructions.

    • reviewSummary

      public final ReviewSummary reviewSummary()

      A summary of customer reviews available for the listing, including average rating and total review count by source.

      Returns:
      A summary of customer reviews available for the listing, including average rating and total review count by source.

    • hasSellerEngagements

      public final boolean hasSellerEngagements()
      For responses, this returns true if the service returned a value for the SellerEngagements 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.

    • sellerEngagements

      public final List<SellerEngagement> sellerEngagements()

      Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.

      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 hasSellerEngagements() method.

      Returns:
      Engagement options available to potential buyers, such as requesting a private offer or requesting a demo.

    • shortDescription

      public final String shortDescription()

      A 1–3 sentence summary describing the key aspects of the listing.

      Returns:
      A 1–3 sentence summary describing the key aspects of the listing.

    • hasUseCases

      public final boolean hasUseCases()
      For responses, this returns true if the service returned a value for the UseCases 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.

    • useCases

      public final List<UseCaseEntry> useCases()

      Use cases associated with the listing, describing scenarios where the product can be applied.

      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 hasUseCases() method.

      Returns:
      Use cases associated with the listing, describing scenarios where the product can be applied.

    • toBuilder

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

    • builder

      public static GetListingResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetListingResponse.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.