Class ListClustersRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.ecs.model.ListClustersRequest
-
- All Implemented Interfaces:
ReadLimitInfo,Serializable,Cloneable
public class ListClustersRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ListClustersRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListClustersRequestclone()Creates a shallow clone of this request.booleanequals(Object obj)IntegergetMaxResults()The maximum number of cluster results returned byListClustersin paginated output.StringgetNextToken()ThenextTokenvalue returned from a previous paginatedListClustersrequest wheremaxResultswas used and the results exceeded the value of that parameter.inthashCode()voidsetMaxResults(Integer maxResults)The maximum number of cluster results returned byListClustersin paginated output.voidsetNextToken(String nextToken)ThenextTokenvalue returned from a previous paginatedListClustersrequest wheremaxResultswas used and the results exceeded the value of that parameter.StringtoString()Returns a string representation of this object; useful for testing and debugging.ListClustersRequestwithMaxResults(Integer maxResults)The maximum number of cluster results returned byListClustersin paginated output.ListClustersRequestwithNextToken(String nextToken)ThenextTokenvalue returned from a previous paginatedListClustersrequest wheremaxResultswas used and the results exceeded the value of that parameter.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setNextToken
public void setNextToken(String nextToken)
The
nextTokenvalue returned from a previous paginatedListClustersrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. This value isnullwhen there are no more results to return.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
- Parameters:
nextToken- ThenextTokenvalue returned from a previous paginatedListClustersrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. This value isnullwhen there are no more results to return.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
-
getNextToken
public String getNextToken()
The
nextTokenvalue returned from a previous paginatedListClustersrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. This value isnullwhen there are no more results to return.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
- Returns:
- The
nextTokenvalue returned from a previous paginatedListClustersrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. This value isnullwhen there are no more results to return.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
-
withNextToken
public ListClustersRequest withNextToken(String nextToken)
The
nextTokenvalue returned from a previous paginatedListClustersrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. This value isnullwhen there are no more results to return.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
- Parameters:
nextToken- ThenextTokenvalue returned from a previous paginatedListClustersrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. This value isnullwhen there are no more results to return.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxResults
public void setMaxResults(Integer maxResults)
The maximum number of cluster results returned by
ListClustersin paginated output. When this parameter is used,ListClustersonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListClustersrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenListClustersreturns up to 100 results and anextTokenvalue if applicable.- Parameters:
maxResults- The maximum number of cluster results returned byListClustersin paginated output. When this parameter is used,ListClustersonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListClustersrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenListClustersreturns up to 100 results and anextTokenvalue if applicable.
-
getMaxResults
public Integer getMaxResults()
The maximum number of cluster results returned by
ListClustersin paginated output. When this parameter is used,ListClustersonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListClustersrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenListClustersreturns up to 100 results and anextTokenvalue if applicable.- Returns:
- The maximum number of cluster results returned by
ListClustersin paginated output. When this parameter is used,ListClustersonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListClustersrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenListClustersreturns up to 100 results and anextTokenvalue if applicable.
-
withMaxResults
public ListClustersRequest withMaxResults(Integer maxResults)
The maximum number of cluster results returned by
ListClustersin paginated output. When this parameter is used,ListClustersonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListClustersrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenListClustersreturns up to 100 results and anextTokenvalue if applicable.- Parameters:
maxResults- The maximum number of cluster results returned byListClustersin paginated output. When this parameter is used,ListClustersonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherListClustersrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenListClustersreturns up to 100 results and anextTokenvalue if applicable.- 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; useful for testing and debugging.- Overrides:
toStringin classObject- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ListClustersRequest clone()
Description copied from class:AmazonWebServiceRequestCreates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clonein classAmazonWebServiceRequest- See Also:
Object.clone()
-
-