com.amazonaws.services.autoscaling.model

Class DescribeAutoScalingInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.DescribeAutoScalingInstancesRequest

All Implemented Interfaces:

Serializable

public class DescribeAutoScalingInstancesRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeAutoScalingInstances operation.

Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances.

You can describe up to a maximum of 50 instances with a single call. By default, a call returns up to 20 instances. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token in the NextToken parameter.

See Also:

AmazonAutoScaling.describeAutoScalingInstances(DescribeAutoScalingInstancesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeAutoScalingInstancesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getInstanceIds() One or more Auto Scaling instances to describe, up to 50 instances.
Integer	getMaxRecords() The maximum number of items to return with this call.
String	getNextToken() The token for the next set of items to return.
int	hashCode()
void	setInstanceIds(Collection<String> instanceIds) One or more Auto Scaling instances to describe, up to 50 instances.
void	setMaxRecords(Integer maxRecords) The maximum number of items to return with this call.
void	setNextToken(String nextToken) The token for the next set of items to return.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeAutoScalingInstancesRequest	withInstanceIds(Collection<String> instanceIds) One or more Auto Scaling instances to describe, up to 50 instances.
DescribeAutoScalingInstancesRequest	withInstanceIds(String... instanceIds) One or more Auto Scaling instances to describe, up to 50 instances.
DescribeAutoScalingInstancesRequest	withMaxRecords(Integer maxRecords) The maximum number of items to return with this call.
DescribeAutoScalingInstancesRequest	withNextToken(String nextToken) The token for the next set of items to return.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeAutoScalingInstancesRequest

public DescribeAutoScalingInstancesRequest()

Method Detail

getInstanceIds

public List<String> getInstanceIds()

One or more Auto Scaling instances to describe, up to 50 instances. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

Returns:

One or more Auto Scaling instances to describe, up to 50 instances. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

One or more Auto Scaling instances to describe, up to 50 instances. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

Parameters:

instanceIds - One or more Auto Scaling instances to describe, up to 50 instances. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

withInstanceIds

public DescribeAutoScalingInstancesRequest withInstanceIds(String... instanceIds)

One or more Auto Scaling instances to describe, up to 50 instances. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

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

Parameters:

instanceIds - One or more Auto Scaling instances to describe, up to 50 instances. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

Returns:

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

withInstanceIds

public DescribeAutoScalingInstancesRequest withInstanceIds(Collection<String> instanceIds)

One or more Auto Scaling instances to describe, up to 50 instances. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

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

Parameters:

instanceIds - One or more Auto Scaling instances to describe, up to 50 instances. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

Returns:

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

getMaxRecords

public Integer getMaxRecords()

The maximum number of items to return with this call.

Returns:

The maximum number of items to return with this call.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of items to return with this call.

Parameters:

maxRecords - The maximum number of items to return with this call.

withMaxRecords

public DescribeAutoScalingInstancesRequest withMaxRecords(Integer maxRecords)

The maximum number of items to return with this call.

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

Parameters:

maxRecords - The maximum number of items to return with this call.

Returns:

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

getNextToken

public String getNextToken()

The token for the next set of items to return. (You received this token from a previous call.)

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

Returns:

The token for the next set of items to return. (You received this token from a previous call.)

setNextToken

public void setNextToken(String nextToken)

The token for the next set of items to return. (You received this token from a previous call.)

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

Parameters:

nextToken - The token for the next set of items to return. (You received this token from a previous call.)

withNextToken

public DescribeAutoScalingInstancesRequest withNextToken(String nextToken)

The token for the next set of items to return. (You received this token from a previous call.)

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 - The token for the next set of items to return. (You received this token from a previous call.)

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