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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeVpcsRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeVpcsRequest.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`	`hasVpcIds()` For responses, this returns true if the service returned a value for the VpcIds property.
`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 DescribeVpcsRequest.Builder>`	`serializableBuilderClass()`
`DescribeVpcsRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`vpcIds()` One or more VPC IDs.

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.
    - cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
    - cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
    - cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
    - cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
    - dhcp-options-id - The ID of a set of DHCP options.
    - ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
    - ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
    - ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
    - ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
    - is-default - Indicates whether the VPC is the default VPC.
    - owner-id - The ID of the Amazon Web Services account that owns the VPC.
    - state - The state of the VPC (pending | available).
    - 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.
    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.
    
    cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
    
    cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
    
    cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
    
    cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
    
    dhcp-options-id - The ID of a set of DHCP options.
    
    ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
    
    ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
    
    ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
    
    ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
    
    is-default - Indicates whether the VPC is the default VPC.
    
    owner-id - The ID of the Amazon Web Services account that owns the VPC.
    
    state - The state of the VPC (pending | available).
    
    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.
  - hasVpcIds
```
public final boolean hasVpcIds()
```
    For responses, this returns true if the service returned a value for the VpcIds 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.
  - vpcIds
```
public final List<String> vpcIds()
```
    One or more VPC IDs.
    
    Default: Describes all your VPCs.
    
    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 hasVpcIds() method.
    
    Returns:
    
    One or more VPC IDs.
    
    Default: Describes all your VPCs.
  - 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 DescribeVpcsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeVpcsRequest.Builder,DescribeVpcsRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeVpcsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeVpcsRequest.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 DescribeVpcsRequest

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

hasVpcIds

vpcIds

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields