/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include 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
* Reference
The numerical portion of an address, such as a building number.
*/ inline const Aws::String& GetAddressNumber() const{ return m_addressNumber; } /** *The numerical portion of an address, such as a building number.
*/ inline bool AddressNumberHasBeenSet() const { return m_addressNumberHasBeenSet; } /** *The numerical portion of an address, such as a building number.
*/ inline void SetAddressNumber(const Aws::String& value) { m_addressNumberHasBeenSet = true; m_addressNumber = value; } /** *The numerical portion of an address, such as a building number.
*/ inline void SetAddressNumber(Aws::String&& value) { m_addressNumberHasBeenSet = true; m_addressNumber = std::move(value); } /** *The numerical portion of an address, such as a building number.
*/ inline void SetAddressNumber(const char* value) { m_addressNumberHasBeenSet = true; m_addressNumber.assign(value); } /** *The numerical portion of an address, such as a building number.
*/ inline Place& WithAddressNumber(const Aws::String& value) { SetAddressNumber(value); return *this;} /** *The numerical portion of an address, such as a building number.
*/ inline Place& WithAddressNumber(Aws::String&& value) { SetAddressNumber(std::move(value)); return *this;} /** *The numerical portion of an address, such as a building number.
*/ inline Place& WithAddressNumber(const char* value) { SetAddressNumber(value); 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.
*/ inline const Aws::VectorThe 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.
*/ inline bool CategoriesHasBeenSet() const { return m_categoriesHasBeenSet; } /** *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.
*/ inline void SetCategories(const Aws::VectorThe 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.
*/ inline void SetCategories(Aws::VectorThe 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.
*/ inline Place& WithCategories(const Aws::VectorThe 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.
*/ inline Place& WithCategories(Aws::VectorThe 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.
*/ inline Place& AddCategories(const Aws::String& value) { m_categoriesHasBeenSet = true; m_categories.push_back(value); 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.
*/ inline Place& AddCategories(Aws::String&& value) { m_categoriesHasBeenSet = true; m_categories.push_back(std::move(value)); 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.
*/ inline Place& AddCategories(const char* value) { m_categoriesHasBeenSet = true; m_categories.push_back(value); return *this; } /** *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
.
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
.
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.
*
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
.
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
.
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
.
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
.
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
.
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
.
A group of numbers and letters in a country-specific format, which * accompanies the address for the purpose of identifying a location.
*/ inline const Aws::String& GetPostalCode() const{ return m_postalCode; } /** *A group of numbers and letters in a country-specific format, which * accompanies the address for the purpose of identifying a location.
*/ inline bool PostalCodeHasBeenSet() const { return m_postalCodeHasBeenSet; } /** *A group of numbers and letters in a country-specific format, which * accompanies the address for the purpose of identifying a location.
*/ inline void SetPostalCode(const Aws::String& value) { m_postalCodeHasBeenSet = true; m_postalCode = value; } /** *A group of numbers and letters in a country-specific format, which * accompanies the address for the purpose of identifying a location.
*/ inline void SetPostalCode(Aws::String&& value) { m_postalCodeHasBeenSet = true; m_postalCode = std::move(value); } /** *A group of numbers and letters in a country-specific format, which * accompanies the address for the purpose of identifying a location.
*/ inline void SetPostalCode(const char* value) { m_postalCodeHasBeenSet = true; m_postalCode.assign(value); } /** *A group of numbers and letters in a country-specific format, which * accompanies the address for the purpose of identifying a location.
*/ inline Place& WithPostalCode(const Aws::String& value) { SetPostalCode(value); return *this;} /** *A group of numbers and letters in a country-specific format, which * accompanies the address for the purpose of identifying a location.
*/ inline Place& WithPostalCode(Aws::String&& value) { SetPostalCode(std::move(value)); return *this;} /** *A group of numbers and letters in a country-specific format, which * accompanies the address for the purpose of identifying a location.
*/ inline Place& WithPostalCode(const char* value) { SetPostalCode(value); 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
.
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
.
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
.
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
.
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
.
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
.
Categories from the data provider that describe the Place that are not mapped * to any Amazon Location categories.
*/ inline const Aws::VectorCategories from the data provider that describe the Place that are not mapped * to any Amazon Location categories.
*/ inline bool SupplementalCategoriesHasBeenSet() const { return m_supplementalCategoriesHasBeenSet; } /** *Categories from the data provider that describe the Place that are not mapped * to any Amazon Location categories.
*/ inline void SetSupplementalCategories(const Aws::VectorCategories from the data provider that describe the Place that are not mapped * to any Amazon Location categories.
*/ inline void SetSupplementalCategories(Aws::VectorCategories from the data provider that describe the Place that are not mapped * to any Amazon Location categories.
*/ inline Place& WithSupplementalCategories(const Aws::VectorCategories from the data provider that describe the Place that are not mapped * to any Amazon Location categories.
*/ inline Place& WithSupplementalCategories(Aws::VectorCategories from the data provider that describe the Place that are not mapped * to any Amazon Location categories.
*/ inline Place& AddSupplementalCategories(const Aws::String& value) { m_supplementalCategoriesHasBeenSet = true; m_supplementalCategories.push_back(value); return *this; } /** *Categories from the data provider that describe the Place that are not mapped * to any Amazon Location categories.
*/ inline Place& AddSupplementalCategories(Aws::String&& value) { m_supplementalCategoriesHasBeenSet = true; m_supplementalCategories.push_back(std::move(value)); return *this; } /** *Categories from the data provider that describe the Place that are not mapped * to any Amazon Location categories.
*/ inline Place& AddSupplementalCategories(const char* value) { m_supplementalCategoriesHasBeenSet = true; m_supplementalCategories.push_back(value); return *this; } /** *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.
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
.
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 a UnitNumber
, the type of unit. For example,
* Apartment
.
Returned only for a place index that uses * Esri as a data provider.
*/ inline const Aws::String& GetUnitType() const{ return m_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.
*/ inline bool UnitTypeHasBeenSet() const { return m_unitTypeHasBeenSet; } /** *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.
*/ inline void SetUnitType(const Aws::String& value) { m_unitTypeHasBeenSet = true; m_unitType = value; } /** *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.
*/ inline void SetUnitType(Aws::String&& value) { m_unitTypeHasBeenSet = true; m_unitType = std::move(value); } /** *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.
*/ inline void SetUnitType(const char* value) { m_unitTypeHasBeenSet = true; m_unitType.assign(value); } /** *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.
*/ inline Place& WithUnitType(const Aws::String& value) { SetUnitType(value); return *this;} /** *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.
*/ inline Place& WithUnitType(Aws::String&& value) { SetUnitType(std::move(value)); return *this;} /** *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.
*/ inline Place& WithUnitType(const char* value) { SetUnitType(value); return *this;} private: Aws::String m_addressNumber; bool m_addressNumberHasBeenSet = false; Aws::Vector