com.amazonaws.services.autoscaling.model

Class DescribePoliciesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.DescribePoliciesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribePoliciesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribePolicies operation.

Describes the policies for the specified Auto Scaling group.

See Also:

AmazonAutoScaling.describePolicies(DescribePoliciesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribePoliciesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribePoliciesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAutoScalingGroupName() The name of the group.
Integer	getMaxRecords() The maximum number of items to be returned with each call.
String	getNextToken() The token for the next set of items to return.
List<String>	getPolicyNames() One or more policy names or policy ARNs to be described.
List<String>	getPolicyTypes() One or more policy types.
int	hashCode()
void	setAutoScalingGroupName(String autoScalingGroupName) The name of the group.
void	setMaxRecords(Integer maxRecords) The maximum number of items to be returned with each call.
void	setNextToken(String nextToken) The token for the next set of items to return.
void	setPolicyNames(Collection<String> policyNames) One or more policy names or policy ARNs to be described.
void	setPolicyTypes(Collection<String> policyTypes) One or more policy types.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribePoliciesRequest	withAutoScalingGroupName(String autoScalingGroupName) The name of the group.
DescribePoliciesRequest	withMaxRecords(Integer maxRecords) The maximum number of items to be returned with each call.
DescribePoliciesRequest	withNextToken(String nextToken) The token for the next set of items to return.
DescribePoliciesRequest	withPolicyNames(Collection<String> policyNames) One or more policy names or policy ARNs to be described.
DescribePoliciesRequest	withPolicyNames(String... policyNames) One or more policy names or policy ARNs to be described.
DescribePoliciesRequest	withPolicyTypes(Collection<String> policyTypes) One or more policy types.
DescribePoliciesRequest	withPolicyTypes(String... policyTypes) One or more policy types.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribePoliciesRequest

public DescribePoliciesRequest()

Method Detail

getAutoScalingGroupName

public String getAutoScalingGroupName()

The name of the group.

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

Returns:

The name of the group.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name of the group.

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

Parameters:

autoScalingGroupName - The name of the group.

withAutoScalingGroupName

public DescribePoliciesRequest withAutoScalingGroupName(String autoScalingGroupName)

The name of the group.

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

Returns:

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

getPolicyNames

public List<String> getPolicyNames()

One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

Returns:

One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

setPolicyNames

public void setPolicyNames(Collection<String> policyNames)

One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

Parameters:

policyNames - One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

withPolicyNames

public DescribePoliciesRequest withPolicyNames(String... policyNames)

One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

NOTE: This method appends the values to the existing list (if any). Use setPolicyNames(java.util.Collection) or withPolicyNames(java.util.Collection) if you want to override the existing values.

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

Parameters:

policyNames - One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is 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)

One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

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

Parameters:

policyNames - One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

Returns:

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

getPolicyTypes

public List<String> getPolicyTypes()

One or more policy types. Valid values are SimpleScaling and StepScaling.

Returns:

One or more policy types. Valid values are SimpleScaling and StepScaling.

setPolicyTypes

public void setPolicyTypes(Collection<String> policyTypes)

One or more policy types. Valid values are SimpleScaling and StepScaling.

Parameters:

policyTypes - One or more policy types. Valid values are SimpleScaling and StepScaling.

withPolicyTypes

public DescribePoliciesRequest withPolicyTypes(String... policyTypes)

One or more policy types. Valid values are SimpleScaling and StepScaling.

NOTE: This method appends the values to the existing list (if any). Use setPolicyTypes(java.util.Collection) or withPolicyTypes(java.util.Collection) if you want to override the existing values.

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

Parameters:

policyTypes - One or more policy types. Valid values are SimpleScaling and StepScaling.

Returns:

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

withPolicyTypes

public DescribePoliciesRequest withPolicyTypes(Collection<String> policyTypes)

One or more policy types. Valid values are SimpleScaling and StepScaling.

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

Parameters:

policyTypes - One or more policy types. Valid values are SimpleScaling and StepScaling.

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

getMaxRecords

public Integer getMaxRecords()

The maximum number of items to be returned with each call.

Returns:

The maximum number of items to be returned with each call.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of items to be returned with each call.

Parameters:

maxRecords - The maximum number of items to be returned with each call.

withMaxRecords

public DescribePoliciesRequest withMaxRecords(Integer maxRecords)

The maximum number of items to be returned with each call.

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

Parameters:

maxRecords - The maximum number of items to be returned 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

clone

public DescribePoliciesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()