@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Place extends Object implements Serializable, Cloneable, StructuredPojo
Contains details about addresses or points of interest that match the search criteria.
Not all details are included with all responses. Some details may only be returned by specific data partners.
Constructor and Description |
---|
Place() |
Modifier and Type | Method and Description |
---|---|
Place |
clone() |
boolean |
equals(Object obj) |
String |
getAddressNumber()
The numerical portion of an address, such as a building number.
|
List<String> |
getCategories()
The Amazon Location categories that describe this Place.
|
String |
getCountry()
A country/region specified using ISO 3166 3-digit
country/region code.
|
PlaceGeometry |
getGeometry() |
Boolean |
getInterpolated()
True if the result is interpolated from other known places. |
String |
getLabel()
The full name and address of the point of interest such as a city, region, or country.
|
String |
getMunicipality()
A name for a local area, such as a city or town name.
|
String |
getNeighborhood()
The name of a community district.
|
String |
getPostalCode()
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of
identifying a location.
|
String |
getRegion()
A name for an area or geographical division, such as a province or state name.
|
String |
getStreet()
The name for a street or a road to identify a location.
|
String |
getSubMunicipality()
An area that's part of a larger municipality.
|
String |
getSubRegion()
A county, or an area that's part of a larger region.
|
List<String> |
getSupplementalCategories()
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
|
TimeZone |
getTimeZone()
The time zone in which the
Place is located. |
String |
getUnitNumber()
For addresses with multiple units, the unit identifier.
|
String |
getUnitType()
For addresses with a
UnitNumber , the type of unit. |
int |
hashCode() |
Boolean |
isInterpolated()
True if the result is interpolated from other known places. |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAddressNumber(String addressNumber)
The numerical portion of an address, such as a building number.
|
void |
setCategories(Collection<String> categories)
The Amazon Location categories that describe this Place.
|
void |
setCountry(String country)
A country/region specified using ISO 3166 3-digit
country/region code.
|
void |
setGeometry(PlaceGeometry geometry) |
void |
setInterpolated(Boolean interpolated)
True if the result is interpolated from other known places. |
void |
setLabel(String label)
The full name and address of the point of interest such as a city, region, or country.
|
void |
setMunicipality(String municipality)
A name for a local area, such as a city or town name.
|
void |
setNeighborhood(String neighborhood)
The name of a community district.
|
void |
setPostalCode(String postalCode)
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of
identifying a location.
|
void |
setRegion(String region)
A name for an area or geographical division, such as a province or state name.
|
void |
setStreet(String street)
The name for a street or a road to identify a location.
|
void |
setSubMunicipality(String subMunicipality)
An area that's part of a larger municipality.
|
void |
setSubRegion(String subRegion)
A county, or an area that's part of a larger region.
|
void |
setSupplementalCategories(Collection<String> supplementalCategories)
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
|
void |
setTimeZone(TimeZone timeZone)
The time zone in which the
Place is located. |
void |
setUnitNumber(String unitNumber)
For addresses with multiple units, the unit identifier.
|
void |
setUnitType(String unitType)
For addresses with a
UnitNumber , the type of unit. |
String |
toString()
Returns a string representation of this object.
|
Place |
withAddressNumber(String addressNumber)
The numerical portion of an address, such as a building number.
|
Place |
withCategories(Collection<String> categories)
The Amazon Location categories that describe this Place.
|
Place |
withCategories(String... categories)
The Amazon Location categories that describe this Place.
|
Place |
withCountry(String country)
A country/region specified using ISO 3166 3-digit
country/region code.
|
Place |
withGeometry(PlaceGeometry geometry) |
Place |
withInterpolated(Boolean interpolated)
True if the result is interpolated from other known places. |
Place |
withLabel(String label)
The full name and address of the point of interest such as a city, region, or country.
|
Place |
withMunicipality(String municipality)
A name for a local area, such as a city or town name.
|
Place |
withNeighborhood(String neighborhood)
The name of a community district.
|
Place |
withPostalCode(String postalCode)
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of
identifying a location.
|
Place |
withRegion(String region)
A name for an area or geographical division, such as a province or state name.
|
Place |
withStreet(String street)
The name for a street or a road to identify a location.
|
Place |
withSubMunicipality(String subMunicipality)
An area that's part of a larger municipality.
|
Place |
withSubRegion(String subRegion)
A county, or an area that's part of a larger region.
|
Place |
withSupplementalCategories(Collection<String> supplementalCategories)
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
|
Place |
withSupplementalCategories(String... supplementalCategories)
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
|
Place |
withTimeZone(TimeZone timeZone)
The time zone in which the
Place is located. |
Place |
withUnitNumber(String unitNumber)
For addresses with multiple units, the unit identifier.
|
Place |
withUnitType(String unitType)
For addresses with a
UnitNumber , the type of unit. |
public void setLabel(String label)
The full name and address of the point of interest such as a city, region, or country. For example,
123 Any Street, Any Town, USA
.
label
- The full name and address of the point of interest such as a city, region, or country. For example,
123 Any Street, Any Town, USA
.public String getLabel()
The full name and address of the point of interest such as a city, region, or country. For example,
123 Any Street, Any Town, USA
.
123 Any Street, Any Town, USA
.public Place withLabel(String label)
The full name and address of the point of interest such as a city, region, or country. For example,
123 Any Street, Any Town, USA
.
label
- The full name and address of the point of interest such as a city, region, or country. For example,
123 Any Street, Any Town, USA
.public void setGeometry(PlaceGeometry geometry)
geometry
- public PlaceGeometry getGeometry()
public Place withGeometry(PlaceGeometry geometry)
geometry
- public void setAddressNumber(String addressNumber)
The numerical portion of an address, such as a building number.
addressNumber
- The numerical portion of an address, such as a building number.public String getAddressNumber()
The numerical portion of an address, such as a building number.
public Place withAddressNumber(String addressNumber)
The numerical portion of an address, such as a building number.
addressNumber
- The numerical portion of an address, such as a building number.public void setStreet(String street)
The name for a street or a road to identify a location. For example, Main Street
.
street
- The name for a street or a road to identify a location. For example, Main Street
.public String getStreet()
The name for a street or a road to identify a location. For example, Main Street
.
Main Street
.public Place withStreet(String street)
The name for a street or a road to identify a location. For example, Main Street
.
street
- The name for a street or a road to identify a location. For example, Main Street
.public void setNeighborhood(String neighborhood)
The name of a community district. For example, Downtown
.
neighborhood
- The name of a community district. For example, Downtown
.public String getNeighborhood()
The name of a community district. For example, Downtown
.
Downtown
.public Place withNeighborhood(String neighborhood)
The name of a community district. For example, Downtown
.
neighborhood
- The name of a community district. For example, Downtown
.public void setMunicipality(String municipality)
A name for a local area, such as a city or town name. For example, Toronto
.
municipality
- A name for a local area, such as a city or town name. For example, Toronto
.public String getMunicipality()
A name for a local area, such as a city or town name. For example, Toronto
.
Toronto
.public Place withMunicipality(String municipality)
A name for a local area, such as a city or town name. For example, Toronto
.
municipality
- A name for a local area, such as a city or town name. For example, Toronto
.public void setSubRegion(String subRegion)
A county, or an area that's part of a larger region. For example, Metro Vancouver
.
subRegion
- A county, or an area that's part of a larger region. For example, Metro Vancouver
.public String getSubRegion()
A county, or an area that's part of a larger region. For example, Metro Vancouver
.
Metro Vancouver
.public Place withSubRegion(String subRegion)
A county, or an area that's part of a larger region. For example, Metro Vancouver
.
subRegion
- A county, or an area that's part of a larger region. For example, Metro Vancouver
.public void setRegion(String region)
A name for an area or geographical division, such as a province or state name. For example,
British Columbia
.
region
- A name for an area or geographical division, such as a province or state name. For example,
British Columbia
.public String getRegion()
A name for an area or geographical division, such as a province or state name. For example,
British Columbia
.
British Columbia
.public Place withRegion(String region)
A name for an area or geographical division, such as a province or state name. For example,
British Columbia
.
region
- A name for an area or geographical division, such as a province or state name. For example,
British Columbia
.public void setCountry(String country)
A country/region specified using ISO 3166 3-digit
country/region code. For example, CAN
.
country
- A country/region specified using ISO 3166
3-digit country/region code. For example, CAN
.public String getCountry()
A country/region specified using ISO 3166 3-digit
country/region code. For example, CAN
.
CAN
.public Place withCountry(String country)
A country/region specified using ISO 3166 3-digit
country/region code. For example, CAN
.
country
- A country/region specified using ISO 3166
3-digit country/region code. For example, CAN
.public void setPostalCode(String postalCode)
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
postalCode
- A group of numbers and letters in a country-specific format, which accompanies the address for the purpose
of identifying a location.public String getPostalCode()
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
public Place withPostalCode(String postalCode)
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
postalCode
- A group of numbers and letters in a country-specific format, which accompanies the address for the purpose
of identifying a location.public void setInterpolated(Boolean interpolated)
True
if the result is interpolated from other known places.
False
if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False
for an address location that is found in the partner data, but returns
True
if an address does not exist in the partner data and its location is calculated by
interpolating between other known addresses.
interpolated
- True
if the result is interpolated from other known places.
False
if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False
for an address location that is found in the partner data, but
returns True
if an address does not exist in the partner data and its location is calculated
by interpolating between other known addresses.
public Boolean getInterpolated()
True
if the result is interpolated from other known places.
False
if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False
for an address location that is found in the partner data, but returns
True
if an address does not exist in the partner data and its location is calculated by
interpolating between other known addresses.
True
if the result is interpolated from other known places.
False
if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False
for an address location that is found in the partner data, but
returns True
if an address does not exist in the partner data and its location is calculated
by interpolating between other known addresses.
public Place withInterpolated(Boolean interpolated)
True
if the result is interpolated from other known places.
False
if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False
for an address location that is found in the partner data, but returns
True
if an address does not exist in the partner data and its location is calculated by
interpolating between other known addresses.
interpolated
- True
if the result is interpolated from other known places.
False
if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False
for an address location that is found in the partner data, but
returns True
if an address does not exist in the partner data and its location is calculated
by interpolating between other known addresses.
public Boolean isInterpolated()
True
if the result is interpolated from other known places.
False
if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False
for an address location that is found in the partner data, but returns
True
if an address does not exist in the partner data and its location is calculated by
interpolating between other known addresses.
True
if the result is interpolated from other known places.
False
if the Place is a known place.
Not returned when the partner does not provide the information.
For example, returns False
for an address location that is found in the partner data, but
returns True
if an address does not exist in the partner data and its location is calculated
by interpolating between other known addresses.
public void setTimeZone(TimeZone timeZone)
The time zone in which the Place
is located. Returned only when using HERE or Grab as the selected
partner.
timeZone
- The time zone in which the Place
is located. Returned only when using HERE or Grab as the
selected partner.public TimeZone getTimeZone()
The time zone in which the Place
is located. Returned only when using HERE or Grab as the selected
partner.
Place
is located. Returned only when using HERE or Grab as the
selected partner.public Place withTimeZone(TimeZone timeZone)
The time zone in which the Place
is located. Returned only when using HERE or Grab as the selected
partner.
timeZone
- The time zone in which the Place
is located. Returned only when using HERE or Grab as the
selected partner.public void setUnitType(String unitType)
For addresses with a UnitNumber
, the type of unit. For example, Apartment
.
Returned only for a place index that uses Esri as a data provider.
unitType
- For addresses with a UnitNumber
, the type of unit. For example, Apartment
.
Returned only for a place index that uses Esri as a data provider.
public String getUnitType()
For addresses with a UnitNumber
, the type of unit. For example, Apartment
.
Returned only for a place index that uses Esri as a data provider.
UnitNumber
, the type of unit. For example, Apartment
.
Returned only for a place index that uses Esri as a data provider.
public Place withUnitType(String unitType)
For addresses with a UnitNumber
, the type of unit. For example, Apartment
.
Returned only for a place index that uses Esri as a data provider.
unitType
- For addresses with a UnitNumber
, the type of unit. For example, Apartment
.
Returned only for a place index that uses Esri as a data provider.
public void setUnitNumber(String unitNumber)
For addresses with multiple units, the unit identifier. Can include numbers and letters, for example
3B
or Unit 123
.
Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for
SearchPlaceIndexForPosition
.
unitNumber
- For addresses with multiple units, the unit identifier. Can include numbers and letters, for example
3B
or Unit 123
.
Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for
SearchPlaceIndexForPosition
.
public String getUnitNumber()
For addresses with multiple units, the unit identifier. Can include numbers and letters, for example
3B
or Unit 123
.
Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for
SearchPlaceIndexForPosition
.
3B
or Unit 123
.
Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for
SearchPlaceIndexForPosition
.
public Place withUnitNumber(String unitNumber)
For addresses with multiple units, the unit identifier. Can include numbers and letters, for example
3B
or Unit 123
.
Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for
SearchPlaceIndexForPosition
.
unitNumber
- For addresses with multiple units, the unit identifier. Can include numbers and letters, for example
3B
or Unit 123
.
Returned only for a place index that uses Esri or Grab as a data provider. Is not returned for
SearchPlaceIndexForPosition
.
public List<String> getCategories()
The Amazon Location categories that describe this Place.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
public void setCategories(Collection<String> categories)
The Amazon Location categories that describe this Place.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
categories
- The Amazon Location categories that describe this Place.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
public Place withCategories(String... categories)
The Amazon Location categories that describe this Place.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setCategories(java.util.Collection)
or withCategories(java.util.Collection)
if you want to
override the existing values.
categories
- The Amazon Location categories that describe this Place.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
public Place withCategories(Collection<String> categories)
The Amazon Location categories that describe this Place.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
categories
- The Amazon Location categories that describe this Place.
For more information about using categories, including a list of Amazon Location categories, see Categories and filtering, in the Amazon Location Service Developer Guide.
public List<String> getSupplementalCategories()
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
public void setSupplementalCategories(Collection<String> supplementalCategories)
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
supplementalCategories
- Categories from the data provider that describe the Place that are not mapped to any Amazon Location
categories.public Place withSupplementalCategories(String... supplementalCategories)
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
NOTE: This method appends the values to the existing list (if any). Use
setSupplementalCategories(java.util.Collection)
or
withSupplementalCategories(java.util.Collection)
if you want to override the existing values.
supplementalCategories
- Categories from the data provider that describe the Place that are not mapped to any Amazon Location
categories.public Place withSupplementalCategories(Collection<String> supplementalCategories)
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
supplementalCategories
- Categories from the data provider that describe the Place that are not mapped to any Amazon Location
categories.public void setSubMunicipality(String subMunicipality)
An area that's part of a larger municipality. For example, Blissville
is a submunicipality in the
Queen County in New York.
This property supported by Esri and OpenData. The Esri property is district
, and the OpenData
property is borough
.
subMunicipality
- An area that's part of a larger municipality. For example, Blissville
is a submunicipality
in the Queen County in New York.
This property supported by Esri and OpenData. The Esri property is district
, and the OpenData
property is borough
.
public String getSubMunicipality()
An area that's part of a larger municipality. For example, Blissville
is a submunicipality in the
Queen County in New York.
This property supported by Esri and OpenData. The Esri property is district
, and the OpenData
property is borough
.
Blissville
is a submunicipality
in the Queen County in New York.
This property supported by Esri and OpenData. The Esri property is district
, and the
OpenData property is borough
.
public Place withSubMunicipality(String subMunicipality)
An area that's part of a larger municipality. For example, Blissville
is a submunicipality in the
Queen County in New York.
This property supported by Esri and OpenData. The Esri property is district
, and the OpenData
property is borough
.
subMunicipality
- An area that's part of a larger municipality. For example, Blissville
is a submunicipality
in the Queen County in New York.
This property supported by Esri and OpenData. The Esri property is district
, and the OpenData
property is borough
.
public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.