com.amazonaws.services.ec2.model.DescribeNatGatewaysRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeNatGatewaysRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeNatGatewaysRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The 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.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* vpc-id - The ID of the VPC in which the NAT gateway resides.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filter;
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*/
private Integer maxResults;
/**
*
* The IDs of the NAT gateways.
*
*/
private com.amazonaws.internal.SdkInternalList natGatewayIds;
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*/
private String nextToken;
/**
*
* The 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.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* vpc-id - The ID of the VPC in which the NAT gateway resides.
*
*
*
*
* @return The 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.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that
* have a tag with the key Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* vpc-id - The ID of the VPC in which the NAT gateway resides.
*
*
*/
public java.util.List getFilter() {
if (filter == null) {
filter = new com.amazonaws.internal.SdkInternalList();
}
return filter;
}
/**
*
* The 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.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* vpc-id - The ID of the VPC in which the NAT gateway resides.
*
*
*
*
* @param filter
* The 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.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* vpc-id - The ID of the VPC in which the NAT gateway resides.
*
*
*/
public void setFilter(java.util.Collection filter) {
if (filter == null) {
this.filter = null;
return;
}
this.filter = new com.amazonaws.internal.SdkInternalList(filter);
}
/**
*
* The 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.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* 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
* {@link #setFilter(java.util.Collection)} or {@link #withFilter(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param filter
* The 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.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* vpc-id - The ID of the VPC in which the NAT gateway resides.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNatGatewaysRequest withFilter(Filter... filter) {
if (this.filter == null) {
setFilter(new com.amazonaws.internal.SdkInternalList(filter.length));
}
for (Filter ele : filter) {
this.filter.add(ele);
}
return this;
}
/**
*
* The 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.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* vpc-id - The ID of the VPC in which the NAT gateway resides.
*
*
*
*
* @param filter
* The 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.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* vpc-id - The ID of the VPC in which the NAT gateway resides.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNatGatewaysRequest withFilter(java.util.Collection filter) {
setFilter(filter);
return this;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @return The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNatGatewaysRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The IDs of the NAT gateways.
*
*
* @return The IDs of the NAT gateways.
*/
public java.util.List getNatGatewayIds() {
if (natGatewayIds == null) {
natGatewayIds = new com.amazonaws.internal.SdkInternalList();
}
return natGatewayIds;
}
/**
*
* The IDs of the NAT gateways.
*
*
* @param natGatewayIds
* The IDs of the NAT gateways.
*/
public void setNatGatewayIds(java.util.Collection natGatewayIds) {
if (natGatewayIds == null) {
this.natGatewayIds = null;
return;
}
this.natGatewayIds = new com.amazonaws.internal.SdkInternalList(natGatewayIds);
}
/**
*
* The IDs of the NAT gateways.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setNatGatewayIds(java.util.Collection)} or {@link #withNatGatewayIds(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param natGatewayIds
* The IDs of the NAT gateways.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNatGatewaysRequest withNatGatewayIds(String... natGatewayIds) {
if (this.natGatewayIds == null) {
setNatGatewayIds(new com.amazonaws.internal.SdkInternalList(natGatewayIds.length));
}
for (String ele : natGatewayIds) {
this.natGatewayIds.add(ele);
}
return this;
}
/**
*
* The IDs of the NAT gateways.
*
*
* @param natGatewayIds
* The IDs of the NAT gateways.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNatGatewaysRequest withNatGatewayIds(java.util.Collection natGatewayIds) {
setNatGatewayIds(natGatewayIds);
return this;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @return The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNatGatewaysRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new DescribeNatGatewaysRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFilter() != null)
sb.append("Filter: ").append(getFilter()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNatGatewayIds() != null)
sb.append("NatGatewayIds: ").append(getNatGatewayIds()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeNatGatewaysRequest == false)
return false;
DescribeNatGatewaysRequest other = (DescribeNatGatewaysRequest) obj;
if (other.getFilter() == null ^ this.getFilter() == null)
return false;
if (other.getFilter() != null && other.getFilter().equals(this.getFilter()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNatGatewayIds() == null ^ this.getNatGatewayIds() == null)
return false;
if (other.getNatGatewayIds() != null && other.getNatGatewayIds().equals(this.getNatGatewayIds()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFilter() == null) ? 0 : getFilter().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNatGatewayIds() == null) ? 0 : getNatGatewayIds().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribeNatGatewaysRequest clone() {
return (DescribeNatGatewaysRequest) super.clone();
}
}