software.amazon.awssdk.services.ec2.model

Class DescribeNetworkAclsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.DescribeNetworkAclsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeNetworkAclsRequest.Builder,DescribeNetworkAclsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeNetworkAclsRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeNetworkAclsRequest.Builder,DescribeNetworkAclsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeNetworkAclsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeNetworkAclsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters() The filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
boolean	hasNetworkAclIds() For responses, this returns true if the service returned a value for the NetworkAclIds property.
Integer	maxResults() The maximum number of items to return for this request.
List<String>	networkAclIds() The IDs of the network ACLs.
String	nextToken() The token returned from a previous paginated request.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeNetworkAclsRequest.Builder>	serializableBuilderClass()
DescribeNetworkAclsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasFilters

public final boolean hasFilters()

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

filters

public final List<Filter> filters()

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 hasFilters() method.

Returns:

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.

hasNetworkAclIds

public final boolean hasNetworkAclIds()

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

networkAclIds

public final List<String> networkAclIds()

The IDs of the network ACLs.

Default: Describes all your 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 hasNetworkAclIds() method.

Returns:

The IDs of the network ACLs.

Default: Describes all your network ACLs.

nextToken

public final String nextToken()

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

maxResults

public final Integer 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.

Returns:

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.

toBuilder

public DescribeNetworkAclsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeNetworkAclsRequest.Builder,DescribeNetworkAclsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeNetworkAclsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeNetworkAclsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo