com.amazonaws.services.applicationautoscaling.model

Class DescribeScalableTargetsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.applicationautoscaling.model.DescribeScalableTargetsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeScalableTargetsRequest
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
DescribeScalableTargetsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeScalableTargetsRequest	clone()
boolean	equals(Object obj)
Integer	getMaxResults() The maximum number of scalable target results returned by DescribeScalableTargets in paginated output.
String	getNextToken() The NextToken value returned from a previous paginated DescribeScalableTargets request.
List<String>	getResourceIds() The resource type and unique identifier string for the resource associated with the scalable target.
String	getScalableDimension() The scalable dimension associated with the scalable target.
String	getServiceNamespace() The namespace for the AWS service that the scalable target is associated with.
int	hashCode()
void	setMaxResults(Integer maxResults) The maximum number of scalable target results returned by DescribeScalableTargets in paginated output.
void	setNextToken(String nextToken) The NextToken value returned from a previous paginated DescribeScalableTargets request.
void	setResourceIds(Collection<String> resourceIds) The resource type and unique identifier string for the resource associated with the scalable target.
void	setScalableDimension(ScalableDimension scalableDimension) The scalable dimension associated with the scalable target.
void	setScalableDimension(String scalableDimension) The scalable dimension associated with the scalable target.
void	setServiceNamespace(ServiceNamespace serviceNamespace) The namespace for the AWS service that the scalable target is associated with.
void	setServiceNamespace(String serviceNamespace) The namespace for the AWS service that the scalable target is associated with.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeScalableTargetsRequest	withMaxResults(Integer maxResults) The maximum number of scalable target results returned by DescribeScalableTargets in paginated output.
DescribeScalableTargetsRequest	withNextToken(String nextToken) The NextToken value returned from a previous paginated DescribeScalableTargets request.
DescribeScalableTargetsRequest	withResourceIds(Collection<String> resourceIds) The resource type and unique identifier string for the resource associated with the scalable target.
DescribeScalableTargetsRequest	withResourceIds(String... resourceIds) The resource type and unique identifier string for the resource associated with the scalable target.
DescribeScalableTargetsRequest	withScalableDimension(ScalableDimension scalableDimension) The scalable dimension associated with the scalable target.
DescribeScalableTargetsRequest	withScalableDimension(String scalableDimension) The scalable dimension associated with the scalable target.
DescribeScalableTargetsRequest	withServiceNamespace(ServiceNamespace serviceNamespace) The namespace for the AWS service that the scalable target is associated with.
DescribeScalableTargetsRequest	withServiceNamespace(String serviceNamespace) The namespace for the AWS service that the scalable target 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

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeScalableTargetsRequest

public DescribeScalableTargetsRequest()

Method Detail

setServiceNamespace

public void setServiceNamespace(String serviceNamespace)

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

Parameters:

serviceNamespace - The namespace for the AWS service that the scalable target 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 namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Returns:

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

See Also:

ServiceNamespace

withServiceNamespace

public DescribeScalableTargetsRequest withServiceNamespace(String serviceNamespace)

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

Parameters:

serviceNamespace - The namespace for the AWS service that the scalable target 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 namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Parameters:

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

See Also:

ServiceNamespace

withServiceNamespace

public DescribeScalableTargetsRequest withServiceNamespace(ServiceNamespace serviceNamespace)

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

Parameters:

serviceNamespace - The namespace for the AWS service that the scalable target 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

getResourceIds

public List<String> getResourceIds()

The resource type and unique identifier string for the resource associated with the scalable target. 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 resource type and unique identifier string for the resource associated with the scalable target. 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.

setResourceIds

public void setResourceIds(Collection<String> resourceIds)

The resource type and unique identifier string for the resource associated with the scalable target. 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:

resourceIds - The resource type and unique identifier string for the resource associated with the scalable target. 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.

withResourceIds

public DescribeScalableTargetsRequest withResourceIds(String... resourceIds)

The resource type and unique identifier string for the resource associated with the scalable target. 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.

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

Parameters:

resourceIds - The resource type and unique identifier string for the resource associated with the scalable target. 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.

withResourceIds

public DescribeScalableTargetsRequest withResourceIds(Collection<String> resourceIds)

The resource type and unique identifier string for the resource associated with the scalable target. 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:

resourceIds - The resource type and unique identifier string for the resource associated with the scalable target. 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 associated with the scalable target. 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 associated with the scalable target. 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 associated with the scalable target. 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 associated with the scalable target. 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 DescribeScalableTargetsRequest withScalableDimension(String scalableDimension)

The scalable dimension associated with the scalable target. 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 associated with the scalable target. 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 associated with the scalable target. 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 associated with the scalable target. 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 DescribeScalableTargetsRequest withScalableDimension(ScalableDimension scalableDimension)

The scalable dimension associated with the scalable target. 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 associated with the scalable target. 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 scalable target results returned by DescribeScalableTargets in paginated output. When this parameter is used, DescribeScalableTargets 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 DescribeScalableTargets request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalableTargets returns up to 50 results and a NextToken value, if applicable.

Parameters:

maxResults - The maximum number of scalable target results returned by DescribeScalableTargets in paginated output. When this parameter is used, DescribeScalableTargets 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 DescribeScalableTargets request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalableTargets returns up to 50 results and a NextToken value, if applicable.

getMaxResults

public Integer getMaxResults()

The maximum number of scalable target results returned by DescribeScalableTargets in paginated output. When this parameter is used, DescribeScalableTargets 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 DescribeScalableTargets request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalableTargets returns up to 50 results and a NextToken value, if applicable.

Returns:

The maximum number of scalable target results returned by DescribeScalableTargets in paginated output. When this parameter is used, DescribeScalableTargets 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 DescribeScalableTargets request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalableTargets returns up to 50 results and a NextToken value, if applicable.

withMaxResults

public DescribeScalableTargetsRequest withMaxResults(Integer maxResults)

The maximum number of scalable target results returned by DescribeScalableTargets in paginated output. When this parameter is used, DescribeScalableTargets 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 DescribeScalableTargets request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalableTargets returns up to 50 results and a NextToken value, if applicable.

Parameters:

maxResults - The maximum number of scalable target results returned by DescribeScalableTargets in paginated output. When this parameter is used, DescribeScalableTargets 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 DescribeScalableTargets request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalableTargets 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 DescribeScalableTargets 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 DescribeScalableTargets 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 DescribeScalableTargets 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 DescribeScalableTargets 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 DescribeScalableTargetsRequest withNextToken(String nextToken)

The NextToken value returned from a previous paginated DescribeScalableTargets 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 DescribeScalableTargets 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 DescribeScalableTargetsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest