AWS SDK for C++

AWS SDK for C++ Version 1.11.781

Loading...
Searching...
No Matches
QueryResult.h
1
6#pragma once
7#include <aws/core/http/HttpResponse.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/kendra/Kendra_EXPORTS.h>
11#include <aws/kendra/model/FacetResult.h>
12#include <aws/kendra/model/FeaturedResultsItem.h>
13#include <aws/kendra/model/QueryResultItem.h>
14#include <aws/kendra/model/SpellCorrectedQuery.h>
15#include <aws/kendra/model/Warning.h>
16
17#include <utility>
18
19namespace Aws {
20template <typename RESULT_TYPE>
21class AmazonWebServiceResult;
22
23namespace Utils {
24namespace Json {
25class JsonValue;
26} // namespace Json
27} // namespace Utils
28namespace kendra {
29namespace Model {
31 public:
32 AWS_KENDRA_API QueryResult() = default;
35
37
43 inline const Aws::String& GetQueryId() const { return m_queryId; }
44 template <typename QueryIdT = Aws::String>
45 void SetQueryId(QueryIdT&& value) {
46 m_queryIdHasBeenSet = true;
47 m_queryId = std::forward<QueryIdT>(value);
48 }
49 template <typename QueryIdT = Aws::String>
50 QueryResult& WithQueryId(QueryIdT&& value) {
51 SetQueryId(std::forward<QueryIdT>(value));
52 return *this;
53 }
55
57
60 inline const Aws::Vector<QueryResultItem>& GetResultItems() const { return m_resultItems; }
61 template <typename ResultItemsT = Aws::Vector<QueryResultItem>>
62 void SetResultItems(ResultItemsT&& value) {
63 m_resultItemsHasBeenSet = true;
64 m_resultItems = std::forward<ResultItemsT>(value);
65 }
66 template <typename ResultItemsT = Aws::Vector<QueryResultItem>>
67 QueryResult& WithResultItems(ResultItemsT&& value) {
68 SetResultItems(std::forward<ResultItemsT>(value));
69 return *this;
70 }
71 template <typename ResultItemsT = QueryResultItem>
72 QueryResult& AddResultItems(ResultItemsT&& value) {
73 m_resultItemsHasBeenSet = true;
74 m_resultItems.emplace_back(std::forward<ResultItemsT>(value));
75 return *this;
76 }
78
80
85 inline const Aws::Vector<FacetResult>& GetFacetResults() const { return m_facetResults; }
86 template <typename FacetResultsT = Aws::Vector<FacetResult>>
87 void SetFacetResults(FacetResultsT&& value) {
88 m_facetResultsHasBeenSet = true;
89 m_facetResults = std::forward<FacetResultsT>(value);
90 }
91 template <typename FacetResultsT = Aws::Vector<FacetResult>>
92 QueryResult& WithFacetResults(FacetResultsT&& value) {
93 SetFacetResults(std::forward<FacetResultsT>(value));
94 return *this;
95 }
96 template <typename FacetResultsT = FacetResult>
97 QueryResult& AddFacetResults(FacetResultsT&& value) {
98 m_facetResultsHasBeenSet = true;
99 m_facetResults.emplace_back(std::forward<FacetResultsT>(value));
100 return *this;
101 }
103
105
110 inline int GetTotalNumberOfResults() const { return m_totalNumberOfResults; }
111 inline void SetTotalNumberOfResults(int value) {
112 m_totalNumberOfResultsHasBeenSet = true;
113 m_totalNumberOfResults = value;
114 }
117 return *this;
118 }
120
122
130 inline const Aws::Vector<Warning>& GetWarnings() const { return m_warnings; }
131 template <typename WarningsT = Aws::Vector<Warning>>
132 void SetWarnings(WarningsT&& value) {
133 m_warningsHasBeenSet = true;
134 m_warnings = std::forward<WarningsT>(value);
135 }
136 template <typename WarningsT = Aws::Vector<Warning>>
137 QueryResult& WithWarnings(WarningsT&& value) {
138 SetWarnings(std::forward<WarningsT>(value));
139 return *this;
140 }
141 template <typename WarningsT = Warning>
142 QueryResult& AddWarnings(WarningsT&& value) {
143 m_warningsHasBeenSet = true;
144 m_warnings.emplace_back(std::forward<WarningsT>(value));
145 return *this;
146 }
148
150
153 inline const Aws::Vector<SpellCorrectedQuery>& GetSpellCorrectedQueries() const { return m_spellCorrectedQueries; }
154 template <typename SpellCorrectedQueriesT = Aws::Vector<SpellCorrectedQuery>>
155 void SetSpellCorrectedQueries(SpellCorrectedQueriesT&& value) {
156 m_spellCorrectedQueriesHasBeenSet = true;
157 m_spellCorrectedQueries = std::forward<SpellCorrectedQueriesT>(value);
158 }
159 template <typename SpellCorrectedQueriesT = Aws::Vector<SpellCorrectedQuery>>
160 QueryResult& WithSpellCorrectedQueries(SpellCorrectedQueriesT&& value) {
161 SetSpellCorrectedQueries(std::forward<SpellCorrectedQueriesT>(value));
162 return *this;
163 }
164 template <typename SpellCorrectedQueriesT = SpellCorrectedQuery>
165 QueryResult& AddSpellCorrectedQueries(SpellCorrectedQueriesT&& value) {
166 m_spellCorrectedQueriesHasBeenSet = true;
167 m_spellCorrectedQueries.emplace_back(std::forward<SpellCorrectedQueriesT>(value));
168 return *this;
169 }
171
173
179 inline const Aws::Vector<FeaturedResultsItem>& GetFeaturedResultsItems() const { return m_featuredResultsItems; }
180 template <typename FeaturedResultsItemsT = Aws::Vector<FeaturedResultsItem>>
181 void SetFeaturedResultsItems(FeaturedResultsItemsT&& value) {
182 m_featuredResultsItemsHasBeenSet = true;
183 m_featuredResultsItems = std::forward<FeaturedResultsItemsT>(value);
184 }
185 template <typename FeaturedResultsItemsT = Aws::Vector<FeaturedResultsItem>>
186 QueryResult& WithFeaturedResultsItems(FeaturedResultsItemsT&& value) {
187 SetFeaturedResultsItems(std::forward<FeaturedResultsItemsT>(value));
188 return *this;
189 }
190 template <typename FeaturedResultsItemsT = FeaturedResultsItem>
191 QueryResult& AddFeaturedResultsItems(FeaturedResultsItemsT&& value) {
192 m_featuredResultsItemsHasBeenSet = true;
193 m_featuredResultsItems.emplace_back(std::forward<FeaturedResultsItemsT>(value));
194 return *this;
195 }
197
199
200 inline const Aws::String& GetRequestId() const { return m_requestId; }
201 template <typename RequestIdT = Aws::String>
202 void SetRequestId(RequestIdT&& value) {
203 m_requestIdHasBeenSet = true;
204 m_requestId = std::forward<RequestIdT>(value);
205 }
206 template <typename RequestIdT = Aws::String>
207 QueryResult& WithRequestId(RequestIdT&& value) {
208 SetRequestId(std::forward<RequestIdT>(value));
209 return *this;
210 }
212 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
213
214 private:
215 Aws::String m_queryId;
216
217 Aws::Vector<QueryResultItem> m_resultItems;
218
219 Aws::Vector<FacetResult> m_facetResults;
220
221 int m_totalNumberOfResults{0};
222
223 Aws::Vector<Warning> m_warnings;
224
225 Aws::Vector<SpellCorrectedQuery> m_spellCorrectedQueries;
226
227 Aws::Vector<FeaturedResultsItem> m_featuredResultsItems;
228
229 Aws::String m_requestId;
230 Aws::Http::HttpResponseCode m_HttpResponseCode;
231 bool m_queryIdHasBeenSet = false;
232 bool m_resultItemsHasBeenSet = false;
233 bool m_facetResultsHasBeenSet = false;
234 bool m_totalNumberOfResultsHasBeenSet = false;
235 bool m_warningsHasBeenSet = false;
236 bool m_spellCorrectedQueriesHasBeenSet = false;
237 bool m_featuredResultsItemsHasBeenSet = false;
238 bool m_requestIdHasBeenSet = false;
239};
240
241} // namespace Model
242} // namespace kendra
243} // namespace Aws
void SetWarnings(WarningsT &&value)
void SetQueryId(QueryIdT &&value)
Definition QueryResult.h:45
QueryResult & WithFacetResults(FacetResultsT &&value)
Definition QueryResult.h:92
void SetSpellCorrectedQueries(SpellCorrectedQueriesT &&value)
const Aws::Vector< Warning > & GetWarnings() const
const Aws::Vector< QueryResultItem > & GetResultItems() const
Definition QueryResult.h:60
const Aws::Vector< FeaturedResultsItem > & GetFeaturedResultsItems() const
AWS_KENDRA_API QueryResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
QueryResult & AddFeaturedResultsItems(FeaturedResultsItemsT &&value)
AWS_KENDRA_API QueryResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
const Aws::String & GetQueryId() const
Definition QueryResult.h:43
QueryResult & WithResultItems(ResultItemsT &&value)
Definition QueryResult.h:67
QueryResult & WithTotalNumberOfResults(int value)
void SetTotalNumberOfResults(int value)
void SetFacetResults(FacetResultsT &&value)
Definition QueryResult.h:87
QueryResult & WithFeaturedResultsItems(FeaturedResultsItemsT &&value)
const Aws::String & GetRequestId() const
AWS_KENDRA_API QueryResult()=default
const Aws::Vector< FacetResult > & GetFacetResults() const
Definition QueryResult.h:85
const Aws::Vector< SpellCorrectedQuery > & GetSpellCorrectedQueries() const
void SetRequestId(RequestIdT &&value)
Aws::Http::HttpResponseCode GetHttpResponseCode() const
QueryResult & WithWarnings(WarningsT &&value)
QueryResult & WithRequestId(RequestIdT &&value)
QueryResult & WithSpellCorrectedQueries(SpellCorrectedQueriesT &&value)
QueryResult & AddResultItems(ResultItemsT &&value)
Definition QueryResult.h:72
void SetFeaturedResultsItems(FeaturedResultsItemsT &&value)
void SetResultItems(ResultItemsT &&value)
Definition QueryResult.h:62
QueryResult & WithQueryId(QueryIdT &&value)
Definition QueryResult.h:50
QueryResult & AddFacetResults(FacetResultsT &&value)
Definition QueryResult.h:97
QueryResult & AddSpellCorrectedQueries(SpellCorrectedQueriesT &&value)
QueryResult & AddWarnings(WarningsT &&value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue