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

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

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

Contains the parameters for DescribeVpnGateways.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeVpnGatewaysRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeVpnGatewaysRequest.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`	`hasVpnGatewayIds()` Returns true if the VpnGatewayIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeVpnGatewaysRequest.Builder>`	`serializableBuilderClass()`
`DescribeVpnGatewaysRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`vpnGatewayIds()` One or more virtual private gateway 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 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 List<Filter> filters()
```
    One or more filters.
    - amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
    - attachment.state - The current state of the attachment between the gateway and the VPC ( attaching | attached | detaching | detached).
    - attachment.vpc-id - The ID of an attached VPC.
    - availability-zone - The Availability Zone for the virtual private gateway (if applicable).
    - state - The state of the virtual private gateway (pending | available | deleting | deleted).
    - 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 virtual private gateway. Currently the only supported type is ipsec.1.
    - vpn-gateway-id - The ID of the virtual private gateway.
    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.
    
    amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
    
    attachment.state - The current state of the attachment between the gateway and the VPC ( attaching | attached | detaching | detached).
    
    attachment.vpc-id - The ID of an attached VPC.
    
    availability-zone - The Availability Zone for the virtual private gateway (if applicable).
    
    state - The state of the virtual private gateway (pending | available | deleting | deleted).
    
    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 virtual private gateway. Currently the only supported type is ipsec.1.
    
    vpn-gateway-id - The ID of the virtual private gateway.
  - hasVpnGatewayIds
```
public boolean hasVpnGatewayIds()
```
    Returns true if the VpnGatewayIds 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.
  - vpnGatewayIds
```
public List<String> vpnGatewayIds()
```
    One or more virtual private gateway IDs.
    
    Default: Describes all your virtual private gateways.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasVpnGatewayIds() to see if a value was sent in this field.
    
    Returns:
    
    One or more virtual private gateway IDs.
    
    Default: Describes all your virtual private gateways.
  - toBuilder
```
public DescribeVpnGatewaysRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeVpnGatewaysRequest.Builder,DescribeVpnGatewaysRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeVpnGatewaysRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeVpnGatewaysRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeVpnGatewaysRequest

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

hasVpnGatewayIds

vpnGatewayIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields