Interface Place.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Place.Builder,
,Place> SdkBuilder<Place.Builder,
,Place> SdkPojo
- Enclosing class:
Place
-
Method Summary
Modifier and TypeMethodDescriptionaddressNumber
(String addressNumber) The numerical portion of an address, such as a building number.categories
(String... categories) The Amazon Location categories that describe this Place.categories
(Collection<String> categories) The Amazon Location categories that describe this Place.A country/region specified using ISO 3166 3-digit country/region code.default Place.Builder
geometry
(Consumer<PlaceGeometry.Builder> geometry) Sets the value of the Geometry property for this object.geometry
(PlaceGeometry geometry) Sets the value of the Geometry property for this object.interpolated
(Boolean interpolated) True
if the result is interpolated from other known places.The full name and address of the point of interest such as a city, region, or country.municipality
(String municipality) A name for a local area, such as a city or town name.neighborhood
(String neighborhood) The name of a community district.postalCode
(String postalCode) A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.A name for an area or geographical division, such as a province or state name.The name for a street or a road to identify a location.subMunicipality
(String subMunicipality) An area that's part of a larger municipality.A county, or an area that's part of a larger region.supplementalCategories
(String... supplementalCategories) Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.supplementalCategories
(Collection<String> supplementalCategories) Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.default Place.Builder
timeZone
(Consumer<TimeZone.Builder> timeZone) The time zone in which thePlace
is located.The time zone in which thePlace
is located.unitNumber
(String unitNumber) For addresses with multiple units, the unit identifier.For addresses with aUnitNumber
, the type of unit.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
addressNumber
The numerical portion of an address, such as a building number.
- Parameters:
addressNumber
- The numerical portion of an address, such as a building number.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
country
A country/region specified using ISO 3166 3-digit country/region code. For example,
CAN
.- Parameters:
country
- A country/region specified using ISO 3166 3-digit country/region code. For example,CAN
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
geometry
Sets the value of the Geometry property for this object.- Parameters:
geometry
- The new value for the Geometry property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
geometry
Sets the value of the Geometry property for this object. This is a convenience method that creates an instance of thePlaceGeometry.Builder
avoiding the need to create one manually viaPlaceGeometry.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togeometry(PlaceGeometry)
.- Parameters:
geometry
- a consumer that will call methods onPlaceGeometry.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 returnsTrue
if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.- Parameters:
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 returnsTrue
if an address does not exist in the partner data and its location is calculated by interpolating between other known addresses.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
municipality
A name for a local area, such as a city or town name. For example,
Toronto
.- Parameters:
municipality
- A name for a local area, such as a city or town name. For example,Toronto
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
neighborhood
The name of a community district. For example,
Downtown
.- Parameters:
neighborhood
- The name of a community district. For example,Downtown
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
postalCode
A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
- Parameters:
postalCode
- A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
region
A name for an area or geographical division, such as a province or state name. For example,
British Columbia
.- Parameters:
region
- A name for an area or geographical division, such as a province or state name. For example,British Columbia
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
street
The name for a street or a road to identify a location. For example,
Main Street
.- Parameters:
street
- The name for a street or a road to identify a location. For example,Main Street
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 is only returned for a place index that uses Esri as a data provider. The property is represented as a
district
.For more information about data providers, see Amazon Location Service data providers.
- Parameters:
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 is only returned for a place index that uses Esri as a data provider. The property is represented as a
district
.For more information about data providers, see Amazon Location Service data providers.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subRegion
A county, or an area that's part of a larger region. For example,
Metro Vancouver
.- Parameters:
subRegion
- A county, or an area that's part of a larger region. For example,Metro Vancouver
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
supplementalCategories
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
- Parameters:
supplementalCategories
- Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
supplementalCategories
Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.
- Parameters:
supplementalCategories
- Categories from the data provider that describe the Place that are not mapped to any Amazon Location categories.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timeZone
The time zone in which the
Place
is located. Returned only when using HERE or Grab as the selected partner.- Parameters:
timeZone
- The time zone in which thePlace
is located. Returned only when using HERE or Grab as the selected partner.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timeZone
The time zone in which the
This is a convenience method that creates an instance of thePlace
is located. Returned only when using HERE or Grab as the selected partner.TimeZone.Builder
avoiding the need to create one manually viaTimeZone.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimeZone(TimeZone)
.- Parameters:
timeZone
- a consumer that will call methods onTimeZone.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
unitNumber
For addresses with multiple units, the unit identifier. Can include numbers and letters, for example
3B
orUnit 123
.This property is returned only for a place index that uses Esri or Grab as a data provider. It is not returned for
SearchPlaceIndexForPosition
.- Parameters:
unitNumber
- For addresses with multiple units, the unit identifier. Can include numbers and letters, for example3B
orUnit 123
.This property is returned only for a place index that uses Esri or Grab as a data provider. It is not returned for
SearchPlaceIndexForPosition
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
unitType
For addresses with a
UnitNumber
, the type of unit. For example,Apartment
.This property is returned only for a place index that uses Esri as a data provider.
- Parameters:
unitType
- For addresses with aUnitNumber
, the type of unit. For example,Apartment
.This property is returned only for a place index that uses Esri as a data provider.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-