Class DescribeEcsClustersRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.opsworks.model.DescribeEcsClustersRequest
-
- All Implemented Interfaces:
ReadLimitInfo,Serializable,Cloneable
public class DescribeEcsClustersRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeEcsClustersRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeEcsClustersRequestclone()Creates a shallow clone of this request.booleanequals(Object obj)List<String>getEcsClusterArns()A list of ARNs, one for each cluster to be described.IntegergetMaxResults()To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call.StringgetNextToken()If the previous paginated request did not return all of the remaining results, the response object'sNextTokenparameter value is set to a token.StringgetStackId()A stack ID.inthashCode()voidsetEcsClusterArns(Collection<String> ecsClusterArns)A list of ARNs, one for each cluster to be described.voidsetMaxResults(Integer maxResults)To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call.voidsetNextToken(String nextToken)If the previous paginated request did not return all of the remaining results, the response object'sNextTokenparameter value is set to a token.voidsetStackId(String stackId)A stack ID.StringtoString()Returns a string representation of this object; useful for testing and debugging.DescribeEcsClustersRequestwithEcsClusterArns(String... ecsClusterArns)A list of ARNs, one for each cluster to be described.DescribeEcsClustersRequestwithEcsClusterArns(Collection<String> ecsClusterArns)A list of ARNs, one for each cluster to be described.DescribeEcsClustersRequestwithMaxResults(Integer maxResults)To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call.DescribeEcsClustersRequestwithNextToken(String nextToken)If the previous paginated request did not return all of the remaining results, the response object'sNextTokenparameter value is set to a token.DescribeEcsClustersRequestwithStackId(String stackId)A stack ID.-
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
-
getEcsClusterArns
public List<String> getEcsClusterArns()
A list of ARNs, one for each cluster to be described.
- Returns:
- A list of ARNs, one for each cluster to be described.
-
setEcsClusterArns
public void setEcsClusterArns(Collection<String> ecsClusterArns)
A list of ARNs, one for each cluster to be described.
- Parameters:
ecsClusterArns- A list of ARNs, one for each cluster to be described.
-
withEcsClusterArns
public DescribeEcsClustersRequest withEcsClusterArns(String... ecsClusterArns)
A list of ARNs, one for each cluster to be described.
NOTE: This method appends the values to the existing list (if any). Use
setEcsClusterArns(java.util.Collection)orwithEcsClusterArns(java.util.Collection)if you want to override the existing values.- Parameters:
ecsClusterArns- A list of ARNs, one for each cluster to be described.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withEcsClusterArns
public DescribeEcsClustersRequest withEcsClusterArns(Collection<String> ecsClusterArns)
A list of ARNs, one for each cluster to be described.
- Parameters:
ecsClusterArns- A list of ARNs, one for each cluster to be described.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStackId
public void setStackId(String stackId)
A stack ID.
DescribeEcsClustersreturns a description of the cluster that is registered with the stack.- Parameters:
stackId- A stack ID.DescribeEcsClustersreturns a description of the cluster that is registered with the stack.
-
getStackId
public String getStackId()
A stack ID.
DescribeEcsClustersreturns a description of the cluster that is registered with the stack.- Returns:
- A stack ID.
DescribeEcsClustersreturns a description of the cluster that is registered with the stack.
-
withStackId
public DescribeEcsClustersRequest withStackId(String stackId)
A stack ID.
DescribeEcsClustersreturns a description of the cluster that is registered with the stack.- Parameters:
stackId- A stack ID.DescribeEcsClustersreturns a description of the cluster that is registered with the stack.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextToken
public void setNextToken(String nextToken)
If the previous paginated request did not return all of the remaining results, the response object's
NextTokenparameter value is set to a token. To retrieve the next set of results, callDescribeEcsClustersagain and assign that token to the request object'sNextTokenparameter. If there are no remaining results, the previous response object'sNextTokenparameter is set tonull.- Parameters:
nextToken- If the previous paginated request did not return all of the remaining results, the response object'sNextTokenparameter value is set to a token. To retrieve the next set of results, callDescribeEcsClustersagain and assign that token to the request object'sNextTokenparameter. If there are no remaining results, the previous response object'sNextTokenparameter is set tonull.
-
getNextToken
public String getNextToken()
If the previous paginated request did not return all of the remaining results, the response object's
NextTokenparameter value is set to a token. To retrieve the next set of results, callDescribeEcsClustersagain and assign that token to the request object'sNextTokenparameter. If there are no remaining results, the previous response object'sNextTokenparameter is set tonull.- Returns:
- If the previous paginated request did not return all of the
remaining results, the response object's
NextTokenparameter value is set to a token. To retrieve the next set of results, callDescribeEcsClustersagain and assign that token to the request object'sNextTokenparameter. If there are no remaining results, the previous response object'sNextTokenparameter is set tonull.
-
withNextToken
public DescribeEcsClustersRequest withNextToken(String nextToken)
If the previous paginated request did not return all of the remaining results, the response object's
NextTokenparameter value is set to a token. To retrieve the next set of results, callDescribeEcsClustersagain and assign that token to the request object'sNextTokenparameter. If there are no remaining results, the previous response object'sNextTokenparameter is set tonull.- Parameters:
nextToken- If the previous paginated request did not return all of the remaining results, the response object'sNextTokenparameter value is set to a token. To retrieve the next set of results, callDescribeEcsClustersagain and assign that token to the request object'sNextTokenparameter. If there are no remaining results, the previous response object'sNextTokenparameter is set tonull.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxResults
public void setMaxResults(Integer maxResults)
To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a
NextTokenvalue that you can assign to theNextTokenrequest parameter to get the next set of results.- Parameters:
maxResults- To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes aNextTokenvalue that you can assign to theNextTokenrequest parameter to get the next set of results.
-
getMaxResults
public Integer getMaxResults()
To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a
NextTokenvalue that you can assign to theNextTokenrequest parameter to get the next set of results.- Returns:
- To receive a paginated response, use this parameter to specify
the maximum number of results to be returned with a single call.
If the number of available results exceeds this maximum, the
response includes a
NextTokenvalue that you can assign to theNextTokenrequest parameter to get the next set of results.
-
withMaxResults
public DescribeEcsClustersRequest withMaxResults(Integer maxResults)
To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a
NextTokenvalue that you can assign to theNextTokenrequest parameter to get the next set of results.- Parameters:
maxResults- To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes aNextTokenvalue that you can assign to theNextTokenrequest parameter to get the next set of results.- 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 DescribeEcsClustersRequest 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()
-
-