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 Description DescribeScalingPoliciesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeScalingPoliciesRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Integer
getMaxResults()
The maximum number of scaling policy results returned byDescribeScalingPolicies
in paginated output.String
getNextToken()
TheNextToken
value returned from a previous paginatedDescribeScalingPolicies
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 byDescribeScalingPolicies
in paginated output.void
setNextToken(String nextToken)
TheNextToken
value returned from a previous paginatedDescribeScalingPolicies
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 byDescribeScalingPolicies
in paginated output.DescribeScalingPoliciesRequest
withNextToken(String nextToken)
TheNextToken
value returned from a previous paginatedDescribeScalingPolicies
request.DescribeScalingPoliciesRequest
withPolicyNames(String... policyNames)
The names of the scaling policies to describe.DescribeScalingPoliciesRequest
withPolicyNames(Collection<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
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
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)
orwithPolicyNames(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, this value is the resource type, followed by the cluster name and service name, such as
service/default/sample-webapp
. 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, this value is the resource type, followed by the cluster name and service name, such asservice/default/sample-webapp
. 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, this value is the resource type, followed by the cluster name and service name, such as
service/default/sample-webapp
. 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,
this value is the resource type, followed by the cluster name and
service name, such as
service/default/sample-webapp
. 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, this value is the resource type, followed by the cluster name and service name, such as
service/default/sample-webapp
. 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, this value is the resource type, followed by the cluster name and service name, such asservice/default/sample-webapp
. 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. 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 asecs:service:DesiredCount
for the desired task count of an Amazon ECS service. 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. 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. 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. 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 asecs:service:DesiredCount
for the desired task count of an Amazon ECS service. 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. 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 asecs:service:DesiredCount
for the desired task count of an Amazon ECS service. 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. 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 asecs:service:DesiredCount
for the desired task count of an Amazon ECS service. 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 toMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeScalingPolicies
request with the returnedNextToken
value. This value can be between 1 and 50. If this parameter is not used, thenDescribeScalingPolicies
returns up to 50 results and aNextToken
value, if applicable.- Parameters:
maxResults
- The maximum number of scaling policy results returned byDescribeScalingPolicies
in paginated output. When this parameter is used,DescribeScalingPolicies
returns up toMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeScalingPolicies
request with the returnedNextToken
value. This value can be between 1 and 50. If this parameter is not used, thenDescribeScalingPolicies
returns up to 50 results and aNextToken
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 toMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeScalingPolicies
request with the returnedNextToken
value. This value can be between 1 and 50. If this parameter is not used, thenDescribeScalingPolicies
returns up to 50 results and aNextToken
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 toMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeScalingPolicies
request with the returnedNextToken
value. This value can be between 1 and 50. If this parameter is not used, thenDescribeScalingPolicies
returns up to 50 results and aNextToken
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 toMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeScalingPolicies
request with the returnedNextToken
value. This value can be between 1 and 50. If this parameter is not used, thenDescribeScalingPolicies
returns up to 50 results and aNextToken
value, if applicable.- Parameters:
maxResults
- The maximum number of scaling policy results returned byDescribeScalingPolicies
in paginated output. When this parameter is used,DescribeScalingPolicies
returns up toMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeScalingPolicies
request with the returnedNextToken
value. This value can be between 1 and 50. If this parameter is not used, thenDescribeScalingPolicies
returns up to 50 results and aNextToken
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 paginatedDescribeScalingPolicies
request. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.- Parameters:
nextToken
- TheNextToken
value returned from a previous paginatedDescribeScalingPolicies
request. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.
-
getNextToken
public String getNextToken()
The
NextToken
value returned from a previous paginatedDescribeScalingPolicies
request. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.- Returns:
- The
NextToken
value returned from a previous paginatedDescribeScalingPolicies
request. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.
-
withNextToken
public DescribeScalingPoliciesRequest withNextToken(String nextToken)
The
NextToken
value returned from a previous paginatedDescribeScalingPolicies
request. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.- Parameters:
nextToken
- TheNextToken
value returned from a previous paginatedDescribeScalingPolicies
request. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-