AWS SDK for C++

AWS SDK for C++ Version 1.11.747

Loading...
Searching...
No Matches
QueryResult.h
1
6#pragma once
7#include <aws/core/utils/memory/stl/AWSString.h>
8#include <aws/core/utils/memory/stl/AWSVector.h>
9#include <aws/kendra/Kendra_EXPORTS.h>
10#include <aws/kendra/model/FacetResult.h>
11#include <aws/kendra/model/FeaturedResultsItem.h>
12#include <aws/kendra/model/QueryResultItem.h>
13#include <aws/kendra/model/SpellCorrectedQuery.h>
14#include <aws/kendra/model/Warning.h>
15
16#include <utility>
17
18namespace Aws {
19template <typename RESULT_TYPE>
20class AmazonWebServiceResult;
21
22namespace Utils {
23namespace Json {
24class JsonValue;
25} // namespace Json
26} // namespace Utils
27namespace kendra {
28namespace Model {
30 public:
31 AWS_KENDRA_API QueryResult() = default;
34
36
42 inline const Aws::String& GetQueryId() const { return m_queryId; }
43 template <typename QueryIdT = Aws::String>
44 void SetQueryId(QueryIdT&& value) {
45 m_queryIdHasBeenSet = true;
46 m_queryId = std::forward<QueryIdT>(value);
47 }
48 template <typename QueryIdT = Aws::String>
49 QueryResult& WithQueryId(QueryIdT&& value) {
50 SetQueryId(std::forward<QueryIdT>(value));
51 return *this;
52 }
54
56
59 inline const Aws::Vector<QueryResultItem>& GetResultItems() const { return m_resultItems; }
60 template <typename ResultItemsT = Aws::Vector<QueryResultItem>>
61 void SetResultItems(ResultItemsT&& value) {
62 m_resultItemsHasBeenSet = true;
63 m_resultItems = std::forward<ResultItemsT>(value);
64 }
65 template <typename ResultItemsT = Aws::Vector<QueryResultItem>>
66 QueryResult& WithResultItems(ResultItemsT&& value) {
67 SetResultItems(std::forward<ResultItemsT>(value));
68 return *this;
69 }
70 template <typename ResultItemsT = QueryResultItem>
71 QueryResult& AddResultItems(ResultItemsT&& value) {
72 m_resultItemsHasBeenSet = true;
73 m_resultItems.emplace_back(std::forward<ResultItemsT>(value));
74 return *this;
75 }
77
79
84 inline const Aws::Vector<FacetResult>& GetFacetResults() const { return m_facetResults; }
85 template <typename FacetResultsT = Aws::Vector<FacetResult>>
86 void SetFacetResults(FacetResultsT&& value) {
87 m_facetResultsHasBeenSet = true;
88 m_facetResults = std::forward<FacetResultsT>(value);
89 }
90 template <typename FacetResultsT = Aws::Vector<FacetResult>>
91 QueryResult& WithFacetResults(FacetResultsT&& value) {
92 SetFacetResults(std::forward<FacetResultsT>(value));
93 return *this;
94 }
95 template <typename FacetResultsT = FacetResult>
96 QueryResult& AddFacetResults(FacetResultsT&& value) {
97 m_facetResultsHasBeenSet = true;
98 m_facetResults.emplace_back(std::forward<FacetResultsT>(value));
99 return *this;
100 }
102
104
109 inline int GetTotalNumberOfResults() const { return m_totalNumberOfResults; }
110 inline void SetTotalNumberOfResults(int value) {
111 m_totalNumberOfResultsHasBeenSet = true;
112 m_totalNumberOfResults = value;
113 }
116 return *this;
117 }
119
121
129 inline const Aws::Vector<Warning>& GetWarnings() const { return m_warnings; }
130 template <typename WarningsT = Aws::Vector<Warning>>
131 void SetWarnings(WarningsT&& value) {
132 m_warningsHasBeenSet = true;
133 m_warnings = std::forward<WarningsT>(value);
134 }
135 template <typename WarningsT = Aws::Vector<Warning>>
136 QueryResult& WithWarnings(WarningsT&& value) {
137 SetWarnings(std::forward<WarningsT>(value));
138 return *this;
139 }
140 template <typename WarningsT = Warning>
141 QueryResult& AddWarnings(WarningsT&& value) {
142 m_warningsHasBeenSet = true;
143 m_warnings.emplace_back(std::forward<WarningsT>(value));
144 return *this;
145 }
147
149
152 inline const Aws::Vector<SpellCorrectedQuery>& GetSpellCorrectedQueries() const { return m_spellCorrectedQueries; }
153 template <typename SpellCorrectedQueriesT = Aws::Vector<SpellCorrectedQuery>>
154 void SetSpellCorrectedQueries(SpellCorrectedQueriesT&& value) {
155 m_spellCorrectedQueriesHasBeenSet = true;
156 m_spellCorrectedQueries = std::forward<SpellCorrectedQueriesT>(value);
157 }
158 template <typename SpellCorrectedQueriesT = Aws::Vector<SpellCorrectedQuery>>
159 QueryResult& WithSpellCorrectedQueries(SpellCorrectedQueriesT&& value) {
160 SetSpellCorrectedQueries(std::forward<SpellCorrectedQueriesT>(value));
161 return *this;
162 }
163 template <typename SpellCorrectedQueriesT = SpellCorrectedQuery>
164 QueryResult& AddSpellCorrectedQueries(SpellCorrectedQueriesT&& value) {
165 m_spellCorrectedQueriesHasBeenSet = true;
166 m_spellCorrectedQueries.emplace_back(std::forward<SpellCorrectedQueriesT>(value));
167 return *this;
168 }
170
172
178 inline const Aws::Vector<FeaturedResultsItem>& GetFeaturedResultsItems() const { return m_featuredResultsItems; }
179 template <typename FeaturedResultsItemsT = Aws::Vector<FeaturedResultsItem>>
180 void SetFeaturedResultsItems(FeaturedResultsItemsT&& value) {
181 m_featuredResultsItemsHasBeenSet = true;
182 m_featuredResultsItems = std::forward<FeaturedResultsItemsT>(value);
183 }
184 template <typename FeaturedResultsItemsT = Aws::Vector<FeaturedResultsItem>>
185 QueryResult& WithFeaturedResultsItems(FeaturedResultsItemsT&& value) {
186 SetFeaturedResultsItems(std::forward<FeaturedResultsItemsT>(value));
187 return *this;
188 }
189 template <typename FeaturedResultsItemsT = FeaturedResultsItem>
190 QueryResult& AddFeaturedResultsItems(FeaturedResultsItemsT&& value) {
191 m_featuredResultsItemsHasBeenSet = true;
192 m_featuredResultsItems.emplace_back(std::forward<FeaturedResultsItemsT>(value));
193 return *this;
194 }
196
198
199 inline const Aws::String& GetRequestId() const { return m_requestId; }
200 template <typename RequestIdT = Aws::String>
201 void SetRequestId(RequestIdT&& value) {
202 m_requestIdHasBeenSet = true;
203 m_requestId = std::forward<RequestIdT>(value);
204 }
205 template <typename RequestIdT = Aws::String>
206 QueryResult& WithRequestId(RequestIdT&& value) {
207 SetRequestId(std::forward<RequestIdT>(value));
208 return *this;
209 }
211 private:
212 Aws::String m_queryId;
213
214 Aws::Vector<QueryResultItem> m_resultItems;
215
216 Aws::Vector<FacetResult> m_facetResults;
217
218 int m_totalNumberOfResults{0};
219
220 Aws::Vector<Warning> m_warnings;
221
222 Aws::Vector<SpellCorrectedQuery> m_spellCorrectedQueries;
223
224 Aws::Vector<FeaturedResultsItem> m_featuredResultsItems;
225
226 Aws::String m_requestId;
227 bool m_queryIdHasBeenSet = false;
228 bool m_resultItemsHasBeenSet = false;
229 bool m_facetResultsHasBeenSet = false;
230 bool m_totalNumberOfResultsHasBeenSet = false;
231 bool m_warningsHasBeenSet = false;
232 bool m_spellCorrectedQueriesHasBeenSet = false;
233 bool m_featuredResultsItemsHasBeenSet = false;
234 bool m_requestIdHasBeenSet = false;
235};
236
237} // namespace Model
238} // namespace kendra
239} // namespace Aws
void SetWarnings(WarningsT &&value)
void SetQueryId(QueryIdT &&value)
Definition QueryResult.h:44
QueryResult & WithFacetResults(FacetResultsT &&value)
Definition QueryResult.h:91
void SetSpellCorrectedQueries(SpellCorrectedQueriesT &&value)
const Aws::Vector< Warning > & GetWarnings() const
const Aws::Vector< QueryResultItem > & GetResultItems() const
Definition QueryResult.h:59
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:42
QueryResult & WithResultItems(ResultItemsT &&value)
Definition QueryResult.h:66
QueryResult & WithTotalNumberOfResults(int value)
void SetTotalNumberOfResults(int value)
void SetFacetResults(FacetResultsT &&value)
Definition QueryResult.h:86
QueryResult & WithFeaturedResultsItems(FeaturedResultsItemsT &&value)
const Aws::String & GetRequestId() const
AWS_KENDRA_API QueryResult()=default
const Aws::Vector< FacetResult > & GetFacetResults() const
Definition QueryResult.h:84
const Aws::Vector< SpellCorrectedQuery > & GetSpellCorrectedQueries() const
void SetRequestId(RequestIdT &&value)
QueryResult & WithWarnings(WarningsT &&value)
QueryResult & WithRequestId(RequestIdT &&value)
QueryResult & WithSpellCorrectedQueries(SpellCorrectedQueriesT &&value)
QueryResult & AddResultItems(ResultItemsT &&value)
Definition QueryResult.h:71
void SetFeaturedResultsItems(FeaturedResultsItemsT &&value)
void SetResultItems(ResultItemsT &&value)
Definition QueryResult.h:61
QueryResult & WithQueryId(QueryIdT &&value)
Definition QueryResult.h:49
QueryResult & AddFacetResults(FacetResultsT &&value)
Definition QueryResult.h:96
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