com.amazonaws.services.autoscaling.model

Class DescribeScheduledActionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.DescribeScheduledActionsRequest

All Implemented Interfaces:

Serializable

public class DescribeScheduledActionsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeScheduledActions operation.

Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of actions already executed, see the activity record returned in DescribeScalingActivities.

See Also:

AmazonAutoScaling.describeScheduledActions(DescribeScheduledActionsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeScheduledActionsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAutoScalingGroupName() The name of the Auto Scaling group.
Date	getEndTime() The latest scheduled start time to return.
Integer	getMaxRecords() The maximum number of scheduled actions to return.
String	getNextToken() A string that marks the start of the next batch of returned results.
List<String>	getScheduledActionNames() A list of scheduled actions to be described.
Date	getStartTime() The earliest scheduled start time to return.
int	hashCode()
void	setAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
void	setEndTime(Date endTime) The latest scheduled start time to return.
void	setMaxRecords(Integer maxRecords) The maximum number of scheduled actions to return.
void	setNextToken(String nextToken) A string that marks the start of the next batch of returned results.
void	setScheduledActionNames(Collection<String> scheduledActionNames) A list of scheduled actions to be described.
void	setStartTime(Date startTime) The earliest scheduled start time to return.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeScheduledActionsRequest	withAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
DescribeScheduledActionsRequest	withEndTime(Date endTime) The latest scheduled start time to return.
DescribeScheduledActionsRequest	withMaxRecords(Integer maxRecords) The maximum number of scheduled actions to return.
DescribeScheduledActionsRequest	withNextToken(String nextToken) A string that marks the start of the next batch of returned results.
DescribeScheduledActionsRequest	withScheduledActionNames(Collection<String> scheduledActionNames) A list of scheduled actions to be described.
DescribeScheduledActionsRequest	withScheduledActionNames(String... scheduledActionNames) A list of scheduled actions to be described.
DescribeScheduledActionsRequest	withStartTime(Date startTime) The earliest scheduled start time to return.

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

DescribeScheduledActionsRequest

public DescribeScheduledActionsRequest()

Method Detail

getAutoScalingGroupName

public String getAutoScalingGroupName()

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

The name of the Auto Scaling group.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

Constraints:
Length: 1 - 1600
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

withAutoScalingGroupName

public DescribeScheduledActionsRequest withAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

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

Constraints:
Length: 1 - 1600
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

Returns:

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

getScheduledActionNames

public List<String> getScheduledActionNames()

A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error.

Returns:

A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error.

setScheduledActionNames

public void setScheduledActionNames(Collection<String> scheduledActionNames)

A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error.

Parameters:

scheduledActionNames - A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error.

withScheduledActionNames

public DescribeScheduledActionsRequest withScheduledActionNames(String... scheduledActionNames)

A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error.

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

Parameters:

scheduledActionNames - A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error.

Returns:

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

withScheduledActionNames

public DescribeScheduledActionsRequest withScheduledActionNames(Collection<String> scheduledActionNames)

A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error.

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

Parameters:

scheduledActionNames - A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error.

Returns:

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

getStartTime

public Date getStartTime()

The earliest scheduled start time to return. If scheduled action names are provided, this field will be ignored.

Returns:

The earliest scheduled start time to return. If scheduled action names are provided, this field will be ignored.

setStartTime

public void setStartTime(Date startTime)

The earliest scheduled start time to return. If scheduled action names are provided, this field will be ignored.

Parameters:

startTime - The earliest scheduled start time to return. If scheduled action names are provided, this field will be ignored.

withStartTime

public DescribeScheduledActionsRequest withStartTime(Date startTime)

The earliest scheduled start time to return. If scheduled action names are provided, this field will be ignored.

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

Parameters:

startTime - The earliest scheduled start time to return. If scheduled action names are provided, this field will be ignored.

Returns:

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

getEndTime

public Date getEndTime()

The latest scheduled start time to return. If scheduled action names are provided, this field is ignored.

Returns:

The latest scheduled start time to return. If scheduled action names are provided, this field is ignored.

setEndTime

public void setEndTime(Date endTime)

The latest scheduled start time to return. If scheduled action names are provided, this field is ignored.

Parameters:

endTime - The latest scheduled start time to return. If scheduled action names are provided, this field is ignored.

withEndTime

public DescribeScheduledActionsRequest withEndTime(Date endTime)

The latest scheduled start time to return. If scheduled action names are provided, this field is ignored.

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

Parameters:

endTime - The latest scheduled start time to return. If scheduled action names are provided, this field is ignored.

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: [ -퟿-�𐀀-􏿿\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: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

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

withNextToken

public DescribeScheduledActionsRequest 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: [ -퟿-�𐀀-􏿿\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 scheduled actions to return.

Constraints:
Range: 1 - 50

Returns:

The maximum number of scheduled actions to return.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of scheduled actions to return.

Constraints:
Range: 1 - 50

Parameters:

maxRecords - The maximum number of scheduled actions to return.

withMaxRecords

public DescribeScheduledActionsRequest withMaxRecords(Integer maxRecords)

The maximum number of scheduled actions to return.

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

Constraints:
Range: 1 - 50

Parameters:

maxRecords - The maximum number of scheduled actions 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