com.amazonaws.services.autoscaling.model

Class DescribeAutoScalingGroupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.DescribeAutoScalingGroupsRequest

All Implemented Interfaces:

Serializable

public class DescribeAutoScalingGroupsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeAutoScalingGroups operation.

Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.

See Also:

AmazonAutoScaling.describeAutoScalingGroups(DescribeAutoScalingGroupsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeAutoScalingGroupsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getAutoScalingGroupNames() A list of Auto Scaling group names.
Integer	getMaxRecords() The maximum number of records to return.
String	getNextToken() A string that marks the start of the next batch of returned results.
int	hashCode()
void	setAutoScalingGroupNames(Collection<String> autoScalingGroupNames) A list of Auto Scaling group names.
void	setMaxRecords(Integer maxRecords) The maximum number of records to return.
void	setNextToken(String nextToken) A string that marks the start of the next batch of returned results.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeAutoScalingGroupsRequest	withAutoScalingGroupNames(Collection<String> autoScalingGroupNames) A list of Auto Scaling group names.
DescribeAutoScalingGroupsRequest	withAutoScalingGroupNames(String... autoScalingGroupNames) A list of Auto Scaling group names.
DescribeAutoScalingGroupsRequest	withMaxRecords(Integer maxRecords) The maximum number of records to return.
DescribeAutoScalingGroupsRequest	withNextToken(String nextToken) A string that marks the start of the next batch of returned results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeAutoScalingGroupsRequest

public DescribeAutoScalingGroupsRequest()

Method Detail

getAutoScalingGroupNames

public List<String> getAutoScalingGroupNames()

A list of Auto Scaling group names.

Returns:

A list of Auto Scaling group names.

setAutoScalingGroupNames

public void setAutoScalingGroupNames(Collection<String> autoScalingGroupNames)

A list of Auto Scaling group names.

Parameters:

autoScalingGroupNames - A list of Auto Scaling group names.

withAutoScalingGroupNames

public DescribeAutoScalingGroupsRequest withAutoScalingGroupNames(String... autoScalingGroupNames)

A list of Auto Scaling group names.

Returns a reference to this object so that method calls can be chained together.

Parameters:

autoScalingGroupNames - A list of Auto Scaling group names.

Returns:

A reference to this updated object so that method calls can be chained together.

withAutoScalingGroupNames

public DescribeAutoScalingGroupsRequest withAutoScalingGroupNames(Collection<String> autoScalingGroupNames)

A list of Auto Scaling group names.

Returns a reference to this object so that method calls can be chained together.

Parameters:

autoScalingGroupNames - A list of Auto Scaling group names.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

A string that marks the start of the next batch of returned results.

setNextToken

public void setNextToken(String nextToken)

A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

nextToken - A string that marks the start of the next batch of returned results.

withNextToken

public DescribeAutoScalingGroupsRequest withNextToken(String nextToken)

A string that marks the start of the next batch of returned results.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

nextToken - A string that marks the start of the next batch of returned results.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxRecords

public Integer getMaxRecords()

The maximum number of records to return.

Returns:

The maximum number of records to return.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of records to return.

Parameters:

maxRecords - The maximum number of records to return.

withMaxRecords

public DescribeAutoScalingGroupsRequest withMaxRecords(Integer maxRecords)

The maximum number of records to return.

Returns a reference to this object so that method calls can be chained together.

Parameters:

maxRecords - The maximum number of records to return.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object