com.amazonaws.services.ec2.model

Class DescribeVpnGatewaysRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeVpnGatewaysRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeVpnGatewaysRequest>, Serializable

public class DescribeVpnGatewaysRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeVpnGatewaysRequest>

Container for the parameters to the DescribeVpnGateways operation.

Gives you information about your VPN gateways. You can filter the results to return information only about VPN gateways that match criteria you specify.

For example, you could ask to get information about a particular VPN gateway (or all) only if the gateway's state is pending or available. You can specify multiple filters (e.g., the VPN gateway is in a particular Availability Zone and the gateway's state is pending or available).

The result includes information for a particular VPN gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty. The following table shows the available filters.

See Also:

AmazonEC2.describeVpnGateways(DescribeVpnGatewaysRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeVpnGatewaysRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Request<DescribeVpnGatewaysRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() A list of filters used to match properties for VPN Gateways.
List<String>	getVpnGatewayIds() A list of filters used to match properties for VPN Gateways.
int	hashCode()
void	setFilters(Collection<Filter> filters) A list of filters used to match properties for VPN Gateways.
void	setVpnGatewayIds(Collection<String> vpnGatewayIds) A list of filters used to match properties for VPN Gateways.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeVpnGatewaysRequest	withFilters(Collection<Filter> filters) A list of filters used to match properties for VPN Gateways.
DescribeVpnGatewaysRequest	withFilters(Filter... filters) A list of filters used to match properties for VPN Gateways.
DescribeVpnGatewaysRequest	withVpnGatewayIds(Collection<String> vpnGatewayIds) A list of filters used to match properties for VPN Gateways.
DescribeVpnGatewaysRequest	withVpnGatewayIds(String... vpnGatewayIds) A list of filters used to match properties for VPN Gateways.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeVpnGatewaysRequest

public DescribeVpnGatewaysRequest()

Method Detail

getVpnGatewayIds

public List<String> getVpnGatewayIds()

A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

setVpnGatewayIds

public void setVpnGatewayIds(Collection<String> vpnGatewayIds)

A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Parameters:

vpnGatewayIds - A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

withVpnGatewayIds

public DescribeVpnGatewaysRequest withVpnGatewayIds(String... vpnGatewayIds)

A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns a reference to this object so that method calls can be chained together.

Parameters:

vpnGatewayIds - A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A reference to this updated object so that method calls can be chained together.

withVpnGatewayIds

public DescribeVpnGatewaysRequest withVpnGatewayIds(Collection<String> vpnGatewayIds)

A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns a reference to this object so that method calls can be chained together.

Parameters:

vpnGatewayIds - A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

setFilters

public void setFilters(Collection<Filter> filters)

A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Parameters:

filters - A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

withFilters

public DescribeVpnGatewaysRequest withFilters(Filter... filters)

A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeVpnGatewaysRequest withFilters(Collection<Filter> filters)

A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - A list of filters used to match properties for VPN Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeVpnGatewaysRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeVpnGatewaysRequest>

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object