@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListRobotsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
ListRobotsRequest() |
Modifier and Type | Method and Description |
---|---|
ListRobotsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<Filter> |
getFilters()
Optional filters to limit results.
|
Integer |
getMaxResults()
When this parameter is used,
ListRobots only returns maxResults results in a single
page along with a nextToken response element. |
String |
getNextToken()
If the previous paginated request did not return all of the remaining results, the response object's
nextToken parameter value is set to a token. |
int |
hashCode() |
void |
setFilters(Collection<Filter> filters)
Optional filters to limit results.
|
void |
setMaxResults(Integer maxResults)
When this parameter is used,
ListRobots only returns maxResults results in a single
page along with a nextToken response element. |
void |
setNextToken(String nextToken)
If the previous paginated request did not return all of the remaining results, the response object's
nextToken parameter value is set to a token. |
String |
toString()
Returns a string representation of this object.
|
ListRobotsRequest |
withFilters(Collection<Filter> filters)
Optional filters to limit results.
|
ListRobotsRequest |
withFilters(Filter... filters)
Optional filters to limit results.
|
ListRobotsRequest |
withMaxResults(Integer maxResults)
When this parameter is used,
ListRobots only returns maxResults results in a single
page along with a nextToken response element. |
ListRobotsRequest |
withNextToken(String nextToken)
If the previous paginated request did not return all of the remaining results, the response object's
nextToken parameter value is set to a token. |
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 setNextToken(String nextToken)
If the previous paginated request did not return all of the remaining results, the response object's
nextToken
parameter value is set to a token. To retrieve the next set of results, call
ListRobots
again and assign that token to the request object's nextToken
parameter. If
there are no remaining results, the previous response object's NextToken parameter is set to null.
nextToken
- If the previous paginated request did not return all of the remaining results, the response object's
nextToken
parameter value is set to a token. To retrieve the next set of results, call
ListRobots
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to
null.public String getNextToken()
If the previous paginated request did not return all of the remaining results, the response object's
nextToken
parameter value is set to a token. To retrieve the next set of results, call
ListRobots
again and assign that token to the request object's nextToken
parameter. If
there are no remaining results, the previous response object's NextToken parameter is set to null.
nextToken
parameter value is set to a token. To retrieve the next set of results, call
ListRobots
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set
to null.public ListRobotsRequest withNextToken(String nextToken)
If the previous paginated request did not return all of the remaining results, the response object's
nextToken
parameter value is set to a token. To retrieve the next set of results, call
ListRobots
again and assign that token to the request object's nextToken
parameter. If
there are no remaining results, the previous response object's NextToken parameter is set to null.
nextToken
- If the previous paginated request did not return all of the remaining results, the response object's
nextToken
parameter value is set to a token. To retrieve the next set of results, call
ListRobots
again and assign that token to the request object's nextToken
parameter. If there are no remaining results, the previous response object's NextToken parameter is set to
null.public void setMaxResults(Integer maxResults)
When this parameter is used, ListRobots
only returns maxResults
results in a single
page along with a nextToken
response element. The remaining results of the initial request can be
seen by sending another ListRobots
request with the returned nextToken
value. This
value can be between 1 and 200. If this parameter is not used, then ListRobots
returns up to 200
results and a nextToken
value if applicable.
maxResults
- When this parameter is used, ListRobots
only returns maxResults
results in a
single page along with a nextToken
response element. The remaining results of the initial
request can be seen by sending another ListRobots
request with the returned
nextToken
value. This value can be between 1 and 200. If this parameter is not used, then
ListRobots
returns up to 200 results and a nextToken
value if applicable.public Integer getMaxResults()
When this parameter is used, ListRobots
only returns maxResults
results in a single
page along with a nextToken
response element. The remaining results of the initial request can be
seen by sending another ListRobots
request with the returned nextToken
value. This
value can be between 1 and 200. If this parameter is not used, then ListRobots
returns up to 200
results and a nextToken
value if applicable.
ListRobots
only returns maxResults
results in a
single page along with a nextToken
response element. The remaining results of the initial
request can be seen by sending another ListRobots
request with the returned
nextToken
value. This value can be between 1 and 200. If this parameter is not used, then
ListRobots
returns up to 200 results and a nextToken
value if applicable.public ListRobotsRequest withMaxResults(Integer maxResults)
When this parameter is used, ListRobots
only returns maxResults
results in a single
page along with a nextToken
response element. The remaining results of the initial request can be
seen by sending another ListRobots
request with the returned nextToken
value. This
value can be between 1 and 200. If this parameter is not used, then ListRobots
returns up to 200
results and a nextToken
value if applicable.
maxResults
- When this parameter is used, ListRobots
only returns maxResults
results in a
single page along with a nextToken
response element. The remaining results of the initial
request can be seen by sending another ListRobots
request with the returned
nextToken
value. This value can be between 1 and 200. If this parameter is not used, then
ListRobots
returns up to 200 results and a nextToken
value if applicable.public List<Filter> getFilters()
Optional filters to limit results.
The filter names status
and fleetName
are supported. When filtering, you must use the
complete value of the filtered item. You can use up to three filters, but they must be for the same named item.
For example, if you are looking for items with the status Registered
or the status
Available
.
The filter names status
and fleetName
are supported. When filtering, you must
use the complete value of the filtered item. You can use up to three filters, but they must be for the
same named item. For example, if you are looking for items with the status Registered
or the
status Available
.
public void setFilters(Collection<Filter> filters)
Optional filters to limit results.
The filter names status
and fleetName
are supported. When filtering, you must use the
complete value of the filtered item. You can use up to three filters, but they must be for the same named item.
For example, if you are looking for items with the status Registered
or the status
Available
.
filters
- Optional filters to limit results.
The filter names status
and fleetName
are supported. When filtering, you must
use the complete value of the filtered item. You can use up to three filters, but they must be for the
same named item. For example, if you are looking for items with the status Registered
or the
status Available
.
public ListRobotsRequest withFilters(Filter... filters)
Optional filters to limit results.
The filter names status
and fleetName
are supported. When filtering, you must use the
complete value of the filtered item. You can use up to three filters, but they must be for the same named item.
For example, if you are looking for items with the status Registered
or the status
Available
.
NOTE: This method appends the values to the existing list (if any). Use
setFilters(java.util.Collection)
or withFilters(java.util.Collection)
if you want to override
the existing values.
filters
- Optional filters to limit results.
The filter names status
and fleetName
are supported. When filtering, you must
use the complete value of the filtered item. You can use up to three filters, but they must be for the
same named item. For example, if you are looking for items with the status Registered
or the
status Available
.
public ListRobotsRequest withFilters(Collection<Filter> filters)
Optional filters to limit results.
The filter names status
and fleetName
are supported. When filtering, you must use the
complete value of the filtered item. You can use up to three filters, but they must be for the same named item.
For example, if you are looking for items with the status Registered
or the status
Available
.
filters
- Optional filters to limit results.
The filter names status
and fleetName
are supported. When filtering, you must
use the complete value of the filtered item. You can use up to three filters, but they must be for the
same named item. For example, if you are looking for items with the status Registered
or the
status Available
.
public String toString()
toString
in class Object
Object.toString()
public ListRobotsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()