com.amazonaws.services.ec2.model.DescribeNetworkAclsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2011-2016 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 com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeNetworkAclsRequestMarshaller;
/**
*
* Contains the parameters for DescribeNetworkAcls.
*
*/
public class DescribeNetworkAclsRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* One or more network ACL IDs.
*
*
* Default: Describes all your network ACLs.
*
*/
private com.amazonaws.internal.SdkInternalList networkAclIds;
/**
*
* One or more filters.
*
*
* -
*
* association.association-id - The ID of an association ID for
* the ACL.
*
*
* -
*
* association.network-acl-id - The ID of the network ACL
* involved in the association.
*
*
* -
*
* association.subnet-id - The ID of the subnet involved in the
* association.
*
*
* -
*
* default - Indicates whether the ACL is the default network
* ACL for the VPC.
*
*
* -
*
* entry.cidr - The CIDR range specified in the entry.
*
*
* -
*
* entry.egress - Indicates whether the entry applies to egress
* traffic.
*
*
* -
*
* entry.icmp.code - The ICMP code specified in the entry, if
* any.
*
*
* -
*
* entry.icmp.type - The ICMP type specified in the entry, if
* any.
*
*
* -
*
* entry.port-range.from - The start of the port range
* specified in the entry.
*
*
* -
*
* entry.port-range.to - The end of the port range specified in
* the entry.
*
*
* -
*
* entry.protocol - The protocol specified in the entry (
* tcp | udp | icmp or a protocol
* number).
*
*
* -
*
* entry.rule-action - Allows or denies the matching traffic (
* allow | deny).
*
*
* -
*
* entry.rule-number - The number of an entry (in other words,
* rule) in the ACL's set of entries.
*
*
* -
*
* network-acl-id - The ID of the network ACL.
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* vpc-id - The ID of the VPC for the network ACL.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* One or more network ACL IDs.
*
*
* Default: Describes all your network ACLs.
*
*
* @return One or more network ACL IDs.
*
* Default: Describes all your network ACLs.
*/
public java.util.List getNetworkAclIds() {
if (networkAclIds == null) {
networkAclIds = new com.amazonaws.internal.SdkInternalList();
}
return networkAclIds;
}
/**
*
* One or more network ACL IDs.
*
*
* Default: Describes all your network ACLs.
*
*
* @param networkAclIds
* One or more network ACL IDs.
*
* Default: Describes all your network ACLs.
*/
public void setNetworkAclIds(java.util.Collection networkAclIds) {
if (networkAclIds == null) {
this.networkAclIds = null;
return;
}
this.networkAclIds = new com.amazonaws.internal.SdkInternalList(
networkAclIds);
}
/**
*
* One or more network ACL IDs.
*
*
* Default: Describes all your network ACLs.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setNetworkAclIds(java.util.Collection)} or
* {@link #withNetworkAclIds(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param networkAclIds
* One or more network ACL IDs.
*
* Default: Describes all your network ACLs.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeNetworkAclsRequest withNetworkAclIds(String... networkAclIds) {
if (this.networkAclIds == null) {
setNetworkAclIds(new com.amazonaws.internal.SdkInternalList(
networkAclIds.length));
}
for (String ele : networkAclIds) {
this.networkAclIds.add(ele);
}
return this;
}
/**
*
* One or more network ACL IDs.
*
*
* Default: Describes all your network ACLs.
*
*
* @param networkAclIds
* One or more network ACL IDs.
*
* Default: Describes all your network ACLs.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeNetworkAclsRequest withNetworkAclIds(
java.util.Collection networkAclIds) {
setNetworkAclIds(networkAclIds);
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* association.association-id - The ID of an association ID for
* the ACL.
*
*
* -
*
* association.network-acl-id - The ID of the network ACL
* involved in the association.
*
*
* -
*
* association.subnet-id - The ID of the subnet involved in the
* association.
*
*
* -
*
* default - Indicates whether the ACL is the default network
* ACL for the VPC.
*
*
* -
*
* entry.cidr - The CIDR range specified in the entry.
*
*
* -
*
* entry.egress - Indicates whether the entry applies to egress
* traffic.
*
*
* -
*
* entry.icmp.code - The ICMP code specified in the entry, if
* any.
*
*
* -
*
* entry.icmp.type - The ICMP type specified in the entry, if
* any.
*
*
* -
*
* entry.port-range.from - The start of the port range
* specified in the entry.
*
*
* -
*
* entry.port-range.to - The end of the port range specified in
* the entry.
*
*
* -
*
* entry.protocol - The protocol specified in the entry (
* tcp | udp | icmp or a protocol
* number).
*
*
* -
*
* entry.rule-action - Allows or denies the matching traffic (
* allow | deny).
*
*
* -
*
* entry.rule-number - The number of an entry (in other words,
* rule) in the ACL's set of entries.
*
*
* -
*
* network-acl-id - The ID of the network ACL.
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* vpc-id - The ID of the VPC for the network ACL.
*
*
*
*
* @return One or more filters.
*
* -
*
* association.association-id - The ID of an
* association ID for the ACL.
*
*
* -
*
* association.network-acl-id - The ID of the network
* ACL involved in the association.
*
*
* -
*
* association.subnet-id - The ID of the subnet
* involved in the association.
*
*
* -
*
* default - Indicates whether the ACL is the default
* network ACL for the VPC.
*
*
* -
*
* entry.cidr - The CIDR range specified in the entry.
*
*
* -
*
* entry.egress - Indicates whether the entry applies
* to egress traffic.
*
*
* -
*
* entry.icmp.code - The ICMP code specified in the
* entry, if any.
*
*
* -
*
* entry.icmp.type - The ICMP type specified in the
* entry, if any.
*
*
* -
*
* entry.port-range.from - The start of the port range
* specified in the entry.
*
*
* -
*
* entry.port-range.to - The end of the port range
* specified in the entry.
*
*
* -
*
* entry.protocol - The protocol specified in the entry
* (tcp | udp | icmp or a
* protocol number).
*
*
* -
*
* entry.rule-action - Allows or denies the matching
* traffic (allow | deny).
*
*
* -
*
* entry.rule-number - The number of an entry (in other
* words, rule) in the ACL's set of entries.
*
*
* -
*
* network-acl-id - The ID of the network ACL.
*
*
* -
*
* tag:key=value - The key/value
* combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter.
* For example, if you use both the filter "tag-key=Purpose" and the
* filter "tag-value=X", you get any resources assigned both the tag
* key Purpose (regardless of what the tag's value is), and the tag
* value X (regardless of what the tag's key is). If you want to
* list only resources where Purpose is X, see the tag
* :key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
*
* -
*
* vpc-id - The ID of the VPC for the network ACL.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more filters.
*
*
* -
*
* association.association-id - The ID of an association ID for
* the ACL.
*
*
* -
*
* association.network-acl-id - The ID of the network ACL
* involved in the association.
*
*
* -
*
* association.subnet-id - The ID of the subnet involved in the
* association.
*
*
* -
*
* default - Indicates whether the ACL is the default network
* ACL for the VPC.
*
*
* -
*
* entry.cidr - The CIDR range specified in the entry.
*
*
* -
*
* entry.egress - Indicates whether the entry applies to egress
* traffic.
*
*
* -
*
* entry.icmp.code - The ICMP code specified in the entry, if
* any.
*
*
* -
*
* entry.icmp.type - The ICMP type specified in the entry, if
* any.
*
*
* -
*
* entry.port-range.from - The start of the port range
* specified in the entry.
*
*
* -
*
* entry.port-range.to - The end of the port range specified in
* the entry.
*
*
* -
*
* entry.protocol - The protocol specified in the entry (
* tcp | udp | icmp or a protocol
* number).
*
*
* -
*
* entry.rule-action - Allows or denies the matching traffic (
* allow | deny).
*
*
* -
*
* entry.rule-number - The number of an entry (in other words,
* rule) in the ACL's set of entries.
*
*
* -
*
* network-acl-id - The ID of the network ACL.
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* vpc-id - The ID of the VPC for the network ACL.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* association.association-id - The ID of an association
* ID for the ACL.
*
*
* -
*
* association.network-acl-id - The ID of the network
* ACL involved in the association.
*
*
* -
*
* association.subnet-id - The ID of the subnet involved
* in the association.
*
*
* -
*
* default - Indicates whether the ACL is the default
* network ACL for the VPC.
*
*
* -
*
* entry.cidr - The CIDR range specified in the entry.
*
*
* -
*
* entry.egress - Indicates whether the entry applies to
* egress traffic.
*
*
* -
*
* entry.icmp.code - The ICMP code specified in the
* entry, if any.
*
*
* -
*
* entry.icmp.type - The ICMP type specified in the
* entry, if any.
*
*
* -
*
* entry.port-range.from - The start of the port range
* specified in the entry.
*
*
* -
*
* entry.port-range.to - The end of the port range
* specified in the entry.
*
*
* -
*
* entry.protocol - The protocol specified in the entry
* (tcp | udp | icmp or a
* protocol number).
*
*
* -
*
* entry.rule-action - Allows or denies the matching
* traffic (allow | deny).
*
*
* -
*
* entry.rule-number - The number of an entry (in other
* words, rule) in the ACL's set of entries.
*
*
* -
*
* network-acl-id - The ID of the network ACL.
*
*
* -
*
* tag:key=value - The key/value
* combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter.
* For example, if you use both the filter "tag-key=Purpose" and the
* filter "tag-value=X", you get any resources assigned both the tag
* key Purpose (regardless of what the tag's value is), and the tag
* value X (regardless of what the tag's key is). If you want to list
* only resources where Purpose is X, see the tag
* :key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
*
* -
*
* vpc-id - The ID of the VPC for the network ACL.
*
*
*/
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.
*
*
* -
*
* association.association-id - The ID of an association ID for
* the ACL.
*
*
* -
*
* association.network-acl-id - The ID of the network ACL
* involved in the association.
*
*
* -
*
* association.subnet-id - The ID of the subnet involved in the
* association.
*
*
* -
*
* default - Indicates whether the ACL is the default network
* ACL for the VPC.
*
*
* -
*
* entry.cidr - The CIDR range specified in the entry.
*
*
* -
*
* entry.egress - Indicates whether the entry applies to egress
* traffic.
*
*
* -
*
* entry.icmp.code - The ICMP code specified in the entry, if
* any.
*
*
* -
*
* entry.icmp.type - The ICMP type specified in the entry, if
* any.
*
*
* -
*
* entry.port-range.from - The start of the port range
* specified in the entry.
*
*
* -
*
* entry.port-range.to - The end of the port range specified in
* the entry.
*
*
* -
*
* entry.protocol - The protocol specified in the entry (
* tcp | udp | icmp or a protocol
* number).
*
*
* -
*
* entry.rule-action - Allows or denies the matching traffic (
* allow | deny).
*
*
* -
*
* entry.rule-number - The number of an entry (in other words,
* rule) in the ACL's set of entries.
*
*
* -
*
* network-acl-id - The ID of the network ACL.
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* vpc-id - The ID of the VPC for the network ACL.
*
*
*
*
* 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.
*
* -
*
* association.association-id - The ID of an association
* ID for the ACL.
*
*
* -
*
* association.network-acl-id - The ID of the network
* ACL involved in the association.
*
*
* -
*
* association.subnet-id - The ID of the subnet involved
* in the association.
*
*
* -
*
* default - Indicates whether the ACL is the default
* network ACL for the VPC.
*
*
* -
*
* entry.cidr - The CIDR range specified in the entry.
*
*
* -
*
* entry.egress - Indicates whether the entry applies to
* egress traffic.
*
*
* -
*
* entry.icmp.code - The ICMP code specified in the
* entry, if any.
*
*
* -
*
* entry.icmp.type - The ICMP type specified in the
* entry, if any.
*
*
* -
*
* entry.port-range.from - The start of the port range
* specified in the entry.
*
*
* -
*
* entry.port-range.to - The end of the port range
* specified in the entry.
*
*
* -
*
* entry.protocol - The protocol specified in the entry
* (tcp | udp | icmp or a
* protocol number).
*
*
* -
*
* entry.rule-action - Allows or denies the matching
* traffic (allow | deny).
*
*
* -
*
* entry.rule-number - The number of an entry (in other
* words, rule) in the ACL's set of entries.
*
*
* -
*
* network-acl-id - The ID of the network ACL.
*
*
* -
*
* tag:key=value - The key/value
* combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter.
* For example, if you use both the filter "tag-key=Purpose" and the
* filter "tag-value=X", you get any resources assigned both the tag
* key Purpose (regardless of what the tag's value is), and the tag
* value X (regardless of what the tag's key is). If you want to list
* only resources where Purpose is X, see the tag
* :key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
*
* -
*
* vpc-id - The ID of the VPC for the network ACL.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeNetworkAclsRequest 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.
*
*
* -
*
* association.association-id - The ID of an association ID for
* the ACL.
*
*
* -
*
* association.network-acl-id - The ID of the network ACL
* involved in the association.
*
*
* -
*
* association.subnet-id - The ID of the subnet involved in the
* association.
*
*
* -
*
* default - Indicates whether the ACL is the default network
* ACL for the VPC.
*
*
* -
*
* entry.cidr - The CIDR range specified in the entry.
*
*
* -
*
* entry.egress - Indicates whether the entry applies to egress
* traffic.
*
*
* -
*
* entry.icmp.code - The ICMP code specified in the entry, if
* any.
*
*
* -
*
* entry.icmp.type - The ICMP type specified in the entry, if
* any.
*
*
* -
*
* entry.port-range.from - The start of the port range
* specified in the entry.
*
*
* -
*
* entry.port-range.to - The end of the port range specified in
* the entry.
*
*
* -
*
* entry.protocol - The protocol specified in the entry (
* tcp | udp | icmp or a protocol
* number).
*
*
* -
*
* entry.rule-action - Allows or denies the matching traffic (
* allow | deny).
*
*
* -
*
* entry.rule-number - The number of an entry (in other words,
* rule) in the ACL's set of entries.
*
*
* -
*
* network-acl-id - The ID of the network ACL.
*
*
* -
*
* tag:key=value - The key/value combination of a
* tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. This
* filter is independent of the tag-value filter. For example,
* if you use both the filter "tag-key=Purpose" and the filter
* "tag-value=X", you get any resources assigned both the tag key Purpose
* (regardless of what the tag's value is), and the tag value X (regardless
* of what the tag's key is). If you want to list only resources where
* Purpose is X, see the tag:key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the resource.
* This filter is independent of the tag-key filter.
*
*
* -
*
* vpc-id - The ID of the VPC for the network ACL.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* association.association-id - The ID of an association
* ID for the ACL.
*
*
* -
*
* association.network-acl-id - The ID of the network
* ACL involved in the association.
*
*
* -
*
* association.subnet-id - The ID of the subnet involved
* in the association.
*
*
* -
*
* default - Indicates whether the ACL is the default
* network ACL for the VPC.
*
*
* -
*
* entry.cidr - The CIDR range specified in the entry.
*
*
* -
*
* entry.egress - Indicates whether the entry applies to
* egress traffic.
*
*
* -
*
* entry.icmp.code - The ICMP code specified in the
* entry, if any.
*
*
* -
*
* entry.icmp.type - The ICMP type specified in the
* entry, if any.
*
*
* -
*
* entry.port-range.from - The start of the port range
* specified in the entry.
*
*
* -
*
* entry.port-range.to - The end of the port range
* specified in the entry.
*
*
* -
*
* entry.protocol - The protocol specified in the entry
* (tcp | udp | icmp or a
* protocol number).
*
*
* -
*
* entry.rule-action - Allows or denies the matching
* traffic (allow | deny).
*
*
* -
*
* entry.rule-number - The number of an entry (in other
* words, rule) in the ACL's set of entries.
*
*
* -
*
* network-acl-id - The ID of the network ACL.
*
*
* -
*
* tag:key=value - The key/value
* combination of a tag assigned to the resource.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource.
* This filter is independent of the tag-value filter.
* For example, if you use both the filter "tag-key=Purpose" and the
* filter "tag-value=X", you get any resources assigned both the tag
* key Purpose (regardless of what the tag's value is), and the tag
* value X (regardless of what the tag's key is). If you want to list
* only resources where Purpose is X, see the tag
* :key=value filter.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* resource. This filter is independent of the tag-key
* filter.
*
*
* -
*
* vpc-id - The ID of the VPC for the network ACL.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeNetworkAclsRequest withFilters(
java.util.Collection filters) {
setFilters(filters);
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 DescribeNetworkAclsRequestMarshaller()
.marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getNetworkAclIds() != null)
sb.append("NetworkAclIds: " + getNetworkAclIds() + ",");
if (getFilters() != null)
sb.append("Filters: " + getFilters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeNetworkAclsRequest == false)
return false;
DescribeNetworkAclsRequest other = (DescribeNetworkAclsRequest) obj;
if (other.getNetworkAclIds() == null ^ this.getNetworkAclIds() == null)
return false;
if (other.getNetworkAclIds() != null
&& other.getNetworkAclIds().equals(this.getNetworkAclIds()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null
&& other.getFilters().equals(this.getFilters()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getNetworkAclIds() == null) ? 0 : getNetworkAclIds()
.hashCode());
hashCode = prime * hashCode
+ ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public DescribeNetworkAclsRequest clone() {
return (DescribeNetworkAclsRequest) super.clone();
}
}