software.amazon.awssdk.services.ec2.model.DescribeNetworkAclsRequest Maven / Gradle / Ivy
Show all versions of ec2 Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.ec2.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeNetworkAclsRequest extends Ec2Request implements
ToCopyableBuilder {
private static final SdkField NEXT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("NextToken")
.getter(getter(DescribeNetworkAclsRequest::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken")
.unmarshallLocationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("MaxResults")
.getter(getter(DescribeNetworkAclsRequest::maxResults))
.setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults")
.unmarshallLocationName("MaxResults").build()).build();
private static final SdkField DRY_RUN_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("DryRun")
.getter(getter(DescribeNetworkAclsRequest::dryRun))
.setter(setter(Builder::dryRun))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DryRun")
.unmarshallLocationName("dryRun").build()).build();
private static final SdkField> NETWORK_ACL_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("NetworkAclIds")
.getter(getter(DescribeNetworkAclsRequest::networkAclIds))
.setter(setter(Builder::networkAclIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NetworkAclId")
.unmarshallLocationName("NetworkAclId").build(),
ListTrait
.builder()
.memberLocationName("item")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Item").unmarshallLocationName("item").build()).build())
.build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeNetworkAclsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filter")
.unmarshallLocationName("Filter").build(),
ListTrait
.builder()
.memberLocationName("Filter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Filter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Filter").unmarshallLocationName("Filter").build()).build())
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NEXT_TOKEN_FIELD,
MAX_RESULTS_FIELD, DRY_RUN_FIELD, NETWORK_ACL_IDS_FIELD, FILTERS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("NextToken", NEXT_TOKEN_FIELD);
put("MaxResults", MAX_RESULTS_FIELD);
put("DryRun", DRY_RUN_FIELD);
put("NetworkAclId", NETWORK_ACL_IDS_FIELD);
put("Filter", FILTERS_FIELD);
}
});
private final String nextToken;
private final Integer maxResults;
private final Boolean dryRun;
private final List networkAclIds;
private final List filters;
private DescribeNetworkAclsRequest(BuilderImpl builder) {
super(builder);
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
this.dryRun = builder.dryRun;
this.networkAclIds = builder.networkAclIds;
this.filters = builder.filters;
}
/**
*
* 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 final String nextToken() {
return 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.
*
*
* @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 final Integer maxResults() {
return maxResults;
}
/**
*
* Checks whether you have the required permissions for the action, without actually making the request, and
* provides an error response. If you have the required permissions, the error response is
* DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
*
*
* @return Checks whether you have the required permissions for the action, without actually making the request, and
* provides an error response. If you have the required permissions, the error response is
* DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
*/
public final Boolean dryRun() {
return dryRun;
}
/**
* For responses, this returns true if the service returned a value for the NetworkAclIds property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasNetworkAclIds() {
return networkAclIds != null && !(networkAclIds instanceof SdkAutoConstructList);
}
/**
*
* The IDs of the network ACLs.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasNetworkAclIds} method.
*
*
* @return The IDs of the network ACLs.
*/
public final List networkAclIds() {
return networkAclIds;
}
/**
* For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* The 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 IPv4 CIDR range specified in the entry.
*
*
* -
*
* 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.ipv6-cidr
- The IPv6 CIDR range specified in the entry.
*
*
* -
*
* 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.egress
- A Boolean that indicates the type of rule. Specify true
for egress
* rules, or false
for ingress rules.
*
*
* -
*
* entry.rule-number
- The number of an entry (in other words, rule) in the set of ACL entries.
*
*
* -
*
* network-acl-id
- The ID of the network ACL.
*
*
* -
*
* owner-id
- The ID of the Amazon Web Services account that owns the network ACL.
*
*
* -
*
* 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 network ACL.
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasFilters} method.
*
*
* @return The 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 IPv4 CIDR range specified in the entry.
*
*
* -
*
* 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.ipv6-cidr
- The IPv6 CIDR range specified in the entry.
*
*
* -
*
* 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.egress
- A Boolean that indicates the type of rule. Specify true
for
* egress rules, or false
for ingress rules.
*
*
* -
*
* entry.rule-number
- The number of an entry (in other words, rule) in the set of ACL entries.
*
*
* -
*
* network-acl-id
- The ID of the network ACL.
*
*
* -
*
* owner-id
- The ID of the Amazon Web Services account that owns the network ACL.
*
*
* -
*
* 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 network ACL.
*
*
*/
public final List filters() {
return filters;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(dryRun());
hashCode = 31 * hashCode + Objects.hashCode(hasNetworkAclIds() ? networkAclIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeNetworkAclsRequest)) {
return false;
}
DescribeNetworkAclsRequest other = (DescribeNetworkAclsRequest) obj;
return Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(dryRun(), other.dryRun()) && hasNetworkAclIds() == other.hasNetworkAclIds()
&& Objects.equals(networkAclIds(), other.networkAclIds()) && hasFilters() == other.hasFilters()
&& Objects.equals(filters(), other.filters());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeNetworkAclsRequest").add("NextToken", nextToken()).add("MaxResults", maxResults())
.add("DryRun", dryRun()).add("NetworkAclIds", hasNetworkAclIds() ? networkAclIds() : null)
.add("Filters", hasFilters() ? filters() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "DryRun":
return Optional.ofNullable(clazz.cast(dryRun()));
case "NetworkAclIds":
return Optional.ofNullable(clazz.cast(networkAclIds()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function