AWS SDK for C++

AWS SDK for C++ Version 1.11.683

Loading...
Searching...
No Matches
FeaturedResultsItem.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/AdditionalResultAttribute.h>
11#include <aws/kendra/model/DocumentAttribute.h>
12#include <aws/kendra/model/QueryResultType.h>
13#include <aws/kendra/model/TextWithHighlights.h>
14
15#include <utility>
16
17namespace Aws {
18namespace Utils {
19namespace Json {
20class JsonValue;
21class JsonView;
22} // namespace Json
23} // namespace Utils
24namespace kendra {
25namespace Model {
26
36 public:
37 AWS_KENDRA_API FeaturedResultsItem() = default;
40 AWS_KENDRA_API Aws::Utils::Json::JsonValue Jsonize() const;
41
43
46 inline const Aws::String& GetId() const { return m_id; }
47 inline bool IdHasBeenSet() const { return m_idHasBeenSet; }
48 template <typename IdT = Aws::String>
49 void SetId(IdT&& value) {
50 m_idHasBeenSet = true;
51 m_id = std::forward<IdT>(value);
52 }
53 template <typename IdT = Aws::String>
55 SetId(std::forward<IdT>(value));
56 return *this;
57 }
59
61
65 inline QueryResultType GetType() const { return m_type; }
66 inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; }
67 inline void SetType(QueryResultType value) {
68 m_typeHasBeenSet = true;
69 m_type = value;
70 }
72 SetType(value);
73 return *this;
74 }
76
78
81 inline const Aws::Vector<AdditionalResultAttribute>& GetAdditionalAttributes() const { return m_additionalAttributes; }
82 inline bool AdditionalAttributesHasBeenSet() const { return m_additionalAttributesHasBeenSet; }
83 template <typename AdditionalAttributesT = Aws::Vector<AdditionalResultAttribute>>
84 void SetAdditionalAttributes(AdditionalAttributesT&& value) {
85 m_additionalAttributesHasBeenSet = true;
86 m_additionalAttributes = std::forward<AdditionalAttributesT>(value);
87 }
88 template <typename AdditionalAttributesT = Aws::Vector<AdditionalResultAttribute>>
89 FeaturedResultsItem& WithAdditionalAttributes(AdditionalAttributesT&& value) {
90 SetAdditionalAttributes(std::forward<AdditionalAttributesT>(value));
91 return *this;
92 }
93 template <typename AdditionalAttributesT = AdditionalResultAttribute>
94 FeaturedResultsItem& AddAdditionalAttributes(AdditionalAttributesT&& value) {
95 m_additionalAttributesHasBeenSet = true;
96 m_additionalAttributes.emplace_back(std::forward<AdditionalAttributesT>(value));
97 return *this;
98 }
100
102
105 inline const Aws::String& GetDocumentId() const { return m_documentId; }
106 inline bool DocumentIdHasBeenSet() const { return m_documentIdHasBeenSet; }
107 template <typename DocumentIdT = Aws::String>
108 void SetDocumentId(DocumentIdT&& value) {
109 m_documentIdHasBeenSet = true;
110 m_documentId = std::forward<DocumentIdT>(value);
111 }
112 template <typename DocumentIdT = Aws::String>
113 FeaturedResultsItem& WithDocumentId(DocumentIdT&& value) {
114 SetDocumentId(std::forward<DocumentIdT>(value));
115 return *this;
116 }
118
120
121 inline const TextWithHighlights& GetDocumentTitle() const { return m_documentTitle; }
122 inline bool DocumentTitleHasBeenSet() const { return m_documentTitleHasBeenSet; }
123 template <typename DocumentTitleT = TextWithHighlights>
124 void SetDocumentTitle(DocumentTitleT&& value) {
125 m_documentTitleHasBeenSet = true;
126 m_documentTitle = std::forward<DocumentTitleT>(value);
127 }
128 template <typename DocumentTitleT = TextWithHighlights>
129 FeaturedResultsItem& WithDocumentTitle(DocumentTitleT&& value) {
130 SetDocumentTitle(std::forward<DocumentTitleT>(value));
131 return *this;
132 }
134
136
137 inline const TextWithHighlights& GetDocumentExcerpt() const { return m_documentExcerpt; }
138 inline bool DocumentExcerptHasBeenSet() const { return m_documentExcerptHasBeenSet; }
139 template <typename DocumentExcerptT = TextWithHighlights>
140 void SetDocumentExcerpt(DocumentExcerptT&& value) {
141 m_documentExcerptHasBeenSet = true;
142 m_documentExcerpt = std::forward<DocumentExcerptT>(value);
143 }
144 template <typename DocumentExcerptT = TextWithHighlights>
145 FeaturedResultsItem& WithDocumentExcerpt(DocumentExcerptT&& value) {
146 SetDocumentExcerpt(std::forward<DocumentExcerptT>(value));
147 return *this;
148 }
150
152
155 inline const Aws::String& GetDocumentURI() const { return m_documentURI; }
156 inline bool DocumentURIHasBeenSet() const { return m_documentURIHasBeenSet; }
157 template <typename DocumentURIT = Aws::String>
158 void SetDocumentURI(DocumentURIT&& value) {
159 m_documentURIHasBeenSet = true;
160 m_documentURI = std::forward<DocumentURIT>(value);
161 }
162 template <typename DocumentURIT = Aws::String>
163 FeaturedResultsItem& WithDocumentURI(DocumentURIT&& value) {
164 SetDocumentURI(std::forward<DocumentURIT>(value));
165 return *this;
166 }
168
170
175 inline const Aws::Vector<DocumentAttribute>& GetDocumentAttributes() const { return m_documentAttributes; }
176 inline bool DocumentAttributesHasBeenSet() const { return m_documentAttributesHasBeenSet; }
177 template <typename DocumentAttributesT = Aws::Vector<DocumentAttribute>>
178 void SetDocumentAttributes(DocumentAttributesT&& value) {
179 m_documentAttributesHasBeenSet = true;
180 m_documentAttributes = std::forward<DocumentAttributesT>(value);
181 }
182 template <typename DocumentAttributesT = Aws::Vector<DocumentAttribute>>
183 FeaturedResultsItem& WithDocumentAttributes(DocumentAttributesT&& value) {
184 SetDocumentAttributes(std::forward<DocumentAttributesT>(value));
185 return *this;
186 }
187 template <typename DocumentAttributesT = DocumentAttribute>
188 FeaturedResultsItem& AddDocumentAttributes(DocumentAttributesT&& value) {
189 m_documentAttributesHasBeenSet = true;
190 m_documentAttributes.emplace_back(std::forward<DocumentAttributesT>(value));
191 return *this;
192 }
194
196
203 inline const Aws::String& GetFeedbackToken() const { return m_feedbackToken; }
204 inline bool FeedbackTokenHasBeenSet() const { return m_feedbackTokenHasBeenSet; }
205 template <typename FeedbackTokenT = Aws::String>
206 void SetFeedbackToken(FeedbackTokenT&& value) {
207 m_feedbackTokenHasBeenSet = true;
208 m_feedbackToken = std::forward<FeedbackTokenT>(value);
209 }
210 template <typename FeedbackTokenT = Aws::String>
211 FeaturedResultsItem& WithFeedbackToken(FeedbackTokenT&& value) {
212 SetFeedbackToken(std::forward<FeedbackTokenT>(value));
213 return *this;
214 }
216 private:
217 Aws::String m_id;
218 bool m_idHasBeenSet = false;
219
221 bool m_typeHasBeenSet = false;
222
223 Aws::Vector<AdditionalResultAttribute> m_additionalAttributes;
224 bool m_additionalAttributesHasBeenSet = false;
225
226 Aws::String m_documentId;
227 bool m_documentIdHasBeenSet = false;
228
229 TextWithHighlights m_documentTitle;
230 bool m_documentTitleHasBeenSet = false;
231
232 TextWithHighlights m_documentExcerpt;
233 bool m_documentExcerptHasBeenSet = false;
234
235 Aws::String m_documentURI;
236 bool m_documentURIHasBeenSet = false;
237
238 Aws::Vector<DocumentAttribute> m_documentAttributes;
239 bool m_documentAttributesHasBeenSet = false;
240
241 Aws::String m_feedbackToken;
242 bool m_feedbackTokenHasBeenSet = false;
243};
244
245} // namespace Model
246} // namespace kendra
247} // namespace Aws
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue