DescribeVpcsRequest (AWS SDK for Java

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)`
`List<Filter>`	`filters()` One or more filters.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeVpcsRequest.Builder>`	`serializableBuilderClass()`
`DescribeVpcsRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - filters
```
public 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.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.
    - isDefault - Indicates whether the VPC is the default VPC.
    - owner-id - The ID of the AWS 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.
    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.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.
    
    isDefault - Indicates whether the VPC is the default VPC.
    
    owner-id - The ID of the AWS 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.
  - vpcIds
```
public 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.
    
    Returns:
    
    One or more VPC IDs.
    
    Default: Describes all your VPCs.
  - toBuilder
```
public DescribeVpcsRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeVpcsRequest.Builder,DescribeVpcsRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static DescribeVpcsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeVpcsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

filters

vpcIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields