com.amazonaws.services.ec2.model

Class DescribeVpcsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeVpcsRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeVpcsRequest>, Serializable

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

Container for the parameters to the DescribeVpcs operation.

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

For example, you could ask to get information about a particular VPC or VPCs (or all your VPCs) only if the VPC's state is available. You can specify multiple filters (e.g., the VPC uses one of several sets of DHCP options, and the VPC's state is available). The result includes information for a particular VPC only if the VPC 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.describeVpcs(DescribeVpcsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeVpcsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Request<DescribeVpcsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() A list of filters used to match properties for VPCs.
List<String>	getVpcIds() The ID of a VPC you want information about.
int	hashCode()
void	setFilters(Collection<Filter> filters) A list of filters used to match properties for VPCs.
void	setVpcIds(Collection<String> vpcIds) The ID of a VPC you want information about.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeVpcsRequest	withFilters(Collection<Filter> filters) A list of filters used to match properties for VPCs.
DescribeVpcsRequest	withFilters(Filter... filters) A list of filters used to match properties for VPCs.
DescribeVpcsRequest	withVpcIds(Collection<String> vpcIds) The ID of a VPC you want information about.
DescribeVpcsRequest	withVpcIds(String... vpcIds) The ID of a VPC you want information about.

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

DescribeVpcsRequest

public DescribeVpcsRequest()

Method Detail

getVpcIds

public List<String> getVpcIds()

The ID of a VPC you want information about.

Returns:

The ID of a VPC you want information about.

setVpcIds

public void setVpcIds(Collection<String> vpcIds)

The ID of a VPC you want information about.

Parameters:

vpcIds - The ID of a VPC you want information about.

withVpcIds

public DescribeVpcsRequest withVpcIds(String... vpcIds)

The ID of a VPC you want information about.

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

Parameters:

vpcIds - The ID of a VPC you want information about.

Returns:

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

withVpcIds

public DescribeVpcsRequest withVpcIds(Collection<String> vpcIds)

The ID of a VPC you want information about.

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

Parameters:

vpcIds - The ID of a VPC you want information about.

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

withFilters

public DescribeVpcsRequest withFilters(Filter... filters)

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

A list of filters used to match properties for VPCs. 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 VPCs. 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<DescribeVpcsRequest> 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<DescribeVpcsRequest>

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