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 AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
DescribeEcsClustersRequest()

Method Summary

Modifier and Type	Method	Description
DescribeEcsClustersRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getEcsClusterArns()	A list of ARNs, one for each cluster to be described.
Integer	getMaxResults()	To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call.
String	getNextToken()	If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token.
String	getStackId()	A stack ID.
int	hashCode()
void	setEcsClusterArns(Collection<String> ecsClusterArns)	A list of ARNs, one for each cluster to be described.
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.
void	setNextToken(String nextToken)	If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token.
void	setStackId(String stackId)	A stack ID.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
DescribeEcsClustersRequest	withEcsClusterArns(String... ecsClusterArns)	A list of ARNs, one for each cluster to be described.
DescribeEcsClustersRequest	withEcsClusterArns(Collection<String> ecsClusterArns)	A list of ARNs, one for each cluster to be described.
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.
DescribeEcsClustersRequest	withNextToken(String nextToken)	If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token.
DescribeEcsClustersRequest	withStackId(String stackId)	A stack ID.

Methods inherited from class 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

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DescribeEcsClustersRequest

public DescribeEcsClustersRequest()

Method Details

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) or withEcsClusterArns(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. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

Parameters:

stackId - A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

getStackId

public String getStackId()

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

Returns:

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

withStackId

public DescribeEcsClustersRequest withStackId(String stackId)

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

Parameters:

stackId - A stack ID. DescribeEcsClusters returns 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'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters 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.

Parameters:

nextToken - If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters 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.

getNextToken

public String getNextToken()

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters 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.

Returns:

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters 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.

withNextToken

public DescribeEcsClustersRequest withNextToken(String nextToken)

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters 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.

Parameters:

nextToken - If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters 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.

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 NextToken value that you can assign to the NextToken request 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 a NextToken value that you can assign to the NextToken request 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 NextToken value that you can assign to the NextToken request 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 NextToken value that you can assign to the NextToken request 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 NextToken value that you can assign to the NextToken request 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 a NextToken value that you can assign to the NextToken request 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:

toString in class Object

Returns:

A string representation of this object.

See Also:

• Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeEcsClustersRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

• Object.clone()