/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.geo.model; import java.io.Serializable; /** *
* 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. *
*/ public class Place implements Serializable { /** ** The numerical portion of an address, such as a building number. *
*/ private String addressNumber; /** ** 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. *
*/ private java.util.List
* A country/region specified using ISO 3166
* 3-digit country/region code. For example, CAN
.
*
* Places uses a point geometry to specify a location or a Place. *
*/ private PlaceGeometry geometry; /** *
* 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.
*
* 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
.
*
* A name for a local area, such as a city or town name. For example,
* Toronto
.
*
* The name of a community district. For example, Downtown
.
*
* A group of numbers and letters in a country-specific format, which * accompanies the address for the purpose of identifying a location. *
*/ private String postalCode; /** *
* A name for an area or geographical division, such as a province or state
* name. For example, British Columbia
.
*
* The name for a street or a road to identify a location. For example,
* Main Street
.
*
* A county, or an area that's part of a larger region. For example,
* Metro Vancouver
.
*
* Categories from the data provider that describe the Place that are not * mapped to any Amazon Location categories. *
*/ private java.util.List
* The time zone in which the Place
is located. Returned only
* when using HERE or Grab as the selected partner.
*
* 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
.
*
* 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. *
** The numerical portion of an address, such as a building number. *
* * @return* The numerical portion of an address, such as a building number. *
*/ public String getAddressNumber() { return addressNumber; } /** ** The numerical portion of an address, such as a building number. *
* * @param addressNumber* The numerical portion of an address, such as a building * number. *
*/ public void setAddressNumber(String addressNumber) { this.addressNumber = addressNumber; } /** ** The numerical portion of an address, such as a building number. *
** Returns a reference to this object so that method calls can be chained * together. * * @param addressNumber
* The numerical portion of an address, such as a building * number. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Place withAddressNumber(String addressNumber) { this.addressNumber = addressNumber; return this; } /** ** 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. *
* * @return* 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 java.util.List* 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. *
* * @param 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 void setCategories(java.util.Collection* 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Place withCategories(String... categories) { if (getCategories() == null) { this.categories = new java.util.ArrayList* 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Place withCategories(java.util.Collection
* A country/region specified using ISO 3166
* 3-digit country/region code. For example, CAN
.
*
* A country/region specified using ISO
* 3166 3-digit country/region code. For example,
* CAN
.
*
* A country/region specified using ISO 3166
* 3-digit country/region code. For example, CAN
.
*
* A country/region specified using ISO
* 3166 3-digit country/region code. For example,
* CAN
.
*
* A country/region specified using ISO 3166
* 3-digit country/region code. For example, CAN
.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param country
* A country/region specified using ISO
* 3166 3-digit country/region code. For example,
* CAN
.
*
* Places uses a point geometry to specify a location or a Place. *
* * @return* Places uses a point geometry to specify a location or a Place. *
*/ public PlaceGeometry getGeometry() { return geometry; } /** ** Places uses a point geometry to specify a location or a Place. *
* * @param geometry* Places uses a point geometry to specify a location or a Place. *
*/ public void setGeometry(PlaceGeometry geometry) { this.geometry = geometry; } /** ** Places uses a point geometry to specify a location or a Place. *
** Returns a reference to this object so that method calls can be chained * together. * * @param geometry
* Places uses a point geometry to specify a location or a Place. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Place withGeometry(PlaceGeometry geometry) { this.geometry = geometry; return this; } /** *
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param 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.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param 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
.
*
* A name for a local area, such as a city or town name. For example,
* Toronto
.
*
* A name for a local area, such as a city or town name. For
* example, Toronto
.
*
* A name for a local area, such as a city or town name. For example,
* Toronto
.
*
* A name for a local area, such as a city or town name. For
* example, Toronto
.
*
* A name for a local area, such as a city or town name. For example,
* Toronto
.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param municipality
* A name for a local area, such as a city or town name. For
* example, Toronto
.
*
* The name of a community district. For example, Downtown
.
*
* The name of a community district. For example,
* Downtown
.
*
* The name of a community district. For example, Downtown
.
*
* The name of a community district. For example,
* Downtown
.
*
* The name of a community district. For example, Downtown
.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param neighborhood
* The name of a community district. For example,
* Downtown
.
*
* A group of numbers and letters in a country-specific format, which * accompanies the address for the purpose of identifying a location. *
* * @return* 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() { return postalCode; } /** ** A group of numbers and letters in a country-specific format, which * accompanies the address for the purpose of identifying a location. *
* * @param 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 setPostalCode(String postalCode) { this.postalCode = postalCode; } /** ** A group of numbers and letters in a country-specific format, which * accompanies the address for the purpose of identifying a location. *
** Returns a reference to this object so that method calls can be chained * together. * * @param postalCode
* A group of numbers and letters in a country-specific format, * which accompanies the address for the purpose of identifying a * location. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Place withPostalCode(String postalCode) { this.postalCode = postalCode; return this; } /** *
* A name for an area or geographical division, such as a province or state
* name. For example, British Columbia
.
*
* A name for an area or geographical division, such as a province
* or state name. For example, British Columbia
.
*
* A name for an area or geographical division, such as a province or state
* name. For example, British Columbia
.
*
* A name for an area or geographical division, such as a
* province or state name. For example,
* British Columbia
.
*
* A name for an area or geographical division, such as a province or state
* name. For example, British Columbia
.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param region
* A name for an area or geographical division, such as a
* province or state name. For example,
* British Columbia
.
*
* The name for a street or a road to identify a location. For example,
* Main Street
.
*
* The name for a street or a road to identify a location. For
* example, Main Street
.
*
* The name for a street or a road to identify a location. For example,
* Main Street
.
*
* The name for a street or a road to identify a location. For
* example, Main Street
.
*
* The name for a street or a road to identify a location. For example,
* Main Street
.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param street
* The name for a street or a road to identify a location. For
* example, Main Street
.
*
* A county, or an area that's part of a larger region. For example,
* Metro Vancouver
.
*
* A county, or an area that's part of a larger region. For example,
* Metro Vancouver
.
*
* A county, or an area that's part of a larger region. For example,
* Metro Vancouver
.
*
* A county, or an area that's part of a larger region. For
* example, Metro Vancouver
.
*
* A county, or an area that's part of a larger region. For example,
* Metro Vancouver
.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param subRegion
* A county, or an area that's part of a larger region. For
* example, Metro Vancouver
.
*
* Categories from the data provider that describe the Place that are not * mapped to any Amazon Location categories. *
* * @return* Categories from the data provider that describe the Place that * are not mapped to any Amazon Location categories. *
*/ public java.util.List* Categories from the data provider that describe the Place that are not * mapped to any Amazon Location categories. *
* * @param supplementalCategories* Categories from the data provider that describe the Place that * are not mapped to any Amazon Location categories. *
*/ public void setSupplementalCategories(java.util.Collection* Categories from the data provider that describe the Place that are not * mapped to any Amazon Location categories. *
** Returns a reference to this object so that method calls can be chained * together. * * @param supplementalCategories
* Categories from the data provider that describe the Place that * are not mapped to any Amazon Location categories. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Place withSupplementalCategories(String... supplementalCategories) { if (getSupplementalCategories() == null) { this.supplementalCategories = new java.util.ArrayList* Categories from the data provider that describe the Place that are not * mapped to any Amazon Location categories. *
** Returns a reference to this object so that method calls can be chained * together. * * @param supplementalCategories
* Categories from the data provider that describe the Place that * are not mapped to any Amazon Location categories. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Place withSupplementalCategories(java.util.Collection
* The time zone in which the Place
is located. Returned only
* when using HERE or Grab as the selected partner.
*
* The time zone in which the Place
is located.
* Returned only when using HERE or Grab as the selected partner.
*
* The time zone in which the Place
is located. Returned only
* when using HERE or Grab as the selected partner.
*
* The time zone in which the Place
is located.
* Returned only when using HERE or Grab as the selected partner.
*
* The time zone in which the Place
is located. Returned only
* when using HERE or Grab as the selected partner.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param timeZone
* The time zone in which the Place
is located.
* Returned only when using HERE or Grab as the selected partner.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param 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
.
*
* 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. *
*
* 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. *
*
* 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. *
*
* 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. *
*
* 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @param 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. *
*