/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace LocationService { namespace Model { /** *

A summary of the request sent by using * SearchPlaceIndexForText.

See Also:

AWS * API Reference

*/ class SearchPlaceIndexForTextSummary { public: AWS_LOCATIONSERVICE_API SearchPlaceIndexForTextSummary(); AWS_LOCATIONSERVICE_API SearchPlaceIndexForTextSummary(Aws::Utils::Json::JsonView jsonValue); AWS_LOCATIONSERVICE_API SearchPlaceIndexForTextSummary& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_LOCATIONSERVICE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

Contains the coordinates for the optional bias position specified in the * request.

This parameter contains a pair of numbers. The first number * represents the X coordinate, or longitude; the second number represents the Y * coordinate, or latitude.

For example, [-123.1174, 49.2847] * represents the position with longitude -123.1174 and latitude * 49.2847.

*/ inline const Aws::Vector& GetBiasPosition() const{ return m_biasPosition; } /** *

Contains the coordinates for the optional bias position specified in the * request.

This parameter contains a pair of numbers. The first number * represents the X coordinate, or longitude; the second number represents the Y * coordinate, or latitude.

For example, [-123.1174, 49.2847] * represents the position with longitude -123.1174 and latitude * 49.2847.

*/ inline bool BiasPositionHasBeenSet() const { return m_biasPositionHasBeenSet; } /** *

Contains the coordinates for the optional bias position specified in the * request.

This parameter contains a pair of numbers. The first number * represents the X coordinate, or longitude; the second number represents the Y * coordinate, or latitude.

For example, [-123.1174, 49.2847] * represents the position with longitude -123.1174 and latitude * 49.2847.

*/ inline void SetBiasPosition(const Aws::Vector& value) { m_biasPositionHasBeenSet = true; m_biasPosition = value; } /** *

Contains the coordinates for the optional bias position specified in the * request.

This parameter contains a pair of numbers. The first number * represents the X coordinate, or longitude; the second number represents the Y * coordinate, or latitude.

For example, [-123.1174, 49.2847] * represents the position with longitude -123.1174 and latitude * 49.2847.

*/ inline void SetBiasPosition(Aws::Vector&& value) { m_biasPositionHasBeenSet = true; m_biasPosition = std::move(value); } /** *

Contains the coordinates for the optional bias position specified in the * request.

This parameter contains a pair of numbers. The first number * represents the X coordinate, or longitude; the second number represents the Y * coordinate, or latitude.

For example, [-123.1174, 49.2847] * represents the position with longitude -123.1174 and latitude * 49.2847.

*/ inline SearchPlaceIndexForTextSummary& WithBiasPosition(const Aws::Vector& value) { SetBiasPosition(value); return *this;} /** *

Contains the coordinates for the optional bias position specified in the * request.

This parameter contains a pair of numbers. The first number * represents the X coordinate, or longitude; the second number represents the Y * coordinate, or latitude.

For example, [-123.1174, 49.2847] * represents the position with longitude -123.1174 and latitude * 49.2847.

*/ inline SearchPlaceIndexForTextSummary& WithBiasPosition(Aws::Vector&& value) { SetBiasPosition(std::move(value)); return *this;} /** *

Contains the coordinates for the optional bias position specified in the * request.

This parameter contains a pair of numbers. The first number * represents the X coordinate, or longitude; the second number represents the Y * coordinate, or latitude.

For example, [-123.1174, 49.2847] * represents the position with longitude -123.1174 and latitude * 49.2847.

*/ inline SearchPlaceIndexForTextSummary& AddBiasPosition(double value) { m_biasPositionHasBeenSet = true; m_biasPosition.push_back(value); return *this; } /** *

The geospatial data provider attached to the place index resource specified * in the request. Values can be one of the following:

  • Esri

    *

  • Grab

  • Here

For more * information about data providers, see Amazon * Location Service data providers.

*/ inline const Aws::String& GetDataSource() const{ return m_dataSource; } /** *

The geospatial data provider attached to the place index resource specified * in the request. Values can be one of the following:

  • Esri

    *

  • Grab

  • Here

For more * information about data providers, see Amazon * Location Service data providers.

*/ inline bool DataSourceHasBeenSet() const { return m_dataSourceHasBeenSet; } /** *

The geospatial data provider attached to the place index resource specified * in the request. Values can be one of the following:

  • Esri

    *

  • Grab

  • Here

For more * information about data providers, see Amazon * Location Service data providers.

*/ inline void SetDataSource(const Aws::String& value) { m_dataSourceHasBeenSet = true; m_dataSource = value; } /** *

The geospatial data provider attached to the place index resource specified * in the request. Values can be one of the following:

  • Esri

    *

  • Grab

  • Here

For more * information about data providers, see Amazon * Location Service data providers.

*/ inline void SetDataSource(Aws::String&& value) { m_dataSourceHasBeenSet = true; m_dataSource = std::move(value); } /** *

The geospatial data provider attached to the place index resource specified * in the request. Values can be one of the following:

  • Esri

    *

  • Grab

  • Here

For more * information about data providers, see Amazon * Location Service data providers.

*/ inline void SetDataSource(const char* value) { m_dataSourceHasBeenSet = true; m_dataSource.assign(value); } /** *

The geospatial data provider attached to the place index resource specified * in the request. Values can be one of the following:

  • Esri

    *

  • Grab

  • Here

For more * information about data providers, see Amazon * Location Service data providers.

*/ inline SearchPlaceIndexForTextSummary& WithDataSource(const Aws::String& value) { SetDataSource(value); return *this;} /** *

The geospatial data provider attached to the place index resource specified * in the request. Values can be one of the following:

  • Esri

    *

  • Grab

  • Here

For more * information about data providers, see Amazon * Location Service data providers.

*/ inline SearchPlaceIndexForTextSummary& WithDataSource(Aws::String&& value) { SetDataSource(std::move(value)); return *this;} /** *

The geospatial data provider attached to the place index resource specified * in the request. Values can be one of the following:

  • Esri

    *

  • Grab

  • Here

For more * information about data providers, see Amazon * Location Service data providers.

*/ inline SearchPlaceIndexForTextSummary& WithDataSource(const char* value) { SetDataSource(value); return *this;} /** *

Contains the coordinates for the optional bounding box specified in the * request.

*/ inline const Aws::Vector& GetFilterBBox() const{ return m_filterBBox; } /** *

Contains the coordinates for the optional bounding box specified in the * request.

*/ inline bool FilterBBoxHasBeenSet() const { return m_filterBBoxHasBeenSet; } /** *

Contains the coordinates for the optional bounding box specified in the * request.

*/ inline void SetFilterBBox(const Aws::Vector& value) { m_filterBBoxHasBeenSet = true; m_filterBBox = value; } /** *

Contains the coordinates for the optional bounding box specified in the * request.

*/ inline void SetFilterBBox(Aws::Vector&& value) { m_filterBBoxHasBeenSet = true; m_filterBBox = std::move(value); } /** *

Contains the coordinates for the optional bounding box specified in the * request.

*/ inline SearchPlaceIndexForTextSummary& WithFilterBBox(const Aws::Vector& value) { SetFilterBBox(value); return *this;} /** *

Contains the coordinates for the optional bounding box specified in the * request.

*/ inline SearchPlaceIndexForTextSummary& WithFilterBBox(Aws::Vector&& value) { SetFilterBBox(std::move(value)); return *this;} /** *

Contains the coordinates for the optional bounding box specified in the * request.

*/ inline SearchPlaceIndexForTextSummary& AddFilterBBox(double value) { m_filterBBoxHasBeenSet = true; m_filterBBox.push_back(value); return *this; } /** *

The optional category filter specified in the request.

*/ inline const Aws::Vector& GetFilterCategories() const{ return m_filterCategories; } /** *

The optional category filter specified in the request.

*/ inline bool FilterCategoriesHasBeenSet() const { return m_filterCategoriesHasBeenSet; } /** *

The optional category filter specified in the request.

*/ inline void SetFilterCategories(const Aws::Vector& value) { m_filterCategoriesHasBeenSet = true; m_filterCategories = value; } /** *

The optional category filter specified in the request.

*/ inline void SetFilterCategories(Aws::Vector&& value) { m_filterCategoriesHasBeenSet = true; m_filterCategories = std::move(value); } /** *

The optional category filter specified in the request.

*/ inline SearchPlaceIndexForTextSummary& WithFilterCategories(const Aws::Vector& value) { SetFilterCategories(value); return *this;} /** *

The optional category filter specified in the request.

*/ inline SearchPlaceIndexForTextSummary& WithFilterCategories(Aws::Vector&& value) { SetFilterCategories(std::move(value)); return *this;} /** *

The optional category filter specified in the request.

*/ inline SearchPlaceIndexForTextSummary& AddFilterCategories(const Aws::String& value) { m_filterCategoriesHasBeenSet = true; m_filterCategories.push_back(value); return *this; } /** *

The optional category filter specified in the request.

*/ inline SearchPlaceIndexForTextSummary& AddFilterCategories(Aws::String&& value) { m_filterCategoriesHasBeenSet = true; m_filterCategories.push_back(std::move(value)); return *this; } /** *

The optional category filter specified in the request.

*/ inline SearchPlaceIndexForTextSummary& AddFilterCategories(const char* value) { m_filterCategoriesHasBeenSet = true; m_filterCategories.push_back(value); return *this; } /** *

Contains the optional country filter specified in the request.

*/ inline const Aws::Vector& GetFilterCountries() const{ return m_filterCountries; } /** *

Contains the optional country filter specified in the request.

*/ inline bool FilterCountriesHasBeenSet() const { return m_filterCountriesHasBeenSet; } /** *

Contains the optional country filter specified in the request.

*/ inline void SetFilterCountries(const Aws::Vector& value) { m_filterCountriesHasBeenSet = true; m_filterCountries = value; } /** *

Contains the optional country filter specified in the request.

*/ inline void SetFilterCountries(Aws::Vector&& value) { m_filterCountriesHasBeenSet = true; m_filterCountries = std::move(value); } /** *

Contains the optional country filter specified in the request.

*/ inline SearchPlaceIndexForTextSummary& WithFilterCountries(const Aws::Vector& value) { SetFilterCountries(value); return *this;} /** *

Contains the optional country filter specified in the request.

*/ inline SearchPlaceIndexForTextSummary& WithFilterCountries(Aws::Vector&& value) { SetFilterCountries(std::move(value)); return *this;} /** *

Contains the optional country filter specified in the request.

*/ inline SearchPlaceIndexForTextSummary& AddFilterCountries(const Aws::String& value) { m_filterCountriesHasBeenSet = true; m_filterCountries.push_back(value); return *this; } /** *

Contains the optional country filter specified in the request.

*/ inline SearchPlaceIndexForTextSummary& AddFilterCountries(Aws::String&& value) { m_filterCountriesHasBeenSet = true; m_filterCountries.push_back(std::move(value)); return *this; } /** *

Contains the optional country filter specified in the request.

*/ inline SearchPlaceIndexForTextSummary& AddFilterCountries(const char* value) { m_filterCountriesHasBeenSet = true; m_filterCountries.push_back(value); return *this; } /** *

The preferred language used to return results. Matches the language in the * request. The value is a valid BCP * 47 language tag, for example, en for English.

*/ inline const Aws::String& GetLanguage() const{ return m_language; } /** *

The preferred language used to return results. Matches the language in the * request. The value is a valid BCP * 47 language tag, for example, en for English.

*/ inline bool LanguageHasBeenSet() const { return m_languageHasBeenSet; } /** *

The preferred language used to return results. Matches the language in the * request. The value is a valid BCP * 47 language tag, for example, en for English.

*/ inline void SetLanguage(const Aws::String& value) { m_languageHasBeenSet = true; m_language = value; } /** *

The preferred language used to return results. Matches the language in the * request. The value is a valid BCP * 47 language tag, for example, en for English.

*/ inline void SetLanguage(Aws::String&& value) { m_languageHasBeenSet = true; m_language = std::move(value); } /** *

The preferred language used to return results. Matches the language in the * request. The value is a valid BCP * 47 language tag, for example, en for English.

*/ inline void SetLanguage(const char* value) { m_languageHasBeenSet = true; m_language.assign(value); } /** *

The preferred language used to return results. Matches the language in the * request. The value is a valid BCP * 47 language tag, for example, en for English.

*/ inline SearchPlaceIndexForTextSummary& WithLanguage(const Aws::String& value) { SetLanguage(value); return *this;} /** *

The preferred language used to return results. Matches the language in the * request. The value is a valid BCP * 47 language tag, for example, en for English.

*/ inline SearchPlaceIndexForTextSummary& WithLanguage(Aws::String&& value) { SetLanguage(std::move(value)); return *this;} /** *

The preferred language used to return results. Matches the language in the * request. The value is a valid BCP * 47 language tag, for example, en for English.

*/ inline SearchPlaceIndexForTextSummary& WithLanguage(const char* value) { SetLanguage(value); return *this;} /** *

Contains the optional result count limit specified in the request.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

Contains the optional result count limit specified in the request.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

Contains the optional result count limit specified in the request.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

Contains the optional result count limit specified in the request.

*/ inline SearchPlaceIndexForTextSummary& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

The bounding box that fully contains all search results.

If you * specified the optional FilterBBox parameter in the request, * ResultBBox is contained within FilterBBox.

*/ inline const Aws::Vector& GetResultBBox() const{ return m_resultBBox; } /** *

The bounding box that fully contains all search results.

If you * specified the optional FilterBBox parameter in the request, * ResultBBox is contained within FilterBBox.

*/ inline bool ResultBBoxHasBeenSet() const { return m_resultBBoxHasBeenSet; } /** *

The bounding box that fully contains all search results.

If you * specified the optional FilterBBox parameter in the request, * ResultBBox is contained within FilterBBox.

*/ inline void SetResultBBox(const Aws::Vector& value) { m_resultBBoxHasBeenSet = true; m_resultBBox = value; } /** *

The bounding box that fully contains all search results.

If you * specified the optional FilterBBox parameter in the request, * ResultBBox is contained within FilterBBox.

*/ inline void SetResultBBox(Aws::Vector&& value) { m_resultBBoxHasBeenSet = true; m_resultBBox = std::move(value); } /** *

The bounding box that fully contains all search results.

If you * specified the optional FilterBBox parameter in the request, * ResultBBox is contained within FilterBBox.

*/ inline SearchPlaceIndexForTextSummary& WithResultBBox(const Aws::Vector& value) { SetResultBBox(value); return *this;} /** *

The bounding box that fully contains all search results.

If you * specified the optional FilterBBox parameter in the request, * ResultBBox is contained within FilterBBox.

*/ inline SearchPlaceIndexForTextSummary& WithResultBBox(Aws::Vector&& value) { SetResultBBox(std::move(value)); return *this;} /** *

The bounding box that fully contains all search results.

If you * specified the optional FilterBBox parameter in the request, * ResultBBox is contained within FilterBBox.

*/ inline SearchPlaceIndexForTextSummary& AddResultBBox(double value) { m_resultBBoxHasBeenSet = true; m_resultBBox.push_back(value); return *this; } /** *

The search text specified in the request.

*/ inline const Aws::String& GetText() const{ return m_text; } /** *

The search text specified in the request.

*/ inline bool TextHasBeenSet() const { return m_textHasBeenSet; } /** *

The search text specified in the request.

*/ inline void SetText(const Aws::String& value) { m_textHasBeenSet = true; m_text = value; } /** *

The search text specified in the request.

*/ inline void SetText(Aws::String&& value) { m_textHasBeenSet = true; m_text = std::move(value); } /** *

The search text specified in the request.

*/ inline void SetText(const char* value) { m_textHasBeenSet = true; m_text.assign(value); } /** *

The search text specified in the request.

*/ inline SearchPlaceIndexForTextSummary& WithText(const Aws::String& value) { SetText(value); return *this;} /** *

The search text specified in the request.

*/ inline SearchPlaceIndexForTextSummary& WithText(Aws::String&& value) { SetText(std::move(value)); return *this;} /** *

The search text specified in the request.

*/ inline SearchPlaceIndexForTextSummary& WithText(const char* value) { SetText(value); return *this;} private: Aws::Vector m_biasPosition; bool m_biasPositionHasBeenSet = false; Aws::String m_dataSource; bool m_dataSourceHasBeenSet = false; Aws::Vector m_filterBBox; bool m_filterBBoxHasBeenSet = false; Aws::Vector m_filterCategories; bool m_filterCategoriesHasBeenSet = false; Aws::Vector m_filterCountries; bool m_filterCountriesHasBeenSet = false; Aws::String m_language; bool m_languageHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::Vector m_resultBBox; bool m_resultBBoxHasBeenSet = false; Aws::String m_text; bool m_textHasBeenSet = false; }; } // namespace Model } // namespace LocationService } // namespace Aws