Place (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.location.model.Place

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Place()

Constructors
Constructor and Description
`Place()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`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`	`getSubRegion()` A country, or an area that's part of a larger region.
`TimeZone`	`getTimeZone()` The time zone in which the `Place` is located.
`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`	`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`	`setSubRegion(String subRegion)` A country, or an area that's part of a larger region.
`void`	`setTimeZone(TimeZone timeZone)` The time zone in which the `Place` is located.
`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`	`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`	`withSubRegion(String subRegion)` A country, or an area that's part of a larger region.
`Place`	`withTimeZone(TimeZone timeZone)` The time zone in which the `Place` is located.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Place
```
public Place()
```
- Method Detail
  - setAddressNumber
```
public void setAddressNumber(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.
  - getAddressNumber
```
public String getAddressNumber()
```
    The numerical portion of an address, such as a building number.
    
    Returns:
    
    The numerical portion of an address, such as a building number.
  - withAddressNumber
```
public Place withAddressNumber(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.
  - setCountry
```
public void setCountry(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.
  - getCountry
```
public String getCountry()
```
    A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.
    
    Returns:
    
    A country/region specified using ISO 3166 3-digit country/region code. For example, CAN.
  - withCountry
```
public Place withCountry(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.
  - setGeometry
```
public void setGeometry(PlaceGeometry geometry)
```
    Parameters:
    
    geometry -
  - getGeometry
```
public PlaceGeometry getGeometry()
```
    Returns:
  - withGeometry
```
public Place withGeometry(PlaceGeometry geometry)
```
    Parameters:
    
    geometry -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInterpolated
```
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.
    
    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.
  - getInterpolated
```
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.
    
    Returns:
    
    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.
  - withInterpolated
```
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.
    
    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.
  - isInterpolated
```
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.
    
    Returns:
    
    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.
  - setLabel
```
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.
    
    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.
  - getLabel
```
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.
    
    Returns:
    
    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.
  - withLabel
```
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.
    
    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.
  - setMunicipality
```
public void setMunicipality(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.
  - getMunicipality
```
public String getMunicipality()
```
    A name for a local area, such as a city or town name. For example, Toronto.
    
    Returns:
    
    A name for a local area, such as a city or town name. For example, Toronto.
  - withMunicipality
```
public Place withMunicipality(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.
  - setNeighborhood
```
public void setNeighborhood(String neighborhood)
```
    The name of a community district. For example, Downtown.
    
    Parameters:
    
    neighborhood - The name of a community district. For example, Downtown.
  - getNeighborhood
```
public String getNeighborhood()
```
    The name of a community district. For example, Downtown.
    
    Returns:
    
    The name of a community district. For example, Downtown.
  - withNeighborhood
```
public Place withNeighborhood(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.
  - setPostalCode
```
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.
    
    Parameters:
    
    postalCode - A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
  - getPostalCode
```
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.
    
    Returns:
    
    A group of numbers and letters in a country-specific format, which accompanies the address for the purpose of identifying a location.
  - withPostalCode
```
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.
    
    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.
  - setRegion
```
public void setRegion(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.
  - getRegion
```
public String getRegion()
```
    A name for an area or geographical division, such as a province or state name. For example, British Columbia.
    
    Returns:
    
    A name for an area or geographical division, such as a province or state name. For example, British Columbia.
  - withRegion
```
public Place withRegion(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.
  - setStreet
```
public void setStreet(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.
  - getStreet
```
public String getStreet()
```
    The name for a street or a road to identify a location. For example, Main Street.
    
    Returns:
    
    The name for a street or a road to identify a location. For example, Main Street.
  - withStreet
```
public Place withStreet(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.
  - setSubRegion
```
public void setSubRegion(String subRegion)
```
    A country, or an area that's part of a larger region. For example, Metro Vancouver.
    
    Parameters:
    
    subRegion - A country, or an area that's part of a larger region. For example, Metro Vancouver.
  - getSubRegion
```
public String getSubRegion()
```
    A country, or an area that's part of a larger region. For example, Metro Vancouver.
    
    Returns:
    
    A country, or an area that's part of a larger region. For example, Metro Vancouver.
  - withSubRegion
```
public Place withSubRegion(String subRegion)
```
    A country, or an area that's part of a larger region. For example, Metro Vancouver.
    
    Parameters:
    
    subRegion - A country, 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.
  - setTimeZone
```
public void setTimeZone(TimeZone timeZone)
```
    The time zone in which the Place is located. Returned only when using Here as the selected partner.
    
    Parameters:
    
    timeZone - The time zone in which the Place is located. Returned only when using Here as the selected partner.
  - getTimeZone
```
public TimeZone getTimeZone()
```
    The time zone in which the Place is located. Returned only when using Here as the selected partner.
    
    Returns:
    
    The time zone in which the Place is located. Returned only when using Here as the selected partner.
  - withTimeZone
```
public Place withTimeZone(TimeZone timeZone)
```
    The time zone in which the Place is located. Returned only when using Here as the selected partner.
    
    Parameters:
    
    timeZone - The time zone in which the Place is located. Returned only when using Here as the selected partner.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Place clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Place

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Place

Method Detail

setAddressNumber

getAddressNumber

withAddressNumber

setCountry

getCountry

withCountry

setGeometry

getGeometry

withGeometry

setInterpolated

getInterpolated

withInterpolated

isInterpolated

setLabel

getLabel

withLabel

setMunicipality

getMunicipality

withMunicipality

setNeighborhood

getNeighborhood

withNeighborhood

setPostalCode

getPostalCode

withPostalCode

setRegion

getRegion

withRegion

setStreet

getStreet

withStreet

setSubRegion

getSubRegion

withSubRegion

setTimeZone

getTimeZone

withTimeZone

toString

equals

hashCode

clone

marshall