AWS SDK for C++

AWS SDK for C++ Version 1.11.685

Loading...
Searching...
No Matches
DescribeIndexResult.h
1
6#pragma once
7#include <aws/core/utils/DateTime.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/CapacityUnitsConfiguration.h>
12#include <aws/kendra/model/DocumentMetadataConfiguration.h>
13#include <aws/kendra/model/IndexEdition.h>
14#include <aws/kendra/model/IndexStatistics.h>
15#include <aws/kendra/model/IndexStatus.h>
16#include <aws/kendra/model/ServerSideEncryptionConfiguration.h>
17#include <aws/kendra/model/UserContextPolicy.h>
18#include <aws/kendra/model/UserGroupResolutionConfiguration.h>
19#include <aws/kendra/model/UserTokenConfiguration.h>
20
21#include <utility>
22
23namespace Aws {
24template <typename RESULT_TYPE>
25class AmazonWebServiceResult;
26
27namespace Utils {
28namespace Json {
29class JsonValue;
30} // namespace Json
31} // namespace Utils
32namespace kendra {
33namespace Model {
35 public:
36 AWS_KENDRA_API DescribeIndexResult() = default;
39
41
44 inline const Aws::String& GetName() const { return m_name; }
45 template <typename NameT = Aws::String>
46 void SetName(NameT&& value) {
47 m_nameHasBeenSet = true;
48 m_name = std::forward<NameT>(value);
49 }
50 template <typename NameT = Aws::String>
51 DescribeIndexResult& WithName(NameT&& value) {
52 SetName(std::forward<NameT>(value));
53 return *this;
54 }
56
58
61 inline const Aws::String& GetId() const { return m_id; }
62 template <typename IdT = Aws::String>
63 void SetId(IdT&& value) {
64 m_idHasBeenSet = true;
65 m_id = std::forward<IdT>(value);
66 }
67 template <typename IdT = Aws::String>
69 SetId(std::forward<IdT>(value));
70 return *this;
71 }
73
75
79 inline IndexEdition GetEdition() const { return m_edition; }
80 inline void SetEdition(IndexEdition value) {
81 m_editionHasBeenSet = true;
82 m_edition = value;
83 }
85 SetEdition(value);
86 return *this;
87 }
89
91
95 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
96 template <typename RoleArnT = Aws::String>
97 void SetRoleArn(RoleArnT&& value) {
98 m_roleArnHasBeenSet = true;
99 m_roleArn = std::forward<RoleArnT>(value);
100 }
101 template <typename RoleArnT = Aws::String>
102 DescribeIndexResult& WithRoleArn(RoleArnT&& value) {
103 SetRoleArn(std::forward<RoleArnT>(value));
104 return *this;
105 }
107
109
114 return m_serverSideEncryptionConfiguration;
115 }
116 template <typename ServerSideEncryptionConfigurationT = ServerSideEncryptionConfiguration>
117 void SetServerSideEncryptionConfiguration(ServerSideEncryptionConfigurationT&& value) {
118 m_serverSideEncryptionConfigurationHasBeenSet = true;
119 m_serverSideEncryptionConfiguration = std::forward<ServerSideEncryptionConfigurationT>(value);
120 }
121 template <typename ServerSideEncryptionConfigurationT = ServerSideEncryptionConfiguration>
122 DescribeIndexResult& WithServerSideEncryptionConfiguration(ServerSideEncryptionConfigurationT&& value) {
123 SetServerSideEncryptionConfiguration(std::forward<ServerSideEncryptionConfigurationT>(value));
124 return *this;
125 }
127
129
135 inline IndexStatus GetStatus() const { return m_status; }
136 inline void SetStatus(IndexStatus value) {
137 m_statusHasBeenSet = true;
138 m_status = value;
139 }
141 SetStatus(value);
142 return *this;
143 }
145
147
150 inline const Aws::String& GetDescription() const { return m_description; }
151 template <typename DescriptionT = Aws::String>
152 void SetDescription(DescriptionT&& value) {
153 m_descriptionHasBeenSet = true;
154 m_description = std::forward<DescriptionT>(value);
155 }
156 template <typename DescriptionT = Aws::String>
157 DescribeIndexResult& WithDescription(DescriptionT&& value) {
158 SetDescription(std::forward<DescriptionT>(value));
159 return *this;
160 }
162
164
167 inline const Aws::Utils::DateTime& GetCreatedAt() const { return m_createdAt; }
168 template <typename CreatedAtT = Aws::Utils::DateTime>
169 void SetCreatedAt(CreatedAtT&& value) {
170 m_createdAtHasBeenSet = true;
171 m_createdAt = std::forward<CreatedAtT>(value);
172 }
173 template <typename CreatedAtT = Aws::Utils::DateTime>
174 DescribeIndexResult& WithCreatedAt(CreatedAtT&& value) {
175 SetCreatedAt(std::forward<CreatedAtT>(value));
176 return *this;
177 }
179
181
184 inline const Aws::Utils::DateTime& GetUpdatedAt() const { return m_updatedAt; }
185 template <typename UpdatedAtT = Aws::Utils::DateTime>
186 void SetUpdatedAt(UpdatedAtT&& value) {
187 m_updatedAtHasBeenSet = true;
188 m_updatedAt = std::forward<UpdatedAtT>(value);
189 }
190 template <typename UpdatedAtT = Aws::Utils::DateTime>
191 DescribeIndexResult& WithUpdatedAt(UpdatedAtT&& value) {
192 SetUpdatedAt(std::forward<UpdatedAtT>(value));
193 return *this;
194 }
196
198
204 return m_documentMetadataConfigurations;
205 }
206 template <typename DocumentMetadataConfigurationsT = Aws::Vector<DocumentMetadataConfiguration>>
207 void SetDocumentMetadataConfigurations(DocumentMetadataConfigurationsT&& value) {
208 m_documentMetadataConfigurationsHasBeenSet = true;
209 m_documentMetadataConfigurations = std::forward<DocumentMetadataConfigurationsT>(value);
210 }
211 template <typename DocumentMetadataConfigurationsT = Aws::Vector<DocumentMetadataConfiguration>>
212 DescribeIndexResult& WithDocumentMetadataConfigurations(DocumentMetadataConfigurationsT&& value) {
213 SetDocumentMetadataConfigurations(std::forward<DocumentMetadataConfigurationsT>(value));
214 return *this;
215 }
216 template <typename DocumentMetadataConfigurationsT = DocumentMetadataConfiguration>
217 DescribeIndexResult& AddDocumentMetadataConfigurations(DocumentMetadataConfigurationsT&& value) {
218 m_documentMetadataConfigurationsHasBeenSet = true;
219 m_documentMetadataConfigurations.emplace_back(std::forward<DocumentMetadataConfigurationsT>(value));
220 return *this;
221 }
223
225
229 inline const IndexStatistics& GetIndexStatistics() const { return m_indexStatistics; }
230 template <typename IndexStatisticsT = IndexStatistics>
231 void SetIndexStatistics(IndexStatisticsT&& value) {
232 m_indexStatisticsHasBeenSet = true;
233 m_indexStatistics = std::forward<IndexStatisticsT>(value);
234 }
235 template <typename IndexStatisticsT = IndexStatistics>
236 DescribeIndexResult& WithIndexStatistics(IndexStatisticsT&& value) {
237 SetIndexStatistics(std::forward<IndexStatisticsT>(value));
238 return *this;
239 }
241
243
247 inline const Aws::String& GetErrorMessage() const { return m_errorMessage; }
248 template <typename ErrorMessageT = Aws::String>
249 void SetErrorMessage(ErrorMessageT&& value) {
250 m_errorMessageHasBeenSet = true;
251 m_errorMessage = std::forward<ErrorMessageT>(value);
252 }
253 template <typename ErrorMessageT = Aws::String>
254 DescribeIndexResult& WithErrorMessage(ErrorMessageT&& value) {
255 SetErrorMessage(std::forward<ErrorMessageT>(value));
256 return *this;
257 }
259
261
270 inline const CapacityUnitsConfiguration& GetCapacityUnits() const { return m_capacityUnits; }
271 template <typename CapacityUnitsT = CapacityUnitsConfiguration>
272 void SetCapacityUnits(CapacityUnitsT&& value) {
273 m_capacityUnitsHasBeenSet = true;
274 m_capacityUnits = std::forward<CapacityUnitsT>(value);
275 }
276 template <typename CapacityUnitsT = CapacityUnitsConfiguration>
277 DescribeIndexResult& WithCapacityUnits(CapacityUnitsT&& value) {
278 SetCapacityUnits(std::forward<CapacityUnitsT>(value));
279 return *this;
280 }
282
284
287 inline const Aws::Vector<UserTokenConfiguration>& GetUserTokenConfigurations() const { return m_userTokenConfigurations; }
288 template <typename UserTokenConfigurationsT = Aws::Vector<UserTokenConfiguration>>
289 void SetUserTokenConfigurations(UserTokenConfigurationsT&& value) {
290 m_userTokenConfigurationsHasBeenSet = true;
291 m_userTokenConfigurations = std::forward<UserTokenConfigurationsT>(value);
292 }
293 template <typename UserTokenConfigurationsT = Aws::Vector<UserTokenConfiguration>>
294 DescribeIndexResult& WithUserTokenConfigurations(UserTokenConfigurationsT&& value) {
295 SetUserTokenConfigurations(std::forward<UserTokenConfigurationsT>(value));
296 return *this;
297 }
298 template <typename UserTokenConfigurationsT = UserTokenConfiguration>
299 DescribeIndexResult& AddUserTokenConfigurations(UserTokenConfigurationsT&& value) {
300 m_userTokenConfigurationsHasBeenSet = true;
301 m_userTokenConfigurations.emplace_back(std::forward<UserTokenConfigurationsT>(value));
302 return *this;
303 }
305
307
310 inline UserContextPolicy GetUserContextPolicy() const { return m_userContextPolicy; }
312 m_userContextPolicyHasBeenSet = true;
313 m_userContextPolicy = value;
314 }
317 return *this;
318 }
320
322
327 inline const UserGroupResolutionConfiguration& GetUserGroupResolutionConfiguration() const { return m_userGroupResolutionConfiguration; }
328 template <typename UserGroupResolutionConfigurationT = UserGroupResolutionConfiguration>
329 void SetUserGroupResolutionConfiguration(UserGroupResolutionConfigurationT&& value) {
330 m_userGroupResolutionConfigurationHasBeenSet = true;
331 m_userGroupResolutionConfiguration = std::forward<UserGroupResolutionConfigurationT>(value);
332 }
333 template <typename UserGroupResolutionConfigurationT = UserGroupResolutionConfiguration>
334 DescribeIndexResult& WithUserGroupResolutionConfiguration(UserGroupResolutionConfigurationT&& value) {
335 SetUserGroupResolutionConfiguration(std::forward<UserGroupResolutionConfigurationT>(value));
336 return *this;
337 }
339
341
342 inline const Aws::String& GetRequestId() const { return m_requestId; }
343 template <typename RequestIdT = Aws::String>
344 void SetRequestId(RequestIdT&& value) {
345 m_requestIdHasBeenSet = true;
346 m_requestId = std::forward<RequestIdT>(value);
347 }
348 template <typename RequestIdT = Aws::String>
349 DescribeIndexResult& WithRequestId(RequestIdT&& value) {
350 SetRequestId(std::forward<RequestIdT>(value));
351 return *this;
352 }
354 private:
355 Aws::String m_name;
356 bool m_nameHasBeenSet = false;
357
358 Aws::String m_id;
359 bool m_idHasBeenSet = false;
360
362 bool m_editionHasBeenSet = false;
363
364 Aws::String m_roleArn;
365 bool m_roleArnHasBeenSet = false;
366
367 ServerSideEncryptionConfiguration m_serverSideEncryptionConfiguration;
368 bool m_serverSideEncryptionConfigurationHasBeenSet = false;
369
371 bool m_statusHasBeenSet = false;
372
373 Aws::String m_description;
374 bool m_descriptionHasBeenSet = false;
375
376 Aws::Utils::DateTime m_createdAt{};
377 bool m_createdAtHasBeenSet = false;
378
379 Aws::Utils::DateTime m_updatedAt{};
380 bool m_updatedAtHasBeenSet = false;
381
382 Aws::Vector<DocumentMetadataConfiguration> m_documentMetadataConfigurations;
383 bool m_documentMetadataConfigurationsHasBeenSet = false;
384
385 IndexStatistics m_indexStatistics;
386 bool m_indexStatisticsHasBeenSet = false;
387
388 Aws::String m_errorMessage;
389 bool m_errorMessageHasBeenSet = false;
390
391 CapacityUnitsConfiguration m_capacityUnits;
392 bool m_capacityUnitsHasBeenSet = false;
393
394 Aws::Vector<UserTokenConfiguration> m_userTokenConfigurations;
395 bool m_userTokenConfigurationsHasBeenSet = false;
396
398 bool m_userContextPolicyHasBeenSet = false;
399
400 UserGroupResolutionConfiguration m_userGroupResolutionConfiguration;
401 bool m_userGroupResolutionConfigurationHasBeenSet = false;
402
403 Aws::String m_requestId;
404 bool m_requestIdHasBeenSet = false;
405};
406
407} // namespace Model
408} // namespace kendra
409} // 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)
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