com.amazonaws.services.autoscaling.model

Class DescribePoliciesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.DescribePoliciesRequest

All Implemented Interfaces:

Serializable

public class DescribePoliciesRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribePolicies operation.

Returns descriptions of what each policy does. 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.describePolicies(DescribePoliciesRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribePoliciesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAutoScalingGroupName() The name of the Auto Scaling group.
Integer	getMaxRecords() The maximum number of policies that will be described with each call.
String	getNextToken() A string that is used to mark the start of the next batch of returned results for pagination.
List<String>	getPolicyNames() A list of policy names or policy ARNs to be described.
int	hashCode()
void	setAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
void	setMaxRecords(Integer maxRecords) The maximum number of policies that will be described with each call.
void	setNextToken(String nextToken) A string that is used to mark the start of the next batch of returned results for pagination.
void	setPolicyNames(Collection<String> policyNames) A list of policy names or policy ARNs to be described.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribePoliciesRequest	withAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
DescribePoliciesRequest	withMaxRecords(Integer maxRecords) The maximum number of policies that will be described with each call.
DescribePoliciesRequest	withNextToken(String nextToken) A string that is used to mark the start of the next batch of returned results for pagination.
DescribePoliciesRequest	withPolicyNames(Collection<String> policyNames) A list of policy names or policy ARNs to be described.
DescribePoliciesRequest	withPolicyNames(String... policyNames) A list of policy names or policy ARNs to be described.

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

DescribePoliciesRequest

public DescribePoliciesRequest()

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 DescribePoliciesRequest 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.

getPolicyNames

public List<String> getPolicyNames()

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

Returns:

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

setPolicyNames

public void setPolicyNames(Collection<String> policyNames)

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

Parameters:

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

withPolicyNames

public DescribePoliciesRequest withPolicyNames(String... policyNames)

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

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

Parameters:

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

Returns:

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

withPolicyNames

public DescribePoliciesRequest withPolicyNames(Collection<String> policyNames)

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

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

Parameters:

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

Returns:

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

getNextToken

public String getNextToken()

A string that is used to mark the start of the next batch of returned results for pagination.

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

Returns:

A string that is used to mark the start of the next batch of returned results for pagination.

setNextToken

public void setNextToken(String nextToken)

A string that is used to mark the start of the next batch of returned results for pagination.

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

Parameters:

nextToken - A string that is used to mark the start of the next batch of returned results for pagination.

withNextToken

public DescribePoliciesRequest withNextToken(String nextToken)

A string that is used to mark 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: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

nextToken - A string that is used to mark 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.

getMaxRecords

public Integer getMaxRecords()

The maximum number of policies that will be described with each call.

Constraints:
Range: 1 - 50

Returns:

The maximum number of policies that will be described with each call.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of policies that will be described with each call.

Constraints:
Range: 1 - 50

Parameters:

maxRecords - The maximum number of policies that will be described with each call.

withMaxRecords

public DescribePoliciesRequest withMaxRecords(Integer maxRecords)

The maximum number of policies that will be described with each call.

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

Constraints:
Range: 1 - 50

Parameters:

maxRecords - The maximum number of policies that will be described with each 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