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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListEntitiesRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListEntitiesRequest.Builder`	`builder()`
`String`	`catalog()`	The catalog related to the request.
`String`	`entityType()`	The type of entities to retrieve.
`EntityTypeFilters`	`entityTypeFilters()`	A Union object containing filter shapes for all `EntityType`s.
`EntityTypeSort`	`entityTypeSort()`	A Union object containing `Sort` shapes for all `EntityType`s.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filterList()`	An array of filter objects.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilterList()`	For responses, this returns true if the service returned a value for the FilterList property.
`int`	`hashCode()`
`Integer`	`maxResults()`	Specifies the upper limit of the elements on a single page.
`String`	`nextToken()`	The value of the next token, if it exists.
`OwnershipType`	`ownershipType()`	Filters the returned set of entities based on their owner.
`String`	`ownershipTypeAsString()`	Filters the returned set of entities based on their owner.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListEntitiesRequest.Builder>`	`serializableBuilderClass()`
`Sort`	`sort()`	An object that contains two attributes, `SortBy` and `SortOrder`.
`ListEntitiesRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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: ServerProduct, AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, Seller, ResaleAuthorization.
    
    Returns:
    
    The type of entities to retrieve. Valid values are: ServerProduct, 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:
    
    OwnershipType
  - 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:
    
    OwnershipType
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListEntitiesRequest.Builder,ListEntitiesRequest>
    
    Specified by:
    
    toBuilder in class MarketplaceCatalogRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ListEntitiesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

catalog

entityType

hasFilterList

filterList

sort

nextToken

maxResults

ownershipType

ownershipTypeAsString

entityTypeFilters

entityTypeSort

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields