com.amazonaws.services.marketplacecatalog.model

Class ListEntitiesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.marketplacecatalog.model.ListEntitiesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListEntitiesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListEntitiesRequest()

Method Summary

Modifier and Type	Method and Description
ListEntitiesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCatalog() The catalog related to the request.
String	getEntityType() The type of entities to retrieve.
EntityTypeFilters	getEntityTypeFilters() A Union object containing filter shapes for all EntityTypes.
EntityTypeSort	getEntityTypeSort() A Union object containing Sort shapes for all EntityTypes.
List<Filter>	getFilterList() An array of filter objects.
Integer	getMaxResults() Specifies the upper limit of the elements on a single page.
String	getNextToken() The value of the next token, if it exists.
String	getOwnershipType() Filters the returned set of entities based on their owner.
Sort	getSort() An object that contains two attributes, SortBy and SortOrder.
int	hashCode()
void	setCatalog(String catalog) The catalog related to the request.
void	setEntityType(String entityType) The type of entities to retrieve.
void	setEntityTypeFilters(EntityTypeFilters entityTypeFilters) A Union object containing filter shapes for all EntityTypes.
void	setEntityTypeSort(EntityTypeSort entityTypeSort) A Union object containing Sort shapes for all EntityTypes.
void	setFilterList(Collection<Filter> filterList) An array of filter objects.
void	setMaxResults(Integer maxResults) Specifies the upper limit of the elements on a single page.
void	setNextToken(String nextToken) The value of the next token, if it exists.
void	setOwnershipType(String ownershipType) Filters the returned set of entities based on their owner.
void	setSort(Sort sort) An object that contains two attributes, SortBy and SortOrder.
String	toString() Returns a string representation of this object.
ListEntitiesRequest	withCatalog(String catalog) The catalog related to the request.
ListEntitiesRequest	withEntityType(String entityType) The type of entities to retrieve.
ListEntitiesRequest	withEntityTypeFilters(EntityTypeFilters entityTypeFilters) A Union object containing filter shapes for all EntityTypes.
ListEntitiesRequest	withEntityTypeSort(EntityTypeSort entityTypeSort) A Union object containing Sort shapes for all EntityTypes.
ListEntitiesRequest	withFilterList(Collection<Filter> filterList) An array of filter objects.
ListEntitiesRequest	withFilterList(Filter... filterList) An array of filter objects.
ListEntitiesRequest	withMaxResults(Integer maxResults) Specifies the upper limit of the elements on a single page.
ListEntitiesRequest	withNextToken(String nextToken) The value of the next token, if it exists.
ListEntitiesRequest	withOwnershipType(OwnershipType ownershipType) Filters the returned set of entities based on their owner.
ListEntitiesRequest	withOwnershipType(String ownershipType) Filters the returned set of entities based on their owner.
ListEntitiesRequest	withSort(Sort sort) An object that contains two attributes, SortBy and SortOrder.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListEntitiesRequest

public ListEntitiesRequest()

Method Detail

setCatalog

public void setCatalog(String catalog)

The catalog related to the request. Fixed value: AWSMarketplace

Parameters:

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

getCatalog

public String getCatalog()

The catalog related to the request. Fixed value: AWSMarketplace

Returns:

The catalog related to the request. Fixed value: AWSMarketplace

withCatalog

public ListEntitiesRequest withCatalog(String catalog)

The catalog related to the request. Fixed value: AWSMarketplace

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setEntityType

public void setEntityType(String entityType)

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

Parameters:

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

getEntityType

public String getEntityType()

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.

withEntityType

public ListEntitiesRequest withEntityType(String entityType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getFilterList

public List<Filter> getFilterList()

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

Returns:

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

setFilterList

public void setFilterList(Collection<Filter> filterList)

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

Parameters:

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

withFilterList

public ListEntitiesRequest withFilterList(Filter... filterList)

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

NOTE: This method appends the values to the existing list (if any). Use setFilterList(java.util.Collection) or withFilterList(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withFilterList

public ListEntitiesRequest withFilterList(Collection<Filter> filterList)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSort

public void setSort(Sort sort)

An object that contains two attributes, SortBy and SortOrder.

Parameters:

sort - An object that contains two attributes, SortBy and SortOrder.

getSort

public Sort getSort()

An object that contains two attributes, SortBy and SortOrder.

Returns:

An object that contains two attributes, SortBy and SortOrder.

withSort

public ListEntitiesRequest withSort(Sort sort)

An object that contains two attributes, SortBy and SortOrder.

Parameters:

sort - An object that contains two attributes, SortBy and SortOrder.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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.

withNextToken

public ListEntitiesRequest withNextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

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

Parameters:

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

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public ListEntitiesRequest withMaxResults(Integer maxResults)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setOwnershipType

public void setOwnershipType(String 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.

Parameters:

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.

See Also:

OwnershipType

getOwnershipType

public String getOwnershipType()

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.

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

withOwnershipType

public ListEntitiesRequest withOwnershipType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OwnershipType

withOwnershipType

public ListEntitiesRequest withOwnershipType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OwnershipType

setEntityTypeFilters

public void setEntityTypeFilters(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.

Parameters:

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.

getEntityTypeFilters

public EntityTypeFilters getEntityTypeFilters()

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.

withEntityTypeFilters

public ListEntitiesRequest withEntityTypeFilters(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setEntityTypeSort

public void setEntityTypeSort(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.

Parameters:

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.

getEntityTypeSort

public EntityTypeSort getEntityTypeSort()

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.

withEntityTypeSort

public ListEntitiesRequest withEntityTypeSort(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListEntitiesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()