public class DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeTagsRequest>
DescribeTags operation
.
Describes one or more of the tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide .
NOOP
Constructor and Description |
---|
DescribeTagsRequest()
Default constructor for a new DescribeTagsRequest object.
|
DescribeTagsRequest(List<Filter> filters)
Constructs a new DescribeTagsRequest object.
|
Modifier and Type | Method and Description |
---|---|
DescribeTagsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
Request<DescribeTagsRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
List<Filter> |
getFilters()
One or more filters.
|
Integer |
getMaxResults()
The maximum number of results to return for the request in a single
page.
|
String |
getNextToken()
The token to retrieve the next page of results.
|
int |
hashCode() |
void |
setFilters(Collection<Filter> filters)
One or more filters.
|
void |
setMaxResults(Integer maxResults)
The maximum number of results to return for the request in a single
page.
|
void |
setNextToken(String nextToken)
The token to retrieve the next page of results.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeTagsRequest |
withFilters(Collection<Filter> filters)
One or more filters.
|
DescribeTagsRequest |
withFilters(Filter... filters)
One or more filters.
|
DescribeTagsRequest |
withMaxResults(Integer maxResults)
The maximum number of results to return for the request in a single
page.
|
DescribeTagsRequest |
withNextToken(String nextToken)
The token to retrieve the next page of results.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public DescribeTagsRequest()
public DescribeTagsRequest(List<Filter> filters)
filters
- One or more filters. key
-
The tag key.
resource-id
- The resource ID.
resource-type
- The resource type
(customer-gateway
| dhcp-options
|
image
| instance
|
internet-gateway
| network-acl
|
network-interface
| reserved-instances
|
route-table
| security-group
|
snapshot
| spot-instances-request
|
subnet
| volume
| vpc
|
vpn-connection
| vpn-gateway
).
value
- The tag value.
public List<Filter> getFilters()
key
- The tag key.
resource-id
- The resource ID.
resource-type
- The resource type
(customer-gateway
| dhcp-options
|
image
| instance
|
internet-gateway
| network-acl
|
network-interface
| reserved-instances
|
route-table
| security-group
|
snapshot
| spot-instances-request
|
subnet
| volume
| vpc
|
vpn-connection
| vpn-gateway
).
value
- The tag value.
key
- The tag key.
resource-id
- The resource ID.
resource-type
- The resource type
(customer-gateway
| dhcp-options
|
image
| instance
|
internet-gateway
| network-acl
|
network-interface
| reserved-instances
|
route-table
| security-group
|
snapshot
| spot-instances-request
|
subnet
| volume
| vpc
|
vpn-connection
| vpn-gateway
).
value
- The tag value.
public void setFilters(Collection<Filter> filters)
key
- The tag key.
resource-id
- The resource ID.
resource-type
- The resource type
(customer-gateway
| dhcp-options
|
image
| instance
|
internet-gateway
| network-acl
|
network-interface
| reserved-instances
|
route-table
| security-group
|
snapshot
| spot-instances-request
|
subnet
| volume
| vpc
|
vpn-connection
| vpn-gateway
).
value
- The tag value.
filters
- One or more filters. key
- The tag key.
resource-id
- The resource ID.
resource-type
- The resource type
(customer-gateway
| dhcp-options
|
image
| instance
|
internet-gateway
| network-acl
|
network-interface
| reserved-instances
|
route-table
| security-group
|
snapshot
| spot-instances-request
|
subnet
| volume
| vpc
|
vpn-connection
| vpn-gateway
).
value
- The tag value.
public DescribeTagsRequest withFilters(Filter... filters)
key
- The tag key.
resource-id
- The resource ID.
resource-type
- The resource type
(customer-gateway
| dhcp-options
|
image
| instance
|
internet-gateway
| network-acl
|
network-interface
| reserved-instances
|
route-table
| security-group
|
snapshot
| spot-instances-request
|
subnet
| volume
| vpc
|
vpn-connection
| vpn-gateway
).
value
- The tag value.
NOTE: This method appends the values to the existing list (if
any). Use setFilters(java.util.Collection)
or withFilters(java.util.Collection)
if you want to override the
existing values.
Returns a reference to this object so that method calls can be chained together.
filters
- One or more filters. key
- The tag key.
resource-id
- The resource ID.
resource-type
- The resource type
(customer-gateway
| dhcp-options
|
image
| instance
|
internet-gateway
| network-acl
|
network-interface
| reserved-instances
|
route-table
| security-group
|
snapshot
| spot-instances-request
|
subnet
| volume
| vpc
|
vpn-connection
| vpn-gateway
).
value
- The tag value.
public DescribeTagsRequest withFilters(Collection<Filter> filters)
key
- The tag key.
resource-id
- The resource ID.
resource-type
- The resource type
(customer-gateway
| dhcp-options
|
image
| instance
|
internet-gateway
| network-acl
|
network-interface
| reserved-instances
|
route-table
| security-group
|
snapshot
| spot-instances-request
|
subnet
| volume
| vpc
|
vpn-connection
| vpn-gateway
).
value
- The tag value.
Returns a reference to this object so that method calls can be chained together.
filters
- One or more filters. key
- The tag key.
resource-id
- The resource ID.
resource-type
- The resource type
(customer-gateway
| dhcp-options
|
image
| instance
|
internet-gateway
| network-acl
|
network-interface
| reserved-instances
|
route-table
| security-group
|
snapshot
| spot-instances-request
|
subnet
| volume
| vpc
|
vpn-connection
| vpn-gateway
).
value
- The tag value.
public Integer getMaxResults()
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned.NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned.public void setMaxResults(Integer maxResults)
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned.maxResults
- The maximum number of results to return for the request in a single
page. The remaining results of the initial request can be seen by
sending another request with the returned NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned.public DescribeTagsRequest withMaxResults(Integer maxResults)
NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned.
Returns a reference to this object so that method calls can be chained together.
maxResults
- The maximum number of results to return for the request in a single
page. The remaining results of the initial request can be seen by
sending another request with the returned NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000
results are returned.public String getNextToken()
public void setNextToken(String nextToken)
nextToken
- The token to retrieve the next page of results.public DescribeTagsRequest withNextToken(String nextToken)
Returns a reference to this object so that method calls can be chained together.
nextToken
- The token to retrieve the next page of results.public Request<DescribeTagsRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<DescribeTagsRequest>
public String toString()
toString
in class Object
Object.toString()
public DescribeTagsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.