Package software.amazon.awssdk.services.location.model

Interface Place.Builder

    • Method Detail

      • label

        Place.Builder label​(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.

        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.

      • geometry

        Place.Builder geometry​(PlaceGeometry 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.

      • addressNumber

        Place.Builder addressNumber​(String 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.

      • street

        Place.Builder street​(String 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.

      • neighborhood

        Place.Builder neighborhood​(String 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.

      • municipality

        Place.Builder municipality​(String 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.

      • subRegion

        Place.Builder subRegion​(String 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.

      • region

        Place.Builder region​(String 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.

      • country

        Place.Builder country​(String 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.

      • postalCode

        Place.Builder 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.

        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.

      • interpolated

        Place.Builder interpolated​(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.

        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 returns True 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.

      • timeZone

        Place.Builder timeZone​(TimeZone 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 the Place 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.

      • unitType

        Place.Builder unitType​(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.

        Parameters:
        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.

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

      • unitNumber

        Place.Builder unitNumber​(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.

        Parameters:
        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.

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

      • categories

        Place.Builder categories​(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.

        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

        Place.Builder categories​(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.

        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.

      • supplementalCategories

        Place.Builder supplementalCategories​(Collection<String> 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

        Place.Builder supplementalCategories​(String... 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.

      • subMunicipality

        Place.Builder subMunicipality​(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.

        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 supported by Esri and OpenData. The Esri property is district, and the OpenData property is borough.

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