Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.autoscaling.model
Class DescribeTagsRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.autoscaling.model.DescribeTagsRequest
All Implemented Interfaces:
java.io.Serializable

public class DescribeTagsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the DescribeTags operation.

Lists the Auto Scaling group tags.

You can use filters to limit results when describing tags. For example, you can query for tags of a particular Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.

You can also specify multiple filters. The result includes information for a particular tag only if it matches all your filters. If there's no match, no special message is returned.

See Also:
AmazonAutoScaling.describeTags(DescribeTagsRequest), Serialized Form

Constructor Summary
DescribeTagsRequest()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.util.List<Filter> getFilters()
          The value of the filter type used to identify the tags to be returned.
 java.lang.Integer getMaxRecords()
          The maximum number of records to return.
 java.lang.String getNextToken()
          A string that marks the start of the next batch of returned results.
 int hashCode()
           
 void setFilters(java.util.Collection<Filter> filters)
          The value of the filter type used to identify the tags to be returned.
 void setMaxRecords(java.lang.Integer maxRecords)
          The maximum number of records to return.
 void setNextToken(java.lang.String nextToken)
          A string that marks the start of the next batch of returned results.
 java.lang.String toString()
          Returns a string representation of this object; useful for testing and debugging.
 DescribeTagsRequest withFilters(java.util.Collection<Filter> filters)
          The value of the filter type used to identify the tags to be returned.
 DescribeTagsRequest withFilters(Filter... filters)
          The value of the filter type used to identify the tags to be returned.
 DescribeTagsRequest withMaxRecords(java.lang.Integer maxRecords)
          The maximum number of records to return.
 DescribeTagsRequest withNextToken(java.lang.String nextToken)
          A string that marks the start of the next batch of returned results.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DescribeTagsRequest

public DescribeTagsRequest()
Method Detail

getFilters

public java.util.List<Filter> getFilters()
The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).

Returns:
The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).

setFilters

public void setFilters(java.util.Collection<Filter> filters)
The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).

Parameters:
filters - The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).

withFilters

public DescribeTagsRequest withFilters(Filter... filters)
The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).

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

Parameters:
filters - The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).
Returns:
A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeTagsRequest withFilters(java.util.Collection<Filter> filters)
The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).

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

Parameters:
filters - The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch).
Returns:
A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()
A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Returns:
A string that marks the start of the next batch of returned results.

setNextToken

public void setNextToken(java.lang.String nextToken)
A string that marks the start of the next batch of returned results.

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Parameters:
nextToken - A string that marks the start of the next batch of returned results.

withNextToken

public DescribeTagsRequest withNextToken(java.lang.String nextToken)
A string that marks the start of the next batch of returned results.

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

Constraints:
Pattern: [ -??-??-?\r\n\t]*

Parameters:
nextToken - A string that marks the start of the next batch of returned results.
Returns:
A reference to this updated object so that method calls can be chained together.

getMaxRecords

public java.lang.Integer getMaxRecords()
The maximum number of records to return.

Constraints:
Range: 1 - 50

Returns:
The maximum number of records to return.

setMaxRecords

public void setMaxRecords(java.lang.Integer maxRecords)
The maximum number of records to return.

Constraints:
Range: 1 - 50

Parameters:
maxRecords - The maximum number of records to return.

withMaxRecords

public DescribeTagsRequest withMaxRecords(java.lang.Integer maxRecords)
The maximum number of records to return.

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

Constraints:
Range: 1 - 50

Parameters:
maxRecords - The maximum number of records to return.
Returns:
A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.