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

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

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

Contains the parameters for DescribeVpnConnections.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeVpnConnectionsRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeVpnConnectionsRequest.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 DescribeVpnConnectionsRequest.Builder>`	`serializableBuilderClass()`
`DescribeVpnConnectionsRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`List<String>`	`vpnConnectionIds()` One or more VPN connection 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.
    - customer-gateway-configuration - The configuration information for the customer gateway.
    - customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
    - state - The state of the VPN connection (pending | available | deleting | deleted).
    - option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
    - route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
    - bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
    - 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.
    - type - The type of VPN connection. Currently the only supported type is ipsec.1.
    - vpn-connection-id - The ID of the VPN connection.
    - vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    One or more filters.
    
    customer-gateway-configuration - The configuration information for the customer gateway.
    
    customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
    
    state - The state of the VPN connection (pending | available | deleting | deleted).
    
    option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
    
    route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
    
    bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
    
    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.
    
    type - The type of VPN connection. Currently the only supported type is ipsec.1 .
    
    vpn-connection-id - The ID of the VPN connection.
    
    vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
  - vpnConnectionIds
```
public List<String> vpnConnectionIds()
```
    One or more VPN connection IDs.
    
    Default: Describes your VPN connections.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more VPN connection IDs.
    
    Default: Describes your VPN connections.
  - toBuilder
```
public DescribeVpnConnectionsRequest.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<DescribeVpnConnectionsRequest.Builder,DescribeVpnConnectionsRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static DescribeVpnConnectionsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeVpnConnectionsRequest.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 DescribeVpnConnectionsRequest

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

vpnConnectionIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields