DescribeSubnetsRequest (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeSubnetsRequest.Builder,DescribeSubnetsRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeSubnetsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeSubnetsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeSubnetsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filters()` One or more 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`	`hasSubnetIds()` For responses, this returns true if the service returned a value for the SubnetIds property.
`Integer`	`maxResults()` The maximum number of items to return for this request.
`String`	`nextToken()` The token returned from a previous paginated request.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeSubnetsRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`subnetIds()` One or more subnet IDs.
`DescribeSubnetsRequest.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()
```
    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.
    - customer-owned-ipv4-pool - The customer-owned IPv4 address pool associated with the subnet.
    - default-for-az - Indicates whether this is the default subnet for the Availability Zone ( true | false). You can also use defaultForAz as the filter name.
    - enable-dns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
    - enable-lni-at-device-index - Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
    - 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.
    - ipv6-native - Indicates whether this is an IPv6 only subnet (true | false ).
    - map-customer-owned-ip-on-launch - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
    - map-public-ip-on-launch - Indicates whether instances launched in this subnet receive a public IPv4 address.
    - outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
    - owner-id - The ID of the Amazon Web Services account that owns the subnet.
    - private-dns-name-options-on-launch.hostname-type - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).
    - private-dns-name-options-on-launch.enable-resource-name-dns-a-record - Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
    - private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
    - 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.
    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:
    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.
    
    customer-owned-ipv4-pool - The customer-owned IPv4 address pool associated with the subnet.
    
    default-for-az - Indicates whether this is the default subnet for the Availability Zone ( true | false). You can also use defaultForAz as the filter name.
    
    enable-dns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
    
    enable-lni-at-device-index - Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
    
    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.
    
    ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).
    
    map-customer-owned-ip-on-launch - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
    
    map-public-ip-on-launch - Indicates whether instances launched in this subnet receive a public IPv4 address.
    
    outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
    
    owner-id - The ID of the Amazon Web Services account that owns the subnet.
    
    private-dns-name-options-on-launch.hostname-type - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).
    
    private-dns-name-options-on-launch.enable-resource-name-dns-a-record - Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
    
    private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
    
    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.
  - hasSubnetIds
```
public final boolean hasSubnetIds()
```
    For responses, this returns true if the service returned a value for the SubnetIds 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.
  - subnetIds
```
public final List<String> subnetIds()
```
    One or more subnet IDs.
    
    Default: Describes all your subnets.
    
    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 hasSubnetIds() method.
    
    Returns:
    
    One or more subnet IDs.
    
    Default: Describes all your subnets.
  - 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 DescribeSubnetsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeSubnetsRequest.Builder,DescribeSubnetsRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeSubnetsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeSubnetsRequest.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

Class DescribeSubnetsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

hasFilters

filters

hasSubnetIds

subnetIds

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields