AWS SDK for C++

AWS SDK for C++ Version 1.11.759

Loading...
Searching...
No Matches
DescribeIndexResult.h
1
6#pragma once
7#include <aws/core/http/HttpResponse.h>
8#include <aws/core/utils/DateTime.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/kendra/Kendra_EXPORTS.h>
12#include <aws/kendra/model/CapacityUnitsConfiguration.h>
13#include <aws/kendra/model/DocumentMetadataConfiguration.h>
14#include <aws/kendra/model/IndexEdition.h>
15#include <aws/kendra/model/IndexStatistics.h>
16#include <aws/kendra/model/IndexStatus.h>
17#include <aws/kendra/model/ServerSideEncryptionConfiguration.h>
18#include <aws/kendra/model/UserContextPolicy.h>
19#include <aws/kendra/model/UserGroupResolutionConfiguration.h>
20#include <aws/kendra/model/UserTokenConfiguration.h>
21
22#include <utility>
23
24namespace Aws {
25template <typename RESULT_TYPE>
26class AmazonWebServiceResult;
27
28namespace Utils {
29namespace Json {
30class JsonValue;
31} // namespace Json
32} // namespace Utils
33namespace kendra {
34namespace Model {
36 public:
37 AWS_KENDRA_API DescribeIndexResult() = default;
40
42
45 inline const Aws::String& GetName() const { return m_name; }
46 template <typename NameT = Aws::String>
47 void SetName(NameT&& value) {
48 m_nameHasBeenSet = true;
49 m_name = std::forward<NameT>(value);
50 }
51 template <typename NameT = Aws::String>
52 DescribeIndexResult& WithName(NameT&& value) {
53 SetName(std::forward<NameT>(value));
54 return *this;
55 }
57
59
62 inline const Aws::String& GetId() const { return m_id; }
63 template <typename IdT = Aws::String>
64 void SetId(IdT&& value) {
65 m_idHasBeenSet = true;
66 m_id = std::forward<IdT>(value);
67 }
68 template <typename IdT = Aws::String>
70 SetId(std::forward<IdT>(value));
71 return *this;
72 }
74
76
80 inline IndexEdition GetEdition() const { return m_edition; }
81 inline void SetEdition(IndexEdition value) {
82 m_editionHasBeenSet = true;
83 m_edition = value;
84 }
86 SetEdition(value);
87 return *this;
88 }
90
92
96 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
97 template <typename RoleArnT = Aws::String>
98 void SetRoleArn(RoleArnT&& value) {
99 m_roleArnHasBeenSet = true;
100 m_roleArn = std::forward<RoleArnT>(value);
101 }
102 template <typename RoleArnT = Aws::String>
103 DescribeIndexResult& WithRoleArn(RoleArnT&& value) {
104 SetRoleArn(std::forward<RoleArnT>(value));
105 return *this;
106 }
108
110
115 return m_serverSideEncryptionConfiguration;
116 }
117 template <typename ServerSideEncryptionConfigurationT = ServerSideEncryptionConfiguration>
118 void SetServerSideEncryptionConfiguration(ServerSideEncryptionConfigurationT&& value) {
119 m_serverSideEncryptionConfigurationHasBeenSet = true;
120 m_serverSideEncryptionConfiguration = std::forward<ServerSideEncryptionConfigurationT>(value);
121 }
122 template <typename ServerSideEncryptionConfigurationT = ServerSideEncryptionConfiguration>
123 DescribeIndexResult& WithServerSideEncryptionConfiguration(ServerSideEncryptionConfigurationT&& value) {
124 SetServerSideEncryptionConfiguration(std::forward<ServerSideEncryptionConfigurationT>(value));
125 return *this;
126 }
128
130
136 inline IndexStatus GetStatus() const { return m_status; }
137 inline void SetStatus(IndexStatus value) {
138 m_statusHasBeenSet = true;
139 m_status = value;
140 }
142 SetStatus(value);
143 return *this;
144 }
146
148
151 inline const Aws::String& GetDescription() const { return m_description; }
152 template <typename DescriptionT = Aws::String>
153 void SetDescription(DescriptionT&& value) {
154 m_descriptionHasBeenSet = true;
155 m_description = std::forward<DescriptionT>(value);
156 }
157 template <typename DescriptionT = Aws::String>
158 DescribeIndexResult& WithDescription(DescriptionT&& value) {
159 SetDescription(std::forward<DescriptionT>(value));
160 return *this;
161 }
163
165
168 inline const Aws::Utils::DateTime& GetCreatedAt() const { return m_createdAt; }
169 template <typename CreatedAtT = Aws::Utils::DateTime>
170 void SetCreatedAt(CreatedAtT&& value) {
171 m_createdAtHasBeenSet = true;
172 m_createdAt = std::forward<CreatedAtT>(value);
173 }
174 template <typename CreatedAtT = Aws::Utils::DateTime>
175 DescribeIndexResult& WithCreatedAt(CreatedAtT&& value) {
176 SetCreatedAt(std::forward<CreatedAtT>(value));
177 return *this;
178 }
180
182
185 inline const Aws::Utils::DateTime& GetUpdatedAt() const { return m_updatedAt; }
186 template <typename UpdatedAtT = Aws::Utils::DateTime>
187 void SetUpdatedAt(UpdatedAtT&& value) {
188 m_updatedAtHasBeenSet = true;
189 m_updatedAt = std::forward<UpdatedAtT>(value);
190 }
191 template <typename UpdatedAtT = Aws::Utils::DateTime>
192 DescribeIndexResult& WithUpdatedAt(UpdatedAtT&& value) {
193 SetUpdatedAt(std::forward<UpdatedAtT>(value));
194 return *this;
195 }
197
199
205 return m_documentMetadataConfigurations;
206 }
207 template <typename DocumentMetadataConfigurationsT = Aws::Vector<DocumentMetadataConfiguration>>
208 void SetDocumentMetadataConfigurations(DocumentMetadataConfigurationsT&& value) {
209 m_documentMetadataConfigurationsHasBeenSet = true;
210 m_documentMetadataConfigurations = std::forward<DocumentMetadataConfigurationsT>(value);
211 }
212 template <typename DocumentMetadataConfigurationsT = Aws::Vector<DocumentMetadataConfiguration>>
213 DescribeIndexResult& WithDocumentMetadataConfigurations(DocumentMetadataConfigurationsT&& value) {
214 SetDocumentMetadataConfigurations(std::forward<DocumentMetadataConfigurationsT>(value));
215 return *this;
216 }
217 template <typename DocumentMetadataConfigurationsT = DocumentMetadataConfiguration>
218 DescribeIndexResult& AddDocumentMetadataConfigurations(DocumentMetadataConfigurationsT&& value) {
219 m_documentMetadataConfigurationsHasBeenSet = true;
220 m_documentMetadataConfigurations.emplace_back(std::forward<DocumentMetadataConfigurationsT>(value));
221 return *this;
222 }
224
226
230 inline const IndexStatistics& GetIndexStatistics() const { return m_indexStatistics; }
231 template <typename IndexStatisticsT = IndexStatistics>
232 void SetIndexStatistics(IndexStatisticsT&& value) {
233 m_indexStatisticsHasBeenSet = true;
234 m_indexStatistics = std::forward<IndexStatisticsT>(value);
235 }
236 template <typename IndexStatisticsT = IndexStatistics>
237 DescribeIndexResult& WithIndexStatistics(IndexStatisticsT&& value) {
238 SetIndexStatistics(std::forward<IndexStatisticsT>(value));
239 return *this;
240 }
242
244
248 inline const Aws::String& GetErrorMessage() const { return m_errorMessage; }
249 template <typename ErrorMessageT = Aws::String>
250 void SetErrorMessage(ErrorMessageT&& value) {
251 m_errorMessageHasBeenSet = true;
252 m_errorMessage = std::forward<ErrorMessageT>(value);
253 }
254 template <typename ErrorMessageT = Aws::String>
255 DescribeIndexResult& WithErrorMessage(ErrorMessageT&& value) {
256 SetErrorMessage(std::forward<ErrorMessageT>(value));
257 return *this;
258 }
260
262
271 inline const CapacityUnitsConfiguration& GetCapacityUnits() const { return m_capacityUnits; }
272 template <typename CapacityUnitsT = CapacityUnitsConfiguration>
273 void SetCapacityUnits(CapacityUnitsT&& value) {
274 m_capacityUnitsHasBeenSet = true;
275 m_capacityUnits = std::forward<CapacityUnitsT>(value);
276 }
277 template <typename CapacityUnitsT = CapacityUnitsConfiguration>
278 DescribeIndexResult& WithCapacityUnits(CapacityUnitsT&& value) {
279 SetCapacityUnits(std::forward<CapacityUnitsT>(value));
280 return *this;
281 }
283
285
288 inline const Aws::Vector<UserTokenConfiguration>& GetUserTokenConfigurations() const { return m_userTokenConfigurations; }
289 template <typename UserTokenConfigurationsT = Aws::Vector<UserTokenConfiguration>>
290 void SetUserTokenConfigurations(UserTokenConfigurationsT&& value) {
291 m_userTokenConfigurationsHasBeenSet = true;
292 m_userTokenConfigurations = std::forward<UserTokenConfigurationsT>(value);
293 }
294 template <typename UserTokenConfigurationsT = Aws::Vector<UserTokenConfiguration>>
295 DescribeIndexResult& WithUserTokenConfigurations(UserTokenConfigurationsT&& value) {
296 SetUserTokenConfigurations(std::forward<UserTokenConfigurationsT>(value));
297 return *this;
298 }
299 template <typename UserTokenConfigurationsT = UserTokenConfiguration>
300 DescribeIndexResult& AddUserTokenConfigurations(UserTokenConfigurationsT&& value) {
301 m_userTokenConfigurationsHasBeenSet = true;
302 m_userTokenConfigurations.emplace_back(std::forward<UserTokenConfigurationsT>(value));
303 return *this;
304 }
306
308
311 inline UserContextPolicy GetUserContextPolicy() const { return m_userContextPolicy; }
313 m_userContextPolicyHasBeenSet = true;
314 m_userContextPolicy = value;
315 }
318 return *this;
319 }
321
323
328 inline const UserGroupResolutionConfiguration& GetUserGroupResolutionConfiguration() const { return m_userGroupResolutionConfiguration; }
329 template <typename UserGroupResolutionConfigurationT = UserGroupResolutionConfiguration>
330 void SetUserGroupResolutionConfiguration(UserGroupResolutionConfigurationT&& value) {
331 m_userGroupResolutionConfigurationHasBeenSet = true;
332 m_userGroupResolutionConfiguration = std::forward<UserGroupResolutionConfigurationT>(value);
333 }
334 template <typename UserGroupResolutionConfigurationT = UserGroupResolutionConfiguration>
335 DescribeIndexResult& WithUserGroupResolutionConfiguration(UserGroupResolutionConfigurationT&& value) {
336 SetUserGroupResolutionConfiguration(std::forward<UserGroupResolutionConfigurationT>(value));
337 return *this;
338 }
340
342
343 inline const Aws::String& GetRequestId() const { return m_requestId; }
344 template <typename RequestIdT = Aws::String>
345 void SetRequestId(RequestIdT&& value) {
346 m_requestIdHasBeenSet = true;
347 m_requestId = std::forward<RequestIdT>(value);
348 }
349 template <typename RequestIdT = Aws::String>
350 DescribeIndexResult& WithRequestId(RequestIdT&& value) {
351 SetRequestId(std::forward<RequestIdT>(value));
352 return *this;
353 }
355 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
356
357 private:
358 Aws::String m_name;
359
360 Aws::String m_id;
361
363
364 Aws::String m_roleArn;
365
366 ServerSideEncryptionConfiguration m_serverSideEncryptionConfiguration;
367
369
370 Aws::String m_description;
371
372 Aws::Utils::DateTime m_createdAt{};
373
374 Aws::Utils::DateTime m_updatedAt{};
375
376 Aws::Vector<DocumentMetadataConfiguration> m_documentMetadataConfigurations;
377
378 IndexStatistics m_indexStatistics;
379
380 Aws::String m_errorMessage;
381
382 CapacityUnitsConfiguration m_capacityUnits;
383
384 Aws::Vector<UserTokenConfiguration> m_userTokenConfigurations;
385
387
388 UserGroupResolutionConfiguration m_userGroupResolutionConfiguration;
389
390 Aws::String m_requestId;
391 Aws::Http::HttpResponseCode m_HttpResponseCode;
392 bool m_nameHasBeenSet = false;
393 bool m_idHasBeenSet = false;
394 bool m_editionHasBeenSet = false;
395 bool m_roleArnHasBeenSet = false;
396 bool m_serverSideEncryptionConfigurationHasBeenSet = false;
397 bool m_statusHasBeenSet = false;
398 bool m_descriptionHasBeenSet = false;
399 bool m_createdAtHasBeenSet = false;
400 bool m_updatedAtHasBeenSet = false;
401 bool m_documentMetadataConfigurationsHasBeenSet = false;
402 bool m_indexStatisticsHasBeenSet = false;
403 bool m_errorMessageHasBeenSet = false;
404 bool m_capacityUnitsHasBeenSet = false;
405 bool m_userTokenConfigurationsHasBeenSet = false;
406 bool m_userContextPolicyHasBeenSet = false;
407 bool m_userGroupResolutionConfigurationHasBeenSet = false;
408 bool m_requestIdHasBeenSet = false;
409};
410
411} // namespace Model
412} // namespace kendra
413} // namespace Aws
DescribeIndexResult & WithErrorMessage(ErrorMessageT &&value)
void SetUserContextPolicy(UserContextPolicy value)
const Aws::Utils::DateTime & GetCreatedAt() const
const Aws::Vector< DocumentMetadataConfiguration > & GetDocumentMetadataConfigurations() const
DescribeIndexResult & WithRoleArn(RoleArnT &&value)
DescribeIndexResult & WithDescription(DescriptionT &&value)
const ServerSideEncryptionConfiguration & GetServerSideEncryptionConfiguration() const
DescribeIndexResult & AddUserTokenConfigurations(UserTokenConfigurationsT &&value)
DescribeIndexResult & WithRequestId(RequestIdT &&value)
DescribeIndexResult & WithUpdatedAt(UpdatedAtT &&value)
void SetServerSideEncryptionConfiguration(ServerSideEncryptionConfigurationT &&value)
void SetUserTokenConfigurations(UserTokenConfigurationsT &&value)
DescribeIndexResult & WithEdition(IndexEdition value)
const UserGroupResolutionConfiguration & GetUserGroupResolutionConfiguration() const
const Aws::Vector< UserTokenConfiguration > & GetUserTokenConfigurations() const
AWS_KENDRA_API DescribeIndexResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
void SetUserGroupResolutionConfiguration(UserGroupResolutionConfigurationT &&value)
DescribeIndexResult & AddDocumentMetadataConfigurations(DocumentMetadataConfigurationsT &&value)
void SetCapacityUnits(CapacityUnitsT &&value)
const CapacityUnitsConfiguration & GetCapacityUnits() const
const IndexStatistics & GetIndexStatistics() const
void SetIndexStatistics(IndexStatisticsT &&value)
Aws::Http::HttpResponseCode GetHttpResponseCode() const
DescribeIndexResult & WithCreatedAt(CreatedAtT &&value)
void SetDocumentMetadataConfigurations(DocumentMetadataConfigurationsT &&value)
AWS_KENDRA_API DescribeIndexResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeIndexResult & WithStatus(IndexStatus value)
const Aws::Utils::DateTime & GetUpdatedAt() const
AWS_KENDRA_API DescribeIndexResult()=default
DescribeIndexResult & WithUserTokenConfigurations(UserTokenConfigurationsT &&value)
DescribeIndexResult & WithServerSideEncryptionConfiguration(ServerSideEncryptionConfigurationT &&value)
DescribeIndexResult & WithName(NameT &&value)
const Aws::String & GetErrorMessage() const
DescribeIndexResult & WithCapacityUnits(CapacityUnitsT &&value)
DescribeIndexResult & WithUserContextPolicy(UserContextPolicy value)
DescribeIndexResult & WithId(IdT &&value)
DescribeIndexResult & WithUserGroupResolutionConfiguration(UserGroupResolutionConfigurationT &&value)
void SetErrorMessage(ErrorMessageT &&value)
DescribeIndexResult & WithIndexStatistics(IndexStatisticsT &&value)
DescribeIndexResult & WithDocumentMetadataConfigurations(DocumentMetadataConfigurationsT &&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