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:
  • Constructor Details

    • DescribeScalableTargetsRequest

      public DescribeScalableTargetsRequest()
  • Method Details

    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • getResourceIds

      public List<String> getResourceIds()

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

      public void setResourceIds(Collection<String> resourceIds)

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

      public DescribeScalableTargetsRequest withResourceIds(String... resourceIds)

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

      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 unique identifier string for the resource associated with the scalable target. 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:
      Returns a reference to this object so that method calls can be chained together.
    • withResourceIds

      public DescribeScalableTargetsRequest withResourceIds(Collection<String> resourceIds)

      The unique identifier string for the resource associated with the scalable target. 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:
      resourceIds - The unique identifier string for the resource associated with the scalable target. 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:
      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. 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. If you specify a scalable dimension, you must also specify a resource ID.
      See Also:
    • 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. 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. If you specify a scalable dimension, you must also specify a resource ID.
      See Also:
    • 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. 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. 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:
    • 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. 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. If you specify a scalable dimension, you must also specify a resource ID.
      See Also:
    • 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. 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. 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:
    • 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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: