com.amazonaws.services.applicationautoscaling.model

Class DescribeScalingPoliciesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.applicationautoscaling.model.DescribeScalingPoliciesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeScalingPoliciesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeScalingPoliciesRequest()

Method Summary

Modifier and Type	Method and Description
DescribeScalingPoliciesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Integer	getMaxResults() The maximum number of scaling policy results returned by DescribeScalingPolicies in paginated output.
String	getNextToken() The NextToken value returned from a previous paginated DescribeScalingPolicies request.
List<String>	getPolicyNames() The names of the scaling policies to describe.
String	getResourceId() The unique resource identifier string of the scalable target that the scaling policy is associated with.
String	getScalableDimension() The scalable dimension of the scalable target that the scaling policy is associated with.
String	getServiceNamespace() The AWS service namespace of the scalable target that the scaling policy is associated with.
int	hashCode()
void	setMaxResults(Integer maxResults) The maximum number of scaling policy results returned by DescribeScalingPolicies in paginated output.
void	setNextToken(String nextToken) The NextToken value returned from a previous paginated DescribeScalingPolicies request.
void	setPolicyNames(Collection<String> policyNames) The names of the scaling policies to describe.
void	setResourceId(String resourceId) The unique resource identifier string of the scalable target that the scaling policy is associated with.
void	setScalableDimension(ScalableDimension scalableDimension) The scalable dimension of the scalable target that the scaling policy is associated with.
void	setScalableDimension(String scalableDimension) The scalable dimension of the scalable target that the scaling policy is associated with.
void	setServiceNamespace(ServiceNamespace serviceNamespace) The AWS service namespace of the scalable target that the scaling policy is associated with.
void	setServiceNamespace(String serviceNamespace) The AWS service namespace of the scalable target that the scaling policy is associated with.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeScalingPoliciesRequest	withMaxResults(Integer maxResults) The maximum number of scaling policy results returned by DescribeScalingPolicies in paginated output.
DescribeScalingPoliciesRequest	withNextToken(String nextToken) The NextToken value returned from a previous paginated DescribeScalingPolicies request.
DescribeScalingPoliciesRequest	withPolicyNames(Collection<String> policyNames) The names of the scaling policies to describe.
DescribeScalingPoliciesRequest	withPolicyNames(String... policyNames) The names of the scaling policies to describe.
DescribeScalingPoliciesRequest	withResourceId(String resourceId) The unique resource identifier string of the scalable target that the scaling policy is associated with.
DescribeScalingPoliciesRequest	withScalableDimension(ScalableDimension scalableDimension) The scalable dimension of the scalable target that the scaling policy is associated with.
DescribeScalingPoliciesRequest	withScalableDimension(String scalableDimension) The scalable dimension of the scalable target that the scaling policy is associated with.
DescribeScalingPoliciesRequest	withServiceNamespace(ServiceNamespace serviceNamespace) The AWS service namespace of the scalable target that the scaling policy is associated with.
DescribeScalingPoliciesRequest	withServiceNamespace(String serviceNamespace) The AWS service namespace of the scalable target that the scaling policy is associated with.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeScalingPoliciesRequest

public DescribeScalingPoliciesRequest()

Method Detail

getPolicyNames

public List<String> getPolicyNames()

The names of the scaling policies to describe.

Returns:

The names of the scaling policies to describe.

setPolicyNames

public void setPolicyNames(Collection<String> policyNames)

The names of the scaling policies to describe.

Parameters:

policyNames - The names of the scaling policies to describe.

withPolicyNames

public DescribeScalingPoliciesRequest withPolicyNames(String... policyNames)

The names of the scaling policies to describe.

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.

Parameters:

policyNames - The names of the scaling policies to describe.

Returns:

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

withPolicyNames

public DescribeScalingPoliciesRequest withPolicyNames(Collection<String> policyNames)

The names of the scaling policies to describe.

Parameters:

policyNames - The names of the scaling policies to describe.

Returns:

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

setServiceNamespace

public void setServiceNamespace(String serviceNamespace)

The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Parameters:

serviceNamespace - The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

See Also:

ServiceNamespace

getServiceNamespace

public String getServiceNamespace()

The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Returns:

The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

See Also:

ServiceNamespace

withServiceNamespace

public DescribeScalingPoliciesRequest withServiceNamespace(String serviceNamespace)

The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Parameters:

serviceNamespace - The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Returns:

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

See Also:

ServiceNamespace

setServiceNamespace

public void setServiceNamespace(ServiceNamespace serviceNamespace)

The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Parameters:

serviceNamespace - The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

See Also:

ServiceNamespace

withServiceNamespace

public DescribeScalingPoliciesRequest withServiceNamespace(ServiceNamespace serviceNamespace)

The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Parameters:

serviceNamespace - The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Returns:

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

See Also:

ServiceNamespace

setResourceId

public void setResourceId(String resourceId)

The unique resource identifier string of the scalable target that the scaling policy is associated with. For Amazon ECS services, the resource type is services, and the identifier is the cluster name and service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example, spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. If you specify a scalable dimension, you must also specify a resource ID.

Parameters:

resourceId - The unique resource identifier string of the scalable target that the scaling policy is associated with. For Amazon ECS services, the resource type is services, and the identifier is the cluster name and service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example, spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. If you specify a scalable dimension, you must also specify a resource ID.

getResourceId

public String getResourceId()

The unique resource identifier string of the scalable target that the scaling policy is associated with. For Amazon ECS services, the resource type is services, and the identifier is the cluster name and service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example, spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. If you specify a scalable dimension, you must also specify a resource ID.

Returns:

The unique resource identifier string of the scalable target that the scaling policy is associated with. For Amazon ECS services, the resource type is services, and the identifier is the cluster name and service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example, spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. If you specify a scalable dimension, you must also specify a resource ID.

withResourceId

public DescribeScalingPoliciesRequest withResourceId(String resourceId)

The unique resource identifier string of the scalable target that the scaling policy is associated with. For Amazon ECS services, the resource type is services, and the identifier is the cluster name and service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example, spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. If you specify a scalable dimension, you must also specify a resource ID.

Parameters:

resourceId - The unique resource identifier string of the scalable target that the scaling policy is associated with. For Amazon ECS services, the resource type is services, and the identifier is the cluster name and service name; for example, service/default/sample-webapp. For Amazon EC2 Spot fleet requests, the resource type is spot-fleet-request, and the identifier is the Spot fleet request ID; for example, spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE. If you specify a scalable dimension, you must also specify a resource ID.

Returns:

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

setScalableDimension

public void setScalableDimension(String scalableDimension)

The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.

Parameters:

scalableDimension - The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.

See Also:

ScalableDimension

getScalableDimension

public String getScalableDimension()

The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.

Returns:

The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.

See Also:

ScalableDimension

withScalableDimension

public DescribeScalingPoliciesRequest withScalableDimension(String scalableDimension)

The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.

Parameters:

scalableDimension - The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.

Returns:

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

See Also:

ScalableDimension

setScalableDimension

public void setScalableDimension(ScalableDimension scalableDimension)

The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.

Parameters:

scalableDimension - The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.

See Also:

ScalableDimension

withScalableDimension

public DescribeScalingPoliciesRequest withScalableDimension(ScalableDimension scalableDimension)

The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.

Parameters:

scalableDimension - The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service, or ec2:spot-fleet-request:TargetCapacity for the target capacity of an Amazon EC2 Spot fleet request. If you specify a scalable dimension, you must also specify a resource ID.

Returns:

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

See Also:

ScalableDimension

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of scaling policy results returned by DescribeScalingPolicies in paginated output. When this parameter is used, DescribeScalingPolicies returns up to MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeScalingPolicies request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalingPolicies returns up to 50 results and a NextToken value, if applicable.

Parameters:

maxResults - The maximum number of scaling policy results returned by DescribeScalingPolicies in paginated output. When this parameter is used, DescribeScalingPolicies returns up to MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeScalingPolicies request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalingPolicies returns up to 50 results and a NextToken value, if applicable.

getMaxResults

public Integer getMaxResults()

The maximum number of scaling policy results returned by DescribeScalingPolicies in paginated output. When this parameter is used, DescribeScalingPolicies returns up to MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeScalingPolicies request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalingPolicies returns up to 50 results and a NextToken value, if applicable.

Returns:

The maximum number of scaling policy results returned by DescribeScalingPolicies in paginated output. When this parameter is used, DescribeScalingPolicies returns up to MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeScalingPolicies request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalingPolicies returns up to 50 results and a NextToken value, if applicable.

withMaxResults

public DescribeScalingPoliciesRequest withMaxResults(Integer maxResults)

The maximum number of scaling policy results returned by DescribeScalingPolicies in paginated output. When this parameter is used, DescribeScalingPolicies returns up to MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeScalingPolicies request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalingPolicies returns up to 50 results and a NextToken value, if applicable.

Parameters:

maxResults - The maximum number of scaling policy results returned by DescribeScalingPolicies in paginated output. When this parameter is used, DescribeScalingPolicies returns up to MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeScalingPolicies request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalingPolicies returns up to 50 results and a NextToken value, if applicable.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The NextToken value returned from a previous paginated DescribeScalingPolicies request. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Parameters:

nextToken - The NextToken value returned from a previous paginated DescribeScalingPolicies request. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

getNextToken

public String getNextToken()

The NextToken value returned from a previous paginated DescribeScalingPolicies request. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Returns:

The NextToken value returned from a previous paginated DescribeScalingPolicies request. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

withNextToken

public DescribeScalingPoliciesRequest withNextToken(String nextToken)

The NextToken value returned from a previous paginated DescribeScalingPolicies request. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Parameters:

nextToken - The NextToken value returned from a previous paginated DescribeScalingPolicies request. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeScalingPoliciesRequest 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()