Package software.amazon.awssdk.services.marketplacecatalog.model

Class ListEntitiesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.marketplacecatalog.model.MarketplaceCatalogRequest
software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListEntitiesRequest.Builder,ListEntitiesRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListEntitiesRequest extends MarketplaceCatalogRequest implements ToCopyableBuilder<ListEntitiesRequest.Builder,ListEntitiesRequest>

  • Method Details

    • catalog

      public final String catalog()

      The catalog related to the request. Fixed value: AWSMarketplace

      Returns:
      The catalog related to the request. Fixed value: AWSMarketplace

    • entityType

      public final String entityType()

      The type of entities to retrieve. Valid values are: AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, Seller, ResaleAuthorization.

      Returns:
      The type of entities to retrieve. Valid values are: AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, Seller, ResaleAuthorization.

    • hasFilterList

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

    • filterList

      public final List<Filter> filterList()

      An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

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

      Returns:
      An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

    • sort

      public final Sort sort()

      An object that contains two attributes, SortBy and SortOrder.

      Returns:
      An object that contains two attributes, SortBy and SortOrder.

    • nextToken

      public final String nextToken()

      The value of the next token, if it exists. Null if there are no more results.

      Returns:
      The value of the next token, if it exists. Null if there are no more results.

    • maxResults

      public final Integer maxResults()

      Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

      Returns:
      Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.

    • ownershipType

      public final OwnershipType ownershipType()

      Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the SHARED parameter.

      If the service returns an enum value that is not available in the current SDK version, ownershipType will return OwnershipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ownershipTypeAsString().

      Returns:
      Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the SHARED parameter.
      See Also:

    • ownershipTypeAsString

      public final String ownershipTypeAsString()

      Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the SHARED parameter.

      If the service returns an enum value that is not available in the current SDK version, ownershipType will return OwnershipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ownershipTypeAsString().

      Returns:
      Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the SHARED parameter.
      See Also:

    • entityTypeFilters

      public final EntityTypeFilters entityTypeFilters()

      A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter shape will have filters applicable for that EntityType that can be used to search or filter entities.

      Returns:
      A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter shape will have filters applicable for that EntityType that can be used to search or filter entities.

    • entityTypeSort

      public final EntityTypeSort entityTypeSort()

      A Union object containing Sort shapes for all EntityTypes. Each EntityTypeSort shape will have SortBy and SortOrder applicable for fields on that EntityType. This can be used to sort the results of the filter query.

      Returns:
      A Union object containing Sort shapes for all EntityTypes. Each EntityTypeSort shape will have SortBy and SortOrder applicable for fields on that EntityType. This can be used to sort the results of the filter query.

    • toBuilder

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

    • builder

      public static ListEntitiesRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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