com.amazonaws.services.ec2.model

Class DescribeCustomerGatewaysRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeCustomerGatewaysRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeCustomerGatewaysRequest>, Serializable

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

Container for the parameters to the DescribeCustomerGateways operation.

Gives you information about your customer gateways. You can filter the results to return information only about customer gateways that match criteria you specify. For example, you could ask to get information about a particular customer gateway (or all) only if the gateway's state is pending or available. You can specify multiple filters (e.g., the customer gateway has a particular IP address for the Internet-routable external interface, and the gateway's state is pending or available). The result includes information for a particular customer 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.describeCustomerGateways(DescribeCustomerGatewaysRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeCustomerGatewaysRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getCustomerGatewayIds() A set of one or more customer gateway IDs.
Request<DescribeCustomerGatewaysRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() A list of filters used to match properties for Customer Gateways.
int	hashCode()
void	setCustomerGatewayIds(Collection<String> customerGatewayIds) A set of one or more customer gateway IDs.
void	setFilters(Collection<Filter> filters) A list of filters used to match properties for Customer Gateways.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeCustomerGatewaysRequest	withCustomerGatewayIds(Collection<String> customerGatewayIds) A set of one or more customer gateway IDs.
DescribeCustomerGatewaysRequest	withCustomerGatewayIds(String... customerGatewayIds) A set of one or more customer gateway IDs.
DescribeCustomerGatewaysRequest	withFilters(Collection<Filter> filters) A list of filters used to match properties for Customer Gateways.
DescribeCustomerGatewaysRequest	withFilters(Filter... filters) A list of filters used to match properties for Customer 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

DescribeCustomerGatewaysRequest

public DescribeCustomerGatewaysRequest()

Method Detail

getCustomerGatewayIds

public List<String> getCustomerGatewayIds()

A set of one or more customer gateway IDs.

Returns:

A set of one or more customer gateway IDs.

setCustomerGatewayIds

public void setCustomerGatewayIds(Collection<String> customerGatewayIds)

A set of one or more customer gateway IDs.

Parameters:

customerGatewayIds - A set of one or more customer gateway IDs.

withCustomerGatewayIds

public DescribeCustomerGatewaysRequest withCustomerGatewayIds(String... customerGatewayIds)

A set of one or more customer gateway IDs.

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

Parameters:

customerGatewayIds - A set of one or more customer gateway IDs.

Returns:

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

withCustomerGatewayIds

public DescribeCustomerGatewaysRequest withCustomerGatewayIds(Collection<String> customerGatewayIds)

A set of one or more customer gateway IDs.

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

Parameters:

customerGatewayIds - A set of one or more customer gateway IDs.

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 Customer 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 Customer 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 Customer 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 Customer Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

withFilters

public DescribeCustomerGatewaysRequest withFilters(Filter... filters)

A list of filters used to match properties for Customer 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 Customer 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 DescribeCustomerGatewaysRequest withFilters(Collection<Filter> filters)

A list of filters used to match properties for Customer 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 Customer 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<DescribeCustomerGatewaysRequest> 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<DescribeCustomerGatewaysRequest>

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