Class DescribeTagsRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.ec2.model.DescribeTagsRequest
All Implemented Interfaces:
ReadLimitInfo, DryRunSupportedRequest<DescribeTagsRequest>, Serializable, Cloneable

public class DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeTagsRequest>

Contains the parameters for DescribeTags.

See Also:
  • 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

      public DescribeTagsRequest(List<Filter> filters)
      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

      public List<Filter> 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

      public void setFilters(Collection<Filter> 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.

      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

      public DescribeTagsRequest withFilters(Filter... 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.

      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.

      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

      public DescribeTagsRequest withFilters(Collection<Filter> 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.

      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

      public void setMaxResults(Integer 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 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 returned NextToken value.
    • getMaxResults

      public Integer 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

      public DescribeTagsRequest withMaxResults(Integer 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 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 returned NextToken value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setNextToken

      public void setNextToken(String nextToken)

      The token to retrieve the next page of results.

      Parameters:
      nextToken - The token to retrieve the next page of results.
    • getNextToken

      public String getNextToken()

      The token to retrieve the next page of results.

      Returns:
      The token to retrieve the next page of results.
    • withNextToken

      public DescribeTagsRequest withNextToken(String nextToken)

      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

      public Request<DescribeTagsRequest> 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 interface DryRunSupportedRequest<DescribeTagsRequest>
    • 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

      public DescribeTagsRequest 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: