com.amazonaws.services.route53.model

Class ListGeoLocationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.route53.model.ListGeoLocationsRequest

All Implemented Interfaces:

Serializable

public class ListGeoLocationsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListGeoLocations operation.

To retrieve a list of supported geo locations, send a GET request to the 2013-04-01/geolocations resource. The response to this request includes a GeoLocationDetailsList element with zero, one, or multiple GeoLocationDetails child elements. The list is sorted by country code, and then subdivision code, followed by continents at the end of the list.

By default, the list of geo locations is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. If the list is truncated, IsTruncated will be set to true and a combination of NextContinentCode, NextCountryCode, NextSubdivisionCode will be populated. You can pass these as parameters to StartContinentCode, StartCountryCode, StartSubdivisionCode to control the geo location that the list begins with.

See Also:

AmazonRoute53.listGeoLocations(ListGeoLocationsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListGeoLocationsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getMaxItems() The maximum number of geo locations you want in the response body.
String	getStartContinentCode() The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
String	getStartCountryCode() The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
String	getStartSubdivisionCode() The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
int	hashCode()
void	setMaxItems(String maxItems) The maximum number of geo locations you want in the response body.
void	setStartContinentCode(String startContinentCode) The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
void	setStartCountryCode(String startCountryCode) The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
void	setStartSubdivisionCode(String startSubdivisionCode) The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListGeoLocationsRequest	withMaxItems(String maxItems) The maximum number of geo locations you want in the response body.
ListGeoLocationsRequest	withStartContinentCode(String startContinentCode) The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
ListGeoLocationsRequest	withStartCountryCode(String startCountryCode) The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
ListGeoLocationsRequest	withStartSubdivisionCode(String startSubdivisionCode) The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ListGeoLocationsRequest

public ListGeoLocationsRequest()

Method Detail

getStartContinentCode

public String getStartContinentCode()

The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.

Valid values: AF | AN | AS | EU | OC | NA | SA

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

Constraints:
Length: 2 - 2

Returns:

The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.

Valid values: AF | AN | AS | EU | OC | NA | SA

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

setStartContinentCode

public void setStartContinentCode(String startContinentCode)

The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.

Valid values: AF | AN | AS | EU | OC | NA | SA

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

Constraints:
Length: 2 - 2

Parameters:

startContinentCode - The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.

Valid values: AF | AN | AS | EU | OC | NA | SA

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

withStartContinentCode

public ListGeoLocationsRequest withStartContinentCode(String startContinentCode)

The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.

Valid values: AF | AN | AS | EU | OC | NA | SA

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

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

Constraints:
Length: 2 - 2

Parameters:

startContinentCode - The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.

Valid values: AF | AN | AS | EU | OC | NA | SA

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

Returns:

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

getStartCountryCode

public String getStartCountryCode()

The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

Constraints:
Length: 1 - 2

Returns:

The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

setStartCountryCode

public void setStartCountryCode(String startCountryCode)

The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

Constraints:
Length: 1 - 2

Parameters:

startCountryCode - The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

withStartCountryCode

public ListGeoLocationsRequest withStartCountryCode(String startCountryCode)

The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

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

Constraints:
Length: 1 - 2

Parameters:

startCountryCode - The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

Returns:

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

getStartSubdivisionCode

public String getStartSubdivisionCode()

The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

Constraints:
Length: 1 - 3

Returns:

The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

setStartSubdivisionCode

public void setStartSubdivisionCode(String startSubdivisionCode)

The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

Constraints:
Length: 1 - 3

Parameters:

startSubdivisionCode - The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

withStartSubdivisionCode

public ListGeoLocationsRequest withStartSubdivisionCode(String startSubdivisionCode)

The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

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

Constraints:
Length: 1 - 3

Parameters:

startSubdivisionCode - The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

Returns:

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

getMaxItems

public String getMaxItems()

The maximum number of geo locations you want in the response body.

Returns:

The maximum number of geo locations you want in the response body.

setMaxItems

public void setMaxItems(String maxItems)

The maximum number of geo locations you want in the response body.

Parameters:

maxItems - The maximum number of geo locations you want in the response body.

withMaxItems

public ListGeoLocationsRequest withMaxItems(String maxItems)

The maximum number of geo locations you want in the response body.

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

Parameters:

maxItems - The maximum number of geo locations you want in the response body.

Returns:

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

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