AWS SDK for C++

AWS SDK for C++ Version 1.11.608

Loading...
Searching...
No Matches
FeaturedResultsItem.h
1
6#pragma once
7#include <aws/kendra/Kendra_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/kendra/model/QueryResultType.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/kendra/model/TextWithHighlights.h>
12#include <aws/kendra/model/AdditionalResultAttribute.h>
13#include <aws/kendra/model/DocumentAttribute.h>
14#include <utility>
15
16namespace Aws
17{
18namespace Utils
19{
20namespace Json
21{
22 class JsonValue;
23 class JsonView;
24} // namespace Json
25} // namespace Utils
26namespace kendra
27{
28namespace Model
29{
30
40 {
41 public:
42 AWS_KENDRA_API FeaturedResultsItem() = default;
45 AWS_KENDRA_API Aws::Utils::Json::JsonValue Jsonize() const;
46
47
49
52 inline const Aws::String& GetId() const { return m_id; }
53 inline bool IdHasBeenSet() const { return m_idHasBeenSet; }
54 template<typename IdT = Aws::String>
55 void SetId(IdT&& value) { m_idHasBeenSet = true; m_id = std::forward<IdT>(value); }
56 template<typename IdT = Aws::String>
57 FeaturedResultsItem& WithId(IdT&& value) { SetId(std::forward<IdT>(value)); return *this;}
59
61
65 inline QueryResultType GetType() const { return m_type; }
66 inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; }
67 inline void SetType(QueryResultType value) { m_typeHasBeenSet = true; m_type = value; }
68 inline FeaturedResultsItem& WithType(QueryResultType value) { SetType(value); return *this;}
70
72
75 inline const Aws::Vector<AdditionalResultAttribute>& GetAdditionalAttributes() const { return m_additionalAttributes; }
76 inline bool AdditionalAttributesHasBeenSet() const { return m_additionalAttributesHasBeenSet; }
77 template<typename AdditionalAttributesT = Aws::Vector<AdditionalResultAttribute>>
78 void SetAdditionalAttributes(AdditionalAttributesT&& value) { m_additionalAttributesHasBeenSet = true; m_additionalAttributes = std::forward<AdditionalAttributesT>(value); }
79 template<typename AdditionalAttributesT = Aws::Vector<AdditionalResultAttribute>>
80 FeaturedResultsItem& WithAdditionalAttributes(AdditionalAttributesT&& value) { SetAdditionalAttributes(std::forward<AdditionalAttributesT>(value)); return *this;}
81 template<typename AdditionalAttributesT = AdditionalResultAttribute>
82 FeaturedResultsItem& AddAdditionalAttributes(AdditionalAttributesT&& value) { m_additionalAttributesHasBeenSet = true; m_additionalAttributes.emplace_back(std::forward<AdditionalAttributesT>(value)); return *this; }
84
86
89 inline const Aws::String& GetDocumentId() const { return m_documentId; }
90 inline bool DocumentIdHasBeenSet() const { return m_documentIdHasBeenSet; }
91 template<typename DocumentIdT = Aws::String>
92 void SetDocumentId(DocumentIdT&& value) { m_documentIdHasBeenSet = true; m_documentId = std::forward<DocumentIdT>(value); }
93 template<typename DocumentIdT = Aws::String>
94 FeaturedResultsItem& WithDocumentId(DocumentIdT&& value) { SetDocumentId(std::forward<DocumentIdT>(value)); return *this;}
96
98
99 inline const TextWithHighlights& GetDocumentTitle() const { return m_documentTitle; }
100 inline bool DocumentTitleHasBeenSet() const { return m_documentTitleHasBeenSet; }
101 template<typename DocumentTitleT = TextWithHighlights>
102 void SetDocumentTitle(DocumentTitleT&& value) { m_documentTitleHasBeenSet = true; m_documentTitle = std::forward<DocumentTitleT>(value); }
103 template<typename DocumentTitleT = TextWithHighlights>
104 FeaturedResultsItem& WithDocumentTitle(DocumentTitleT&& value) { SetDocumentTitle(std::forward<DocumentTitleT>(value)); return *this;}
106
108
109 inline const TextWithHighlights& GetDocumentExcerpt() const { return m_documentExcerpt; }
110 inline bool DocumentExcerptHasBeenSet() const { return m_documentExcerptHasBeenSet; }
111 template<typename DocumentExcerptT = TextWithHighlights>
112 void SetDocumentExcerpt(DocumentExcerptT&& value) { m_documentExcerptHasBeenSet = true; m_documentExcerpt = std::forward<DocumentExcerptT>(value); }
113 template<typename DocumentExcerptT = TextWithHighlights>
114 FeaturedResultsItem& WithDocumentExcerpt(DocumentExcerptT&& value) { SetDocumentExcerpt(std::forward<DocumentExcerptT>(value)); return *this;}
116
118
121 inline const Aws::String& GetDocumentURI() const { return m_documentURI; }
122 inline bool DocumentURIHasBeenSet() const { return m_documentURIHasBeenSet; }
123 template<typename DocumentURIT = Aws::String>
124 void SetDocumentURI(DocumentURIT&& value) { m_documentURIHasBeenSet = true; m_documentURI = std::forward<DocumentURIT>(value); }
125 template<typename DocumentURIT = Aws::String>
126 FeaturedResultsItem& WithDocumentURI(DocumentURIT&& value) { SetDocumentURI(std::forward<DocumentURIT>(value)); return *this;}
128
130
135 inline const Aws::Vector<DocumentAttribute>& GetDocumentAttributes() const { return m_documentAttributes; }
136 inline bool DocumentAttributesHasBeenSet() const { return m_documentAttributesHasBeenSet; }
137 template<typename DocumentAttributesT = Aws::Vector<DocumentAttribute>>
138 void SetDocumentAttributes(DocumentAttributesT&& value) { m_documentAttributesHasBeenSet = true; m_documentAttributes = std::forward<DocumentAttributesT>(value); }
139 template<typename DocumentAttributesT = Aws::Vector<DocumentAttribute>>
140 FeaturedResultsItem& WithDocumentAttributes(DocumentAttributesT&& value) { SetDocumentAttributes(std::forward<DocumentAttributesT>(value)); return *this;}
141 template<typename DocumentAttributesT = DocumentAttribute>
142 FeaturedResultsItem& AddDocumentAttributes(DocumentAttributesT&& value) { m_documentAttributesHasBeenSet = true; m_documentAttributes.emplace_back(std::forward<DocumentAttributesT>(value)); return *this; }
144
146
153 inline const Aws::String& GetFeedbackToken() const { return m_feedbackToken; }
154 inline bool FeedbackTokenHasBeenSet() const { return m_feedbackTokenHasBeenSet; }
155 template<typename FeedbackTokenT = Aws::String>
156 void SetFeedbackToken(FeedbackTokenT&& value) { m_feedbackTokenHasBeenSet = true; m_feedbackToken = std::forward<FeedbackTokenT>(value); }
157 template<typename FeedbackTokenT = Aws::String>
158 FeaturedResultsItem& WithFeedbackToken(FeedbackTokenT&& value) { SetFeedbackToken(std::forward<FeedbackTokenT>(value)); return *this;}
160 private:
161
162 Aws::String m_id;
163 bool m_idHasBeenSet = false;
164
166 bool m_typeHasBeenSet = false;
167
168 Aws::Vector<AdditionalResultAttribute> m_additionalAttributes;
169 bool m_additionalAttributesHasBeenSet = false;
170
171 Aws::String m_documentId;
172 bool m_documentIdHasBeenSet = false;
173
174 TextWithHighlights m_documentTitle;
175 bool m_documentTitleHasBeenSet = false;
176
177 TextWithHighlights m_documentExcerpt;
178 bool m_documentExcerptHasBeenSet = false;
179
180 Aws::String m_documentURI;
181 bool m_documentURIHasBeenSet = false;
182
183 Aws::Vector<DocumentAttribute> m_documentAttributes;
184 bool m_documentAttributesHasBeenSet = false;
185
186 Aws::String m_feedbackToken;
187 bool m_feedbackTokenHasBeenSet = false;
188 };
189
190} // namespace Model
191} // namespace kendra
192} // 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