Class DescribeNatGatewaysRequest

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

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

Contains the parameters for DescribeNatGateways.

See Also:
  • Constructor Details

    • DescribeNatGatewaysRequest

      public DescribeNatGatewaysRequest()
  • Method Details

    • getNatGatewayIds

      public List<String> getNatGatewayIds()

      One or more NAT gateway IDs.

      Returns:
      One or more NAT gateway IDs.
    • setNatGatewayIds

      public void setNatGatewayIds(Collection<String> natGatewayIds)

      One or more NAT gateway IDs.

      Parameters:
      natGatewayIds - One or more NAT gateway IDs.
    • withNatGatewayIds

      public DescribeNatGatewaysRequest withNatGatewayIds(String... natGatewayIds)

      One or more NAT gateway IDs.

      NOTE: This method appends the values to the existing list (if any). Use setNatGatewayIds(java.util.Collection) or withNatGatewayIds(java.util.Collection) if you want to override the existing values.

      Parameters:
      natGatewayIds - One or more NAT gateway IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withNatGatewayIds

      public DescribeNatGatewaysRequest withNatGatewayIds(Collection<String> natGatewayIds)

      One or more NAT gateway IDs.

      Parameters:
      natGatewayIds - One or more NAT gateway IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getFilter

      public List<Filter> getFilter()

      One or more filters.

      • nat-gateway-id - The ID of the NAT gateway.

      • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

      • subnet-id - The ID of the subnet in which the NAT gateway resides.

      • vpc-id - The ID of the VPC in which the NAT gateway resides.

      Returns:
      One or more filters.

      • nat-gateway-id - The ID of the NAT gateway.

      • state - The state of the NAT gateway ( pending | failed | available | deleting | deleted).

      • subnet-id - The ID of the subnet in which the NAT gateway resides.

      • vpc-id - The ID of the VPC in which the NAT gateway resides.

    • setFilter

      public void setFilter(Collection<Filter> filter)

      One or more filters.

      • nat-gateway-id - The ID of the NAT gateway.

      • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

      • subnet-id - The ID of the subnet in which the NAT gateway resides.

      • vpc-id - The ID of the VPC in which the NAT gateway resides.

      Parameters:
      filter - One or more filters.

      • nat-gateway-id - The ID of the NAT gateway.

      • state - The state of the NAT gateway ( pending | failed | available | deleting | deleted).

      • subnet-id - The ID of the subnet in which the NAT gateway resides.

      • vpc-id - The ID of the VPC in which the NAT gateway resides.

    • withFilter

      public DescribeNatGatewaysRequest withFilter(Filter... filter)

      One or more filters.

      • nat-gateway-id - The ID of the NAT gateway.

      • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

      • subnet-id - The ID of the subnet in which the NAT gateway resides.

      • vpc-id - The ID of the VPC in which the NAT gateway resides.

      NOTE: This method appends the values to the existing list (if any). Use setFilter(java.util.Collection) or withFilter(java.util.Collection) if you want to override the existing values.

      Parameters:
      filter - One or more filters.

      • nat-gateway-id - The ID of the NAT gateway.

      • state - The state of the NAT gateway ( pending | failed | available | deleting | deleted).

      • subnet-id - The ID of the subnet in which the NAT gateway resides.

      • vpc-id - The ID of the VPC in which the NAT gateway resides.

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

      public DescribeNatGatewaysRequest withFilter(Collection<Filter> filter)

      One or more filters.

      • nat-gateway-id - The ID of the NAT gateway.

      • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

      • subnet-id - The ID of the subnet in which the NAT gateway resides.

      • vpc-id - The ID of the VPC in which the NAT gateway resides.

      Parameters:
      filter - One or more filters.

      • nat-gateway-id - The ID of the NAT gateway.

      • state - The state of the NAT gateway ( pending | failed | available | deleting | deleted).

      • subnet-id - The ID of the subnet in which the NAT gateway resides.

      • vpc-id - The ID of the VPC in which the NAT gateway resides.

      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 items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

      Constraint: If the value specified is greater than 1000, we return only 1000 items.

      Parameters:
      maxResults - The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

      Constraint: If the value specified is greater than 1000, we return only 1000 items.

    • getMaxResults

      public Integer getMaxResults()

      The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

      Constraint: If the value specified is greater than 1000, we return only 1000 items.

      Returns:
      The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

      Constraint: If the value specified is greater than 1000, we return only 1000 items.

    • withMaxResults

      public DescribeNatGatewaysRequest withMaxResults(Integer maxResults)

      The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

      Constraint: If the value specified is greater than 1000, we return only 1000 items.

      Parameters:
      maxResults - The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

      Constraint: If the value specified is greater than 1000, we return only 1000 items.

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