@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListEntitiesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
ListEntitiesRequest() |
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
EntityType s. |
EntityTypeSort |
getEntityTypeSort()
A Union object containing
Sort shapes for all EntityType s. |
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
EntityType s. |
void |
setEntityTypeSort(EntityTypeSort entityTypeSort)
A Union object containing
Sort shapes for all EntityType s. |
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
EntityType s. |
ListEntitiesRequest |
withEntityTypeSort(EntityTypeSort entityTypeSort)
A Union object containing
Sort shapes for all EntityType s. |
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 . |
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
public void setCatalog(String catalog)
The catalog related to the request. Fixed value: AWSMarketplace
catalog
- The catalog related to the request. Fixed value: AWSMarketplace
public String getCatalog()
The catalog related to the request. Fixed value: AWSMarketplace
AWSMarketplace
public ListEntitiesRequest withCatalog(String catalog)
The catalog related to the request. Fixed value: AWSMarketplace
catalog
- The catalog related to the request. Fixed value: AWSMarketplace
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
.
entityType
- The type of entities to retrieve. Valid values are: AmiProduct
, ContainerProduct
, DataProduct
, SaaSProduct
, ProcurementPolicy
,
Experience
, Audience
, BrandingSettings
, Offer
,
Seller
, ResaleAuthorization
.public String getEntityType()
The type of entities to retrieve. Valid values are: AmiProduct
, ContainerProduct
,
DataProduct
, SaaSProduct
, ProcurementPolicy
, Experience
,
Audience
, BrandingSettings
, Offer
, Seller
,
ResaleAuthorization
.
AmiProduct
,
ContainerProduct
, DataProduct
, SaaSProduct
,
ProcurementPolicy
, Experience
, Audience
,
BrandingSettings
, Offer
, Seller
, ResaleAuthorization
.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
.
entityType
- The type of entities to retrieve. Valid values are: AmiProduct
, ContainerProduct
, DataProduct
, SaaSProduct
, ProcurementPolicy
,
Experience
, Audience
, BrandingSettings
, Offer
,
Seller
, ResaleAuthorization
.public List<Filter> getFilterList()
An array of filter objects. Each filter object contains two attributes, filterName
and
filterValues
.
filterName
and
filterValues
.public void setFilterList(Collection<Filter> filterList)
An array of filter objects. Each filter object contains two attributes, filterName
and
filterValues
.
filterList
- An array of filter objects. Each filter object contains two attributes, filterName
and
filterValues
.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.
filterList
- An array of filter objects. Each filter object contains two attributes, filterName
and
filterValues
.public ListEntitiesRequest withFilterList(Collection<Filter> filterList)
An array of filter objects. Each filter object contains two attributes, filterName
and
filterValues
.
filterList
- An array of filter objects. Each filter object contains two attributes, filterName
and
filterValues
.public void setSort(Sort sort)
An object that contains two attributes, SortBy
and SortOrder
.
sort
- An object that contains two attributes, SortBy
and SortOrder
.public Sort getSort()
An object that contains two attributes, SortBy
and SortOrder
.
SortBy
and SortOrder
.public ListEntitiesRequest withSort(Sort sort)
An object that contains two attributes, SortBy
and SortOrder
.
sort
- An object that contains two attributes, SortBy
and SortOrder
.public void setNextToken(String nextToken)
The value of the next token, if it exists. Null if there are no more results.
nextToken
- The value of the next token, if it exists. Null if there are no more results.public String getNextToken()
The value of the next token, if it exists. Null if there are no more results.
public ListEntitiesRequest withNextToken(String nextToken)
The value of the next token, if it exists. Null if there are no more results.
nextToken
- The value of the next token, if it exists. Null if there are no more results.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.
maxResults
- Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value
is 20.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.
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.
maxResults
- Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value
is 20.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.
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.OwnershipType
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.
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.OwnershipType
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.
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.OwnershipType
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.
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.OwnershipType
public void setEntityTypeFilters(EntityTypeFilters entityTypeFilters)
A Union object containing filter shapes for all EntityType
s. Each EntityTypeFilter
shape will have filters applicable for that EntityType
that can be used to search or filter
entities.
entityTypeFilters
- A Union object containing filter shapes for all EntityType
s. Each
EntityTypeFilter
shape will have filters applicable for that EntityType
that can
be used to search or filter entities.public EntityTypeFilters getEntityTypeFilters()
A Union object containing filter shapes for all EntityType
s. Each EntityTypeFilter
shape will have filters applicable for that EntityType
that can be used to search or filter
entities.
EntityType
s. Each
EntityTypeFilter
shape will have filters applicable for that EntityType
that
can be used to search or filter entities.public ListEntitiesRequest withEntityTypeFilters(EntityTypeFilters entityTypeFilters)
A Union object containing filter shapes for all EntityType
s. Each EntityTypeFilter
shape will have filters applicable for that EntityType
that can be used to search or filter
entities.
entityTypeFilters
- A Union object containing filter shapes for all EntityType
s. Each
EntityTypeFilter
shape will have filters applicable for that EntityType
that can
be used to search or filter entities.public void setEntityTypeSort(EntityTypeSort entityTypeSort)
A Union object containing Sort
shapes for all EntityType
s. 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.
entityTypeSort
- A Union object containing Sort
shapes for all EntityType
s. 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.public EntityTypeSort getEntityTypeSort()
A Union object containing Sort
shapes for all EntityType
s. 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.
Sort
shapes for all EntityType
s. 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.public ListEntitiesRequest withEntityTypeSort(EntityTypeSort entityTypeSort)
A Union object containing Sort
shapes for all EntityType
s. 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.
entityTypeSort
- A Union object containing Sort
shapes for all EntityType
s. 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.public String toString()
toString
in class Object
Object.toString()
public ListEntitiesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()