* 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 AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class Place implements Serializable, Cloneable, StructuredPojo { /** ** 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.
*
* 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. *
* * @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. *
* * @return The numerical portion of an address, such as a building number. */ public String getAddressNumber() { return this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public Place withAddressNumber(String addressNumber) { setAddressNumber(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.
*
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCategories(java.util.Collection)} or {@link #withCategories(java.util.Collection)} if you want to
* override the existing values.
*
* 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 Returns a reference to this object so that method calls can be chained together.
*/
public Place withCategories(String... categories) {
if (this.categories == null) {
setCategories(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.
*
* 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 Returns a reference to this 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,
* A country/region specified using ISO 3166 3-digit
* country/region code. For example,
* A country/region specified using ISO 3166 3-digit
* country/region code. For example,
*
*
* Not returned when the partner does not provide the information.
*
* For example, returns CAN.
* CAN.
*/
public void setCountry(String country) {
this.country = country;
}
/**
* CAN.
* CAN.
*/
public String getCountry() {
return this.country;
}
/**
* CAN.
* CAN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Place withCountry(String country) {
setCountry(country);
return this;
}
/**
* @param geometry
*/
public void setGeometry(PlaceGeometry geometry) {
this.geometry = geometry;
}
/**
* @return
*/
public PlaceGeometry getGeometry() {
return this.geometry;
}
/**
* @param geometry
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Place withGeometry(PlaceGeometry geometry) {
setGeometry(geometry);
return this;
}
/**
* True if the result is interpolated from other known places.
* False if the Place is a known place.
* 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 setInterpolated(Boolean interpolated) {
this.interpolated = 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.
*
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() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Place withInterpolated(Boolean interpolated) {
setInterpolated(interpolated);
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.
*/
public Boolean isInterpolated() {
return this.interpolated;
}
/**
*
* 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 void setLabel(String label) {
this.label = 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.
*
123 Any Street, Any Town, USA.
*/
public String getLabel() {
return this.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.
*
123 Any Street, Any Town, USA.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Place withLabel(String label) {
setLabel(label);
return this;
}
/**
*
* A name for a local area, such as a city or town name. For example, Toronto.
*
Toronto.
*/
public void setMunicipality(String municipality) {
this.municipality = municipality;
}
/**
*
* A name for a local area, such as a city or town name. For example, Toronto.
*
Toronto.
*/
public String getMunicipality() {
return this.municipality;
}
/**
*
* A name for a local area, such as a city or town name. For example, Toronto.
*
Toronto.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Place withMunicipality(String municipality) {
setMunicipality(municipality);
return this;
}
/**
*
* The name of a community district. For example, Downtown.
*
Downtown.
*/
public void setNeighborhood(String neighborhood) {
this.neighborhood = neighborhood;
}
/**
*
* The name of a community district. For example, Downtown.
*
Downtown.
*/
public String getNeighborhood() {
return this.neighborhood;
}
/**
*
* The name of a community district. For example, Downtown.
*
Downtown.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Place withNeighborhood(String neighborhood) {
setNeighborhood(neighborhood);
return this;
}
/**
* * 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. *
* * @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 this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public Place withPostalCode(String postalCode) { setPostalCode(postalCode); return this; } /** *
* A name for an area or geographical division, such as a province or state name. For example,
* British Columbia.
*
British Columbia.
*/
public void setRegion(String region) {
this.region = region;
}
/**
*
* A name for an area or geographical division, such as a province or state name. For example,
* British Columbia.
*
British Columbia.
*/
public String getRegion() {
return this.region;
}
/**
*
* A name for an area or geographical division, such as a province or state name. For example,
* British Columbia.
*
British Columbia.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Place withRegion(String region) {
setRegion(region);
return this;
}
/**
*
* The name for a street or a road to identify a location. For example, Main Street.
*
Main Street.
*/
public void setStreet(String street) {
this.street = street;
}
/**
*
* The name for a street or a road to identify a location. For example, Main Street.
*
Main Street.
*/
public String getStreet() {
return this.street;
}
/**
*
* The name for a street or a road to identify a location. For example, Main Street.
*
Main Street.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Place withStreet(String street) {
setStreet(street);
return this;
}
/**
*
* A county, or an area that's part of a larger region. For example, Metro Vancouver.
*
Metro Vancouver.
*/
public void setSubRegion(String subRegion) {
this.subRegion = subRegion;
}
/**
*
* A county, or an area that's part of a larger region. For example, Metro Vancouver.
*
Metro Vancouver.
*/
public String getSubRegion() {
return this.subRegion;
}
/**
*
* A county, or an area that's part of a larger region. For example, Metro Vancouver.
*
Metro Vancouver.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Place withSubRegion(String subRegion) {
setSubRegion(subRegion);
return this;
}
/**
* * 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. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setSupplementalCategories(java.util.Collection)} or * {@link #withSupplementalCategories(java.util.Collection)} if you want to override the existing values. *
* * @param supplementalCategories * Categories from the data provider that describe the Place that are not mapped to any Amazon Location * categories. * @return Returns a reference to this object so that method calls can be chained together. */ public Place withSupplementalCategories(String... supplementalCategories) { if (this.supplementalCategories == null) { setSupplementalCategories(new java.util.ArrayList* 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. * @return Returns a reference to this 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.
*
Place is located. Returned only when using HERE or Grab as the
* selected partner.
*/
public void setTimeZone(TimeZone timeZone) {
this.timeZone = timeZone;
}
/**
*
* 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 TimeZone getTimeZone() {
return this.timeZone;
}
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Place withTimeZone(TimeZone timeZone) {
setTimeZone(timeZone);
return this;
}
/**
*
* 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.
*
* 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.
*
* 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.
*
* 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 void setUnitType(String unitType) { this.unitType = 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. *
*UnitNumber, the type of unit. For example, Apartment.
* * Returned only for a place index that uses Esri as a data provider. *
*/ public String getUnitType() { return this.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. *
*UnitNumber, the type of unit. For example, Apartment.
* * Returned only for a place index that uses Esri as a data provider. *
* @return Returns a reference to this object so that method calls can be chained together. */ public Place withUnitType(String unitType) { setUnitType(unitType); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getAddressNumber() != null) sb.append("AddressNumber: ").append(getAddressNumber()).append(","); if (getCategories() != null) sb.append("Categories: ").append(getCategories()).append(","); if (getCountry() != null) sb.append("Country: ").append(getCountry()).append(","); if (getGeometry() != null) sb.append("Geometry: ").append(getGeometry()).append(","); if (getInterpolated() != null) sb.append("Interpolated: ").append(getInterpolated()).append(","); if (getLabel() != null) sb.append("Label: ").append(getLabel()).append(","); if (getMunicipality() != null) sb.append("Municipality: ").append(getMunicipality()).append(","); if (getNeighborhood() != null) sb.append("Neighborhood: ").append(getNeighborhood()).append(","); if (getPostalCode() != null) sb.append("PostalCode: ").append(getPostalCode()).append(","); if (getRegion() != null) sb.append("Region: ").append(getRegion()).append(","); if (getStreet() != null) sb.append("Street: ").append(getStreet()).append(","); if (getSubRegion() != null) sb.append("SubRegion: ").append(getSubRegion()).append(","); if (getSupplementalCategories() != null) sb.append("SupplementalCategories: ").append(getSupplementalCategories()).append(","); if (getTimeZone() != null) sb.append("TimeZone: ").append(getTimeZone()).append(","); if (getUnitNumber() != null) sb.append("UnitNumber: ").append(getUnitNumber()).append(","); if (getUnitType() != null) sb.append("UnitType: ").append(getUnitType()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof Place == false) return false; Place other = (Place) obj; if (other.getAddressNumber() == null ^ this.getAddressNumber() == null) return false; if (other.getAddressNumber() != null && other.getAddressNumber().equals(this.getAddressNumber()) == false) return false; if (other.getCategories() == null ^ this.getCategories() == null) return false; if (other.getCategories() != null && other.getCategories().equals(this.getCategories()) == false) return false; if (other.getCountry() == null ^ this.getCountry() == null) return false; if (other.getCountry() != null && other.getCountry().equals(this.getCountry()) == false) return false; if (other.getGeometry() == null ^ this.getGeometry() == null) return false; if (other.getGeometry() != null && other.getGeometry().equals(this.getGeometry()) == false) return false; if (other.getInterpolated() == null ^ this.getInterpolated() == null) return false; if (other.getInterpolated() != null && other.getInterpolated().equals(this.getInterpolated()) == false) return false; if (other.getLabel() == null ^ this.getLabel() == null) return false; if (other.getLabel() != null && other.getLabel().equals(this.getLabel()) == false) return false; if (other.getMunicipality() == null ^ this.getMunicipality() == null) return false; if (other.getMunicipality() != null && other.getMunicipality().equals(this.getMunicipality()) == false) return false; if (other.getNeighborhood() == null ^ this.getNeighborhood() == null) return false; if (other.getNeighborhood() != null && other.getNeighborhood().equals(this.getNeighborhood()) == false) return false; if (other.getPostalCode() == null ^ this.getPostalCode() == null) return false; if (other.getPostalCode() != null && other.getPostalCode().equals(this.getPostalCode()) == false) return false; if (other.getRegion() == null ^ this.getRegion() == null) return false; if (other.getRegion() != null && other.getRegion().equals(this.getRegion()) == false) return false; if (other.getStreet() == null ^ this.getStreet() == null) return false; if (other.getStreet() != null && other.getStreet().equals(this.getStreet()) == false) return false; if (other.getSubRegion() == null ^ this.getSubRegion() == null) return false; if (other.getSubRegion() != null && other.getSubRegion().equals(this.getSubRegion()) == false) return false; if (other.getSupplementalCategories() == null ^ this.getSupplementalCategories() == null) return false; if (other.getSupplementalCategories() != null && other.getSupplementalCategories().equals(this.getSupplementalCategories()) == false) return false; if (other.getTimeZone() == null ^ this.getTimeZone() == null) return false; if (other.getTimeZone() != null && other.getTimeZone().equals(this.getTimeZone()) == false) return false; if (other.getUnitNumber() == null ^ this.getUnitNumber() == null) return false; if (other.getUnitNumber() != null && other.getUnitNumber().equals(this.getUnitNumber()) == false) return false; if (other.getUnitType() == null ^ this.getUnitType() == null) return false; if (other.getUnitType() != null && other.getUnitType().equals(this.getUnitType()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAddressNumber() == null) ? 0 : getAddressNumber().hashCode()); hashCode = prime * hashCode + ((getCategories() == null) ? 0 : getCategories().hashCode()); hashCode = prime * hashCode + ((getCountry() == null) ? 0 : getCountry().hashCode()); hashCode = prime * hashCode + ((getGeometry() == null) ? 0 : getGeometry().hashCode()); hashCode = prime * hashCode + ((getInterpolated() == null) ? 0 : getInterpolated().hashCode()); hashCode = prime * hashCode + ((getLabel() == null) ? 0 : getLabel().hashCode()); hashCode = prime * hashCode + ((getMunicipality() == null) ? 0 : getMunicipality().hashCode()); hashCode = prime * hashCode + ((getNeighborhood() == null) ? 0 : getNeighborhood().hashCode()); hashCode = prime * hashCode + ((getPostalCode() == null) ? 0 : getPostalCode().hashCode()); hashCode = prime * hashCode + ((getRegion() == null) ? 0 : getRegion().hashCode()); hashCode = prime * hashCode + ((getStreet() == null) ? 0 : getStreet().hashCode()); hashCode = prime * hashCode + ((getSubRegion() == null) ? 0 : getSubRegion().hashCode()); hashCode = prime * hashCode + ((getSupplementalCategories() == null) ? 0 : getSupplementalCategories().hashCode()); hashCode = prime * hashCode + ((getTimeZone() == null) ? 0 : getTimeZone().hashCode()); hashCode = prime * hashCode + ((getUnitNumber() == null) ? 0 : getUnitNumber().hashCode()); hashCode = prime * hashCode + ((getUnitType() == null) ? 0 : getUnitType().hashCode()); return hashCode; } @Override public Place clone() { try { return (Place) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.location.model.transform.PlaceMarshaller.getInstance().marshall(this, protocolMarshaller); } }