com.amazonaws.services.ec2.model

Class DescribeRegionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeRegionsRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<DescribeRegionsRequest>, Serializable, Cloneable

public class DescribeRegionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeRegionsRequest>

Container for the parameters to the DescribeRegions operation.

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints .

See Also:

AmazonEC2.describeRegions(DescribeRegionsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeRegionsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeRegionsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Request<DescribeRegionsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() One or more filters.
List<String>	getRegionNames() The names of one or more regions.
int	hashCode()
void	setFilters(Collection<Filter> filters) One or more filters.
void	setRegionNames(Collection<String> regionNames) The names of one or more regions.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeRegionsRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeRegionsRequest	withFilters(Filter... filters) One or more filters.
DescribeRegionsRequest	withRegionNames(Collection<String> regionNames) The names of one or more regions.
DescribeRegionsRequest	withRegionNames(String... regionNames) The names of one or more regions.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeRegionsRequest

public DescribeRegionsRequest()

Method Detail

getRegionNames

public List<String> getRegionNames()

The names of one or more regions.

Returns:

The names of one or more regions.

setRegionNames

public void setRegionNames(Collection<String> regionNames)

The names of one or more regions.

Parameters:

regionNames - The names of one or more regions.

withRegionNames

public DescribeRegionsRequest withRegionNames(String... regionNames)

The names of one or more regions.

NOTE: This method appends the values to the existing list (if any). Use setRegionNames(java.util.Collection) or withRegionNames(java.util.Collection) if you want to override the existing values.

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

Parameters:

regionNames - The names of one or more regions.

Returns:

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

withRegionNames

public DescribeRegionsRequest withRegionNames(Collection<String> regionNames)

The names of one or more regions.

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

Parameters:

regionNames - The names of one or more regions.

Returns:

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

getFilters

public List<Filter> getFilters()

One or more filters.

• endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

• region-name - The name of the region (for example, us-east-1).

Returns:

One or more filters.

• endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

• region-name - The name of the region (for example, us-east-1).

setFilters

public void setFilters(Collection<Filter> filters)

One or more filters.

• endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

• region-name - The name of the region (for example, us-east-1).

Parameters:

filters - One or more filters.

• endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

• region-name - The name of the region (for example, us-east-1).

withFilters

public DescribeRegionsRequest withFilters(Filter... filters)

One or more filters.

• endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

• region-name - The name of the region (for example, us-east-1).

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

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

Parameters:

filters - One or more filters.

• endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

• region-name - The name of the region (for example, us-east-1).

Returns:

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

withFilters

public DescribeRegionsRequest withFilters(Collection<Filter> filters)

One or more filters.

• endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

• region-name - The name of the region (for example, us-east-1).

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

Parameters:

filters - One or more filters.

• endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

• region-name - The name of the region (for example, us-east-1).

Returns:

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

getDryRunRequest

public Request<DescribeRegionsRequest> 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<DescribeRegionsRequest>

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

clone

public DescribeRegionsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()