com.amazonaws.services.ec2.model.DescribeSubnetsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2014-2019 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.DescribeSubnetsRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSubnetsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* One or more filters.
*
*
* -
*
* availability-zone - The Availability Zone for the subnet. You can also use
* availabilityZone as the filter name.
*
*
* -
*
* availability-zone-id - The ID of the Availability Zone for the subnet. You can also use
* availabilityZoneId as the filter name.
*
*
* -
*
* available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
*
*
* -
*
* cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the
* subnet's CIDR block for information to be returned for the subnet. You can also use cidr or
* cidrBlock as the filter names.
*
*
* -
*
* default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can
* also use defaultForAz as the filter name.
*
*
* -
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated
* with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the subnet.
*
*
* -
*
* state - The state of the subnet (pending | available).
*
*
* -
*
* subnet-arn - The Amazon Resource Name (ARN) of the subnet.
*
*
* -
*
* subnet-id - The ID of the subnet.
*
*
* -
*
* 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 for the subnet.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* One or more subnet IDs.
*
*
* Default: Describes all your subnets.
*
*/
private com.amazonaws.internal.SdkInternalList subnetIds;
/**
*
* One or more filters.
*
*
* -
*
* availability-zone - The Availability Zone for the subnet. You can also use
* availabilityZone as the filter name.
*
*
* -
*
* availability-zone-id - The ID of the Availability Zone for the subnet. You can also use
* availabilityZoneId as the filter name.
*
*
* -
*
* available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
*
*
* -
*
* cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the
* subnet's CIDR block for information to be returned for the subnet. You can also use cidr or
* cidrBlock as the filter names.
*
*
* -
*
* default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can
* also use defaultForAz as the filter name.
*
*
* -
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated
* with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the subnet.
*
*
* -
*
* state - The state of the subnet (pending | available).
*
*
* -
*
* subnet-arn - The Amazon Resource Name (ARN) of the subnet.
*
*
* -
*
* subnet-id - The ID of the subnet.
*
*
* -
*
* 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 for the subnet.
*
*
*
*
* @return One or more filters.
*
* -
*
* availability-zone - The Availability Zone for the subnet. You can also use
* availabilityZone as the filter name.
*
*
* -
*
* availability-zone-id - The ID of the Availability Zone for the subnet. You can also use
* availabilityZoneId as the filter name.
*
*
* -
*
* available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
*
*
* -
*
* cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly
* match the subnet's CIDR block for information to be returned for the subnet. You can also use
* cidr or cidrBlock as the filter names.
*
*
* -
*
* default-for-az - Indicates whether this is the default subnet for the Availability Zone. You
* can also use defaultForAz as the filter name.
*
*
* -
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block
* associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the
* subnet.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the subnet.
*
*
* -
*
* state - The state of the subnet (pending | available).
*
*
* -
*
* subnet-arn - The Amazon Resource Name (ARN) of the subnet.
*
*
* -
*
* subnet-id - The ID of the subnet.
*
*
* -
*
* 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 for the subnet.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more filters.
*
*
* -
*
* availability-zone - The Availability Zone for the subnet. You can also use
* availabilityZone as the filter name.
*
*
* -
*
* availability-zone-id - The ID of the Availability Zone for the subnet. You can also use
* availabilityZoneId as the filter name.
*
*
* -
*
* available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
*
*
* -
*
* cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the
* subnet's CIDR block for information to be returned for the subnet. You can also use cidr or
* cidrBlock as the filter names.
*
*
* -
*
* default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can
* also use defaultForAz as the filter name.
*
*
* -
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated
* with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the subnet.
*
*
* -
*
* state - The state of the subnet (pending | available).
*
*
* -
*
* subnet-arn - The Amazon Resource Name (ARN) of the subnet.
*
*
* -
*
* subnet-id - The ID of the subnet.
*
*
* -
*
* 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 for the subnet.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* availability-zone - The Availability Zone for the subnet. You can also use
* availabilityZone as the filter name.
*
*
* -
*
* availability-zone-id - The ID of the Availability Zone for the subnet. You can also use
* availabilityZoneId as the filter name.
*
*
* -
*
* available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
*
*
* -
*
* cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match
* the subnet's CIDR block for information to be returned for the subnet. You can also use cidr
* or cidrBlock as the filter names.
*
*
* -
*
* default-for-az - Indicates whether this is the default subnet for the Availability Zone. You
* can also use defaultForAz as the filter name.
*
*
* -
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block
* associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the
* subnet.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the subnet.
*
*
* -
*
* state - The state of the subnet (pending | available).
*
*
* -
*
* subnet-arn - The Amazon Resource Name (ARN) of the subnet.
*
*
* -
*
* subnet-id - The ID of the subnet.
*
*
* -
*
* 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 for the subnet.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* One or more filters.
*
*
* -
*
* availability-zone - The Availability Zone for the subnet. You can also use
* availabilityZone as the filter name.
*
*
* -
*
* availability-zone-id - The ID of the Availability Zone for the subnet. You can also use
* availabilityZoneId as the filter name.
*
*
* -
*
* available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
*
*
* -
*
* cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the
* subnet's CIDR block for information to be returned for the subnet. You can also use cidr or
* cidrBlock as the filter names.
*
*
* -
*
* default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can
* also use defaultForAz as the filter name.
*
*
* -
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated
* with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the subnet.
*
*
* -
*
* state - The state of the subnet (pending | available).
*
*
* -
*
* subnet-arn - The Amazon Resource Name (ARN) of the subnet.
*
*
* -
*
* subnet-id - The ID of the subnet.
*
*
* -
*
* 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 for the subnet.
*
*
*
*
* 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
* One or more filters.
*
* -
*
* availability-zone - The Availability Zone for the subnet. You can also use
* availabilityZone as the filter name.
*
*
* -
*
* availability-zone-id - The ID of the Availability Zone for the subnet. You can also use
* availabilityZoneId as the filter name.
*
*
* -
*
* available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
*
*
* -
*
* cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match
* the subnet's CIDR block for information to be returned for the subnet. You can also use cidr
* or cidrBlock as the filter names.
*
*
* -
*
* default-for-az - Indicates whether this is the default subnet for the Availability Zone. You
* can also use defaultForAz as the filter name.
*
*
* -
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block
* associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the
* subnet.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the subnet.
*
*
* -
*
* state - The state of the subnet (pending | available).
*
*
* -
*
* subnet-arn - The Amazon Resource Name (ARN) of the subnet.
*
*
* -
*
* subnet-id - The ID of the subnet.
*
*
* -
*
* 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 for the subnet.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSubnetsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* availability-zone - The Availability Zone for the subnet. You can also use
* availabilityZone as the filter name.
*
*
* -
*
* availability-zone-id - The ID of the Availability Zone for the subnet. You can also use
* availabilityZoneId as the filter name.
*
*
* -
*
* available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
*
*
* -
*
* cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the
* subnet's CIDR block for information to be returned for the subnet. You can also use cidr or
* cidrBlock as the filter names.
*
*
* -
*
* default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can
* also use defaultForAz as the filter name.
*
*
* -
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated
* with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the subnet.
*
*
* -
*
* state - The state of the subnet (pending | available).
*
*
* -
*
* subnet-arn - The Amazon Resource Name (ARN) of the subnet.
*
*
* -
*
* subnet-id - The ID of the subnet.
*
*
* -
*
* 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 for the subnet.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* availability-zone - The Availability Zone for the subnet. You can also use
* availabilityZone as the filter name.
*
*
* -
*
* availability-zone-id - The ID of the Availability Zone for the subnet. You can also use
* availabilityZoneId as the filter name.
*
*
* -
*
* available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
*
*
* -
*
* cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match
* the subnet's CIDR block for information to be returned for the subnet. You can also use cidr
* or cidrBlock as the filter names.
*
*
* -
*
* default-for-az - Indicates whether this is the default subnet for the Availability Zone. You
* can also use defaultForAz as the filter name.
*
*
* -
*
* ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block
* associated with the subnet.
*
*
* -
*
* ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the
* subnet.
*
*
* -
*
* owner-id - The ID of the AWS account that owns the subnet.
*
*
* -
*
* state - The state of the subnet (pending | available).
*
*
* -
*
* subnet-arn - The Amazon Resource Name (ARN) of the subnet.
*
*
* -
*
* subnet-id - The ID of the subnet.
*
*
* -
*
* 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 for the subnet.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSubnetsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* One or more subnet IDs.
*
*
* Default: Describes all your subnets.
*
*
* @return One or more subnet IDs.
*
* Default: Describes all your subnets.
*/
public java.util.List getSubnetIds() {
if (subnetIds == null) {
subnetIds = new com.amazonaws.internal.SdkInternalList();
}
return subnetIds;
}
/**
*
* One or more subnet IDs.
*
*
* Default: Describes all your subnets.
*
*
* @param subnetIds
* One or more subnet IDs.
*
* Default: Describes all your subnets.
*/
public void setSubnetIds(java.util.Collection subnetIds) {
if (subnetIds == null) {
this.subnetIds = null;
return;
}
this.subnetIds = new com.amazonaws.internal.SdkInternalList(subnetIds);
}
/**
*
* One or more subnet IDs.
*
*
* Default: Describes all your subnets.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSubnetIds(java.util.Collection)} or {@link #withSubnetIds(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param subnetIds
* One or more subnet IDs.
*
* Default: Describes all your subnets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSubnetsRequest withSubnetIds(String... subnetIds) {
if (this.subnetIds == null) {
setSubnetIds(new com.amazonaws.internal.SdkInternalList(subnetIds.length));
}
for (String ele : subnetIds) {
this.subnetIds.add(ele);
}
return this;
}
/**
*
* One or more subnet IDs.
*
*
* Default: Describes all your subnets.
*
*
* @param subnetIds
* One or more subnet IDs.
*
* Default: Describes all your subnets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSubnetsRequest withSubnetIds(java.util.Collection subnetIds) {
setSubnetIds(subnetIds);
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 DescribeSubnetsRequestMarshaller().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 (getSubnetIds() != null)
sb.append("SubnetIds: ").append(getSubnetIds());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeSubnetsRequest == false)
return false;
DescribeSubnetsRequest other = (DescribeSubnetsRequest) obj;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getSubnetIds() == null ^ this.getSubnetIds() == null)
return false;
if (other.getSubnetIds() != null && other.getSubnetIds().equals(this.getSubnetIds()) == 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 + ((getSubnetIds() == null) ? 0 : getSubnetIds().hashCode());
return hashCode;
}
@Override
public DescribeSubnetsRequest clone() {
return (DescribeSubnetsRequest) super.clone();
}
}