@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.
|
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.
|
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 |
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 |
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 |
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 |
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.
entityType
- The type of entities to retrieve.public String getEntityType()
The type of entities to retrieve.
public ListEntitiesRequest withEntityType(String entityType)
The type of entities to retrieve.
entityType
- The type of entities to retrieve.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 String toString()
toString
in class Object
Object.toString()
public ListEntitiesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()