Class DescribeTagsRequest
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<DescribeTagsRequest>
,Serializable
,Cloneable
Contains the parameters for DescribeTags.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for DescribeTagsRequest object.DescribeTagsRequest
(List<Filter> filters) Constructs a new DescribeTagsRequest object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
This method is intended for internal use only.One or more filters.The maximum number of results to return in a single call.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 in a single call.void
setNextToken
(String nextToken) The token to retrieve the next page of results.toString()
Returns a string representation of this object; useful for testing and debugging.withFilters
(Filter... filters) One or more filters.withFilters
(Collection<Filter> filters) One or more filters.withMaxResults
(Integer maxResults) The maximum number of results to return in a single call.withNextToken
(String nextToken) The token to retrieve the next page of results.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
-
Constructor Details
-
DescribeTagsRequest
public DescribeTagsRequest()Default constructor for DescribeTagsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
DescribeTagsRequest
Constructs a new DescribeTagsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
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.
-
-
-
Method Details
-
getFilters
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.
- Returns:
- 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.
-
-
-
setFilters
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.
- Parameters:
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.
-
-
-
withFilters
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.
NOTE: This method appends the values to the existing list (if any). Use
setFilters(java.util.Collection)
orwithFilters(java.util.Collection)
if you want to override the existing values.- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
withFilters
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setMaxResults
The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned
NextToken
value.- Parameters:
maxResults
- The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returnedNextToken
value.
-
getMaxResults
The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned
NextToken
value.- Returns:
- The maximum number of results to return in a single call. This
value can be between 5 and 1000. To retrieve the remaining
results, make another call with the returned
NextToken
value.
-
withMaxResults
The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned
NextToken
value.- Parameters:
maxResults
- The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returnedNextToken
value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextToken
The token to retrieve the next page of results.
- Parameters:
nextToken
- The token to retrieve the next page of results.
-
getNextToken
The token to retrieve the next page of results.
- Returns:
- The token to retrieve the next page of results.
-
withNextToken
The token to retrieve the next page of results.
- Parameters:
nextToken
- The token to retrieve the next page of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDryRunRequest
This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.- Specified by:
getDryRunRequest
in interfaceDryRunSupportedRequest<DescribeTagsRequest>
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-