com.amazonaws.services.autoscaling.model

Class DescribeScalingActivitiesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.DescribeScalingActivitiesRequest

All Implemented Interfaces:

Serializable

public class DescribeScalingActivitiesRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeScalingActivities operation.

Returns the scaling activities for the specified Auto Scaling group.

If the specified ActivityIds list is empty, all the activities from the past six weeks are returned. Activities are sorted by the start time. Activities still in progress appear first on the list.

This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.

See Also:

AmazonAutoScaling.describeScalingActivities(DescribeScalingActivitiesRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeScalingActivitiesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getActivityIds() A list containing the activity IDs of the desired scaling activities.
String	getAutoScalingGroupName() The name of the AutoScalingGroup.
Integer	getMaxRecords() The maximum number of scaling activities to return.
String	getNextToken() A string that marks the start of the next batch of returned results for pagination.
int	hashCode()
void	setActivityIds(Collection<String> activityIds) A list containing the activity IDs of the desired scaling activities.
void	setAutoScalingGroupName(String autoScalingGroupName) The name of the AutoScalingGroup.
void	setMaxRecords(Integer maxRecords) The maximum number of scaling activities to return.
void	setNextToken(String nextToken) A string that marks the start of the next batch of returned results for pagination.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeScalingActivitiesRequest	withActivityIds(Collection<String> activityIds) A list containing the activity IDs of the desired scaling activities.
DescribeScalingActivitiesRequest	withActivityIds(String... activityIds) A list containing the activity IDs of the desired scaling activities.
DescribeScalingActivitiesRequest	withAutoScalingGroupName(String autoScalingGroupName) The name of the AutoScalingGroup.
DescribeScalingActivitiesRequest	withMaxRecords(Integer maxRecords) The maximum number of scaling activities to return.
DescribeScalingActivitiesRequest	withNextToken(String nextToken) A string that marks the start of the next batch of returned results for pagination.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeScalingActivitiesRequest

public DescribeScalingActivitiesRequest()

Method Detail

getActivityIds

public List<String> getActivityIds()

A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.

Returns:

A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.

setActivityIds

public void setActivityIds(Collection<String> activityIds)

A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.

Parameters:

activityIds - A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.

withActivityIds

public DescribeScalingActivitiesRequest withActivityIds(String... activityIds)

A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.

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

Parameters:

activityIds - A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.

Returns:

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

withActivityIds

public DescribeScalingActivitiesRequest withActivityIds(Collection<String> activityIds)

A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.

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

Parameters:

activityIds - A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an AutoScalingGroupName is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.

Returns:

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

getAutoScalingGroupName

public String getAutoScalingGroupName()

The name of the AutoScalingGroup.

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

Returns:

The name of the AutoScalingGroup.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name of the AutoScalingGroup.

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

Parameters:

autoScalingGroupName - The name of the AutoScalingGroup.

withAutoScalingGroupName

public DescribeScalingActivitiesRequest withAutoScalingGroupName(String autoScalingGroupName)

The name of the AutoScalingGroup.

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

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

Parameters:

autoScalingGroupName - The name of the AutoScalingGroup.

Returns:

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

getMaxRecords

public Integer getMaxRecords()

The maximum number of scaling activities to return.

Returns:

The maximum number of scaling activities to return.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of scaling activities to return.

Parameters:

maxRecords - The maximum number of scaling activities to return.

withMaxRecords

public DescribeScalingActivitiesRequest withMaxRecords(Integer maxRecords)

The maximum number of scaling activities to return.

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

Parameters:

maxRecords - The maximum number of scaling activities to return.

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 for pagination.

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 for pagination.

setNextToken

public void setNextToken(String nextToken)

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

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 for pagination.

withNextToken

public DescribeScalingActivitiesRequest withNextToken(String nextToken)

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

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 for pagination.

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