/* * Copyright 2018-2023 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.DescribeVpcsRequestMarshaller; /** * */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeVpcsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest { /** *

* The filters. *

*
* cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the * VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits * (for example, /28). *
*
*
* cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC. *
*
*
* cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with * the VPC. *
*
*
* cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC. *
*
*
* dhcp-options-id - The ID of a set of DHCP options. *
*
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC. *
*
*
* ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR * block is allocated. *
*
*
* ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated * with the VPC. *
*
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC. *
*
*
* is-default - Indicates whether the VPC is the default VPC. *
*
*
* owner-id - The ID of the Amazon Web Services account that owns the VPC. *
*
*
* state - The state of the VPC (pending | available). *
*
*
* 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. *
*

*/ private com.amazonaws.internal.SdkInternalList filters; /** *

* The IDs of the VPCs. *

* Default: Describes all your VPCs. *

*/ private com.amazonaws.internal.SdkInternalList vpcIds; /** *

* 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 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 filters. *

*
* cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the * VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits * (for example, /28). *
*
*
* cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC. *
*
*
* cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with * the VPC. *
*
*
* cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC. *
*
*
* dhcp-options-id - The ID of a set of DHCP options. *
*
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC. *
*
*
* ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR * block is allocated. *
*
*
* ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated * with the VPC. *
*
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC. *
*
*
* is-default - Indicates whether the VPC is the default VPC. *
*
*
* owner-id - The ID of the Amazon Web Services account that owns the VPC. *
*
*
* state - The state of the VPC (pending | available). *
*
*
* 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. *
*

* * @return The filters.

*
* cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match * the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one * or two digits (for example, /28). *
*
*
* cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC. *
*
*
* cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated * with the VPC. *
*
*
* cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC. *
*
*
* dhcp-options-id - The ID of a set of DHCP options. *
*
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC. *
*
*
* ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 * CIDR block is allocated. *
*
*
* ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block * associated with the VPC. *
*
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC. *
*
*
* is-default - Indicates whether the VPC is the default VPC. *
*
*
* owner-id - The ID of the Amazon Web Services account that owns the VPC. *
*
*
* state - The state of the VPC (pending | available). *
*
*
* 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. *
*

getFilters() { if (filters == null) { filters = new com.amazonaws.internal.SdkInternalList(); } return filters; } /** *

* The filters. *

*
* cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the * VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits * (for example, /28). *
*
*
* cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC. *
*
*
* cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with * the VPC. *
*
*
* cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC. *
*
*
* dhcp-options-id - The ID of a set of DHCP options. *
*
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC. *
*
*
* ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR * block is allocated. *
*
*
* ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated * with the VPC. *
*
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC. *
*
*
* is-default - Indicates whether the VPC is the default VPC. *
*
*
* owner-id - The ID of the Amazon Web Services account that owns the VPC. *
*
*
* state - The state of the VPC (pending | available). *
*
*
* 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. *
*

* * @param filters * The filters.

*
* cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match * the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or * two digits (for example, /28). *
*
*
* cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC. *
*
*
* cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated * with the VPC. *
*
*
* cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC. *
*
*
* dhcp-options-id - The ID of a set of DHCP options. *
*
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC. *
*
*
* ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 * CIDR block is allocated. *
*
*
* ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block * associated with the VPC. *
*
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC. *
*
*
* is-default - Indicates whether the VPC is the default VPC. *
*
*
* owner-id - The ID of the Amazon Web Services account that owns the VPC. *
*
*
* state - The state of the VPC (pending | available). *
*
*
* 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. *
*

filters) { if (filters == null) { this.filters = null; return; } this.filters = new com.amazonaws.internal.SdkInternalList(filters); } /** *

* The filters. *

*
* cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the * VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits * (for example, /28). *
*
*
* cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC. *
*
*
* cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with * the VPC. *
*
*
* cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC. *
*
*
* dhcp-options-id - The ID of a set of DHCP options. *
*
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC. *
*
*
* ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR * block is allocated. *
*
*
* ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated * with the VPC. *
*
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC. *
*
*
* is-default - Indicates whether the VPC is the default VPC. *
*
*
* owner-id - The ID of the Amazon Web Services account that owns the VPC. *
*
*
* state - The state of the VPC (pending | available). *
*
*
* 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. *
*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override * the existing values. *

* * @param filters * The filters.

*
* cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match * the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or * two digits (for example, /28). *
*
*
* cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC. *
*
*
* cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated * with the VPC. *
*
*
* cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC. *
*
*
* dhcp-options-id - The ID of a set of DHCP options. *
*
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC. *
*
*
* ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 * CIDR block is allocated. *
*
*
* ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block * associated with the VPC. *
*
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC. *
*
*
* is-default - Indicates whether the VPC is the default VPC. *
*
*
* owner-id - The ID of the Amazon Web Services account that owns the VPC. *
*
*
* state - The state of the VPC (pending | available). *
*
*
* 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. *
*

(filters.length)); } for (Filter ele : filters) { this.filters.add(ele); } return this; } /** *

* The filters. *

*
* cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the * VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits * (for example, /28). *
*
*
* cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC. *
*
*
* cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with * the VPC. *
*
*
* cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC. *
*
*
* dhcp-options-id - The ID of a set of DHCP options. *
*
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC. *
*
*
* ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR * block is allocated. *
*
*
* ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated * with the VPC. *
*
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC. *
*
*
* is-default - Indicates whether the VPC is the default VPC. *
*
*
* owner-id - The ID of the Amazon Web Services account that owns the VPC. *
*
*
* state - The state of the VPC (pending | available). *
*
*
* 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. *
*

* * @param filters * The filters.

*
* cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match * the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or * two digits (for example, /28). *
*
*
* cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC. *
*
*
* cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated * with the VPC. *
*
*
* cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC. *
*
*
* dhcp-options-id - The ID of a set of DHCP options. *
*
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC. *
*
*
* ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 * CIDR block is allocated. *
*
*
* ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block * associated with the VPC. *
*
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC. *
*
*
* is-default - Indicates whether the VPC is the default VPC. *
*
*
* owner-id - The ID of the Amazon Web Services account that owns the VPC. *
*
*
* state - The state of the VPC (pending | available). *
*
*
* 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. *
*

filters) { setFilters(filters); return this; } /** *

* The IDs of the VPCs. *

* Default: Describes all your VPCs. *

* * @return The IDs of the VPCs.

* Default: Describes all your VPCs. */ public java.util.List getVpcIds() { if (vpcIds == null) { vpcIds = new com.amazonaws.internal.SdkInternalList(); } return vpcIds; } /** *

* The IDs of the VPCs. *

* Default: Describes all your VPCs. *

* * @param vpcIds * The IDs of the VPCs.

* Default: Describes all your VPCs. */ public void setVpcIds(java.util.Collection vpcIds) { if (vpcIds == null) { this.vpcIds = null; return; } this.vpcIds = new com.amazonaws.internal.SdkInternalList(vpcIds); } /** *

* The IDs of the VPCs. *

* Default: Describes all your VPCs. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setVpcIds(java.util.Collection)} or {@link #withVpcIds(java.util.Collection)} if you want to override the * existing values. *

* * @param vpcIds * The IDs of the VPCs.

* Default: Describes all your VPCs. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeVpcsRequest withVpcIds(String... vpcIds) { if (this.vpcIds == null) { setVpcIds(new com.amazonaws.internal.SdkInternalList(vpcIds.length)); } for (String ele : vpcIds) { this.vpcIds.add(ele); } return this; } /** *

* The IDs of the VPCs. *

* Default: Describes all your VPCs. *

* * @param vpcIds * The IDs of the VPCs.

* Default: Describes all your VPCs. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeVpcsRequest withVpcIds(java.util.Collection vpcIds) { setVpcIds(vpcIds); 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 DescribeVpcsRequest withNextToken(String nextToken) { setNextToken(nextToken); 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. *

* * @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 DescribeVpcsRequest withMaxResults(Integer maxResults) { setMaxResults(maxResults); 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 DescribeVpcsRequestMarshaller().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 (getFilters() != null) sb.append("Filters: ").append(getFilters()).append(","); if (getVpcIds() != null) sb.append("VpcIds: ").append(getVpcIds()).append(","); if (getNextToken() != null) sb.append("NextToken: ").append(getNextToken()).append(","); if (getMaxResults() != null) sb.append("MaxResults: ").append(getMaxResults()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DescribeVpcsRequest == false) return false; DescribeVpcsRequest other = (DescribeVpcsRequest) obj; if (other.getFilters() == null ^ this.getFilters() == null) return false; if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false; if (other.getVpcIds() == null ^ this.getVpcIds() == null) return false; if (other.getVpcIds() != null && other.getVpcIds().equals(this.getVpcIds()) == false) return false; if (other.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false; if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); hashCode = prime * hashCode + ((getVpcIds() == null) ? 0 : getVpcIds().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); return hashCode; } @Override public DescribeVpcsRequest clone() { return (DescribeVpcsRequest) super.clone(); } }