public class GetGeoLocationRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
GetGeoLocation operation.
To retrieve a single geo location, send a GET request to
the 2013-04-01/geolocation resource with one of these
options: continentcode | countrycode | countrycode and
subdivisioncode.
NOOP| Constructor and Description |
|---|
GetGeoLocationRequest() |
| Modifier and Type | Method and Description |
|---|---|
GetGeoLocationRequest |
clone() |
boolean |
equals(Object obj) |
String |
getContinentCode()
The code for a continent geo location.
|
String |
getCountryCode()
The code for a country geo location.
|
String |
getSubdivisionCode()
The code for a country's subdivision (e.g., a province of Canada).
|
int |
hashCode() |
void |
setContinentCode(String continentCode)
The code for a continent geo location.
|
void |
setCountryCode(String countryCode)
The code for a country geo location.
|
void |
setSubdivisionCode(String subdivisionCode)
The code for a country's subdivision (e.g., a province of Canada).
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GetGeoLocationRequest |
withContinentCode(String continentCode)
The code for a continent geo location.
|
GetGeoLocationRequest |
withCountryCode(String countryCode)
The code for a country geo location.
|
GetGeoLocationRequest |
withSubdivisionCode(String subdivisionCode)
The code for a country's subdivision (e.g., a province of Canada).
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic String getContinentCode()
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
Valid values: AF |
AN | AS | EU | OC
| NA | SA
Constraint: Specifying
ContinentCode with either CountryCode or
SubdivisionCode returns an InvalidInput error.
public void setContinentCode(String continentCode)
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
continentCode - The code for a continent geo location. Note: only continent locations
have a continent code. Valid values: AF |
AN | AS | EU | OC
| NA | SA
Constraint: Specifying
ContinentCode with either CountryCode or
SubdivisionCode returns an InvalidInput error.
public GetGeoLocationRequest withContinentCode(String continentCode)
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
continentCode - The code for a continent geo location. Note: only continent locations
have a continent code. Valid values: AF |
AN | AS | EU | OC
| NA | SA
Constraint: Specifying
ContinentCode with either CountryCode or
SubdivisionCode returns an InvalidInput error.
public String getCountryCode()
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
The default geo location uses a * for
the country code. All other country codes follow the ISO 3166
two-character code.
public void setCountryCode(String countryCode)
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
countryCode - The code for a country geo location. The default location uses '*' for
the country code and will match all locations that are not matched by
a geo location. The default geo location uses a * for
the country code. All other country codes follow the ISO 3166
two-character code.
public GetGeoLocationRequest withCountryCode(String countryCode)
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
countryCode - The code for a country geo location. The default location uses '*' for
the country code and will match all locations that are not matched by
a geo location. The default geo location uses a * for
the country code. All other country codes follow the ISO 3166
two-character code.
public String getSubdivisionCode()
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
Constraints:
Length: 1 - 3
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
public void setSubdivisionCode(String subdivisionCode)
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
Constraints:
Length: 1 - 3
subdivisionCode - The code for a country's subdivision (e.g., a province of Canada). A
subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
public GetGeoLocationRequest withSubdivisionCode(String subdivisionCode)
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
subdivisionCode - The code for a country's subdivision (e.g., a province of Canada). A
subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
public String toString()
toString in class ObjectObject.toString()public GetGeoLocationRequest clone()
clone in class AmazonWebServiceRequestCopyright © 2015. All rights reserved.