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()` Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasSubnetIds()` Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Integer`	`maxResults()` The maximum number of results to return with a single call.
`String`	`nextToken()` The token for the next page of results.
`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()
```
    Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    - 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasFilters() to see if a value was sent in this field.
    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.
    
    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.
  - hasSubnetIds
```
public final boolean hasSubnetIds()
```
    Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasSubnetIds() to see if a value was sent in this field.
    
    Returns:
    
    One or more subnet IDs.
    
    Default: Describes all your subnets.
  - nextToken
```
public final String nextToken()
```
    The token for the next page of results.
    
    Returns:
    
    The token for the next page of results.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
    
    Returns:
    
    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
  - 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