AWS SDK for C++

AWS SDK for C++ Version 1.11.608

Loading...
Searching...
No Matches
DescribeIndexResult.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/IndexEdition.h>
10#include <aws/kendra/model/ServerSideEncryptionConfiguration.h>
11#include <aws/kendra/model/IndexStatus.h>
12#include <aws/core/utils/DateTime.h>
13#include <aws/core/utils/memory/stl/AWSVector.h>
14#include <aws/kendra/model/IndexStatistics.h>
15#include <aws/kendra/model/CapacityUnitsConfiguration.h>
16#include <aws/kendra/model/UserContextPolicy.h>
17#include <aws/kendra/model/UserGroupResolutionConfiguration.h>
18#include <aws/kendra/model/DocumentMetadataConfiguration.h>
19#include <aws/kendra/model/UserTokenConfiguration.h>
20#include <utility>
21
22namespace Aws
23{
24template<typename RESULT_TYPE>
25class AmazonWebServiceResult;
26
27namespace Utils
28{
29namespace Json
30{
31 class JsonValue;
32} // namespace Json
33} // namespace Utils
34namespace kendra
35{
36namespace Model
37{
39 {
40 public:
41 AWS_KENDRA_API DescribeIndexResult() = default;
44
45
47
50 inline const Aws::String& GetName() const { return m_name; }
51 template<typename NameT = Aws::String>
52 void SetName(NameT&& value) { m_nameHasBeenSet = true; m_name = std::forward<NameT>(value); }
53 template<typename NameT = Aws::String>
54 DescribeIndexResult& WithName(NameT&& value) { SetName(std::forward<NameT>(value)); return *this;}
56
58
61 inline const Aws::String& GetId() const { return m_id; }
62 template<typename IdT = Aws::String>
63 void SetId(IdT&& value) { m_idHasBeenSet = true; m_id = std::forward<IdT>(value); }
64 template<typename IdT = Aws::String>
65 DescribeIndexResult& WithId(IdT&& value) { SetId(std::forward<IdT>(value)); return *this;}
67
69
73 inline IndexEdition GetEdition() const { return m_edition; }
74 inline void SetEdition(IndexEdition value) { m_editionHasBeenSet = true; m_edition = value; }
75 inline DescribeIndexResult& WithEdition(IndexEdition value) { SetEdition(value); return *this;}
77
79
83 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
84 template<typename RoleArnT = Aws::String>
85 void SetRoleArn(RoleArnT&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::forward<RoleArnT>(value); }
86 template<typename RoleArnT = Aws::String>
87 DescribeIndexResult& WithRoleArn(RoleArnT&& value) { SetRoleArn(std::forward<RoleArnT>(value)); return *this;}
89
91
95 inline const ServerSideEncryptionConfiguration& GetServerSideEncryptionConfiguration() const { return m_serverSideEncryptionConfiguration; }
96 template<typename ServerSideEncryptionConfigurationT = ServerSideEncryptionConfiguration>
97 void SetServerSideEncryptionConfiguration(ServerSideEncryptionConfigurationT&& value) { m_serverSideEncryptionConfigurationHasBeenSet = true; m_serverSideEncryptionConfiguration = std::forward<ServerSideEncryptionConfigurationT>(value); }
98 template<typename ServerSideEncryptionConfigurationT = ServerSideEncryptionConfiguration>
99 DescribeIndexResult& WithServerSideEncryptionConfiguration(ServerSideEncryptionConfigurationT&& value) { SetServerSideEncryptionConfiguration(std::forward<ServerSideEncryptionConfigurationT>(value)); return *this;}
101
103
109 inline IndexStatus GetStatus() const { return m_status; }
110 inline void SetStatus(IndexStatus value) { m_statusHasBeenSet = true; m_status = value; }
111 inline DescribeIndexResult& WithStatus(IndexStatus value) { SetStatus(value); return *this;}
113
115
118 inline const Aws::String& GetDescription() const { return m_description; }
119 template<typename DescriptionT = Aws::String>
120 void SetDescription(DescriptionT&& value) { m_descriptionHasBeenSet = true; m_description = std::forward<DescriptionT>(value); }
121 template<typename DescriptionT = Aws::String>
122 DescribeIndexResult& WithDescription(DescriptionT&& value) { SetDescription(std::forward<DescriptionT>(value)); return *this;}
124
126
129 inline const Aws::Utils::DateTime& GetCreatedAt() const { return m_createdAt; }
130 template<typename CreatedAtT = Aws::Utils::DateTime>
131 void SetCreatedAt(CreatedAtT&& value) { m_createdAtHasBeenSet = true; m_createdAt = std::forward<CreatedAtT>(value); }
132 template<typename CreatedAtT = Aws::Utils::DateTime>
133 DescribeIndexResult& WithCreatedAt(CreatedAtT&& value) { SetCreatedAt(std::forward<CreatedAtT>(value)); return *this;}
135
137
140 inline const Aws::Utils::DateTime& GetUpdatedAt() const { return m_updatedAt; }
141 template<typename UpdatedAtT = Aws::Utils::DateTime>
142 void SetUpdatedAt(UpdatedAtT&& value) { m_updatedAtHasBeenSet = true; m_updatedAt = std::forward<UpdatedAtT>(value); }
143 template<typename UpdatedAtT = Aws::Utils::DateTime>
144 DescribeIndexResult& WithUpdatedAt(UpdatedAtT&& value) { SetUpdatedAt(std::forward<UpdatedAtT>(value)); return *this;}
146
148
153 inline const Aws::Vector<DocumentMetadataConfiguration>& GetDocumentMetadataConfigurations() const { return m_documentMetadataConfigurations; }
154 template<typename DocumentMetadataConfigurationsT = Aws::Vector<DocumentMetadataConfiguration>>
155 void SetDocumentMetadataConfigurations(DocumentMetadataConfigurationsT&& value) { m_documentMetadataConfigurationsHasBeenSet = true; m_documentMetadataConfigurations = std::forward<DocumentMetadataConfigurationsT>(value); }
156 template<typename DocumentMetadataConfigurationsT = Aws::Vector<DocumentMetadataConfiguration>>
157 DescribeIndexResult& WithDocumentMetadataConfigurations(DocumentMetadataConfigurationsT&& value) { SetDocumentMetadataConfigurations(std::forward<DocumentMetadataConfigurationsT>(value)); return *this;}
158 template<typename DocumentMetadataConfigurationsT = DocumentMetadataConfiguration>
159 DescribeIndexResult& AddDocumentMetadataConfigurations(DocumentMetadataConfigurationsT&& value) { m_documentMetadataConfigurationsHasBeenSet = true; m_documentMetadataConfigurations.emplace_back(std::forward<DocumentMetadataConfigurationsT>(value)); return *this; }
161
163
167 inline const IndexStatistics& GetIndexStatistics() const { return m_indexStatistics; }
168 template<typename IndexStatisticsT = IndexStatistics>
169 void SetIndexStatistics(IndexStatisticsT&& value) { m_indexStatisticsHasBeenSet = true; m_indexStatistics = std::forward<IndexStatisticsT>(value); }
170 template<typename IndexStatisticsT = IndexStatistics>
171 DescribeIndexResult& WithIndexStatistics(IndexStatisticsT&& value) { SetIndexStatistics(std::forward<IndexStatisticsT>(value)); return *this;}
173
175
179 inline const Aws::String& GetErrorMessage() const { return m_errorMessage; }
180 template<typename ErrorMessageT = Aws::String>
181 void SetErrorMessage(ErrorMessageT&& value) { m_errorMessageHasBeenSet = true; m_errorMessage = std::forward<ErrorMessageT>(value); }
182 template<typename ErrorMessageT = Aws::String>
183 DescribeIndexResult& WithErrorMessage(ErrorMessageT&& value) { SetErrorMessage(std::forward<ErrorMessageT>(value)); return *this;}
185
187
196 inline const CapacityUnitsConfiguration& GetCapacityUnits() const { return m_capacityUnits; }
197 template<typename CapacityUnitsT = CapacityUnitsConfiguration>
198 void SetCapacityUnits(CapacityUnitsT&& value) { m_capacityUnitsHasBeenSet = true; m_capacityUnits = std::forward<CapacityUnitsT>(value); }
199 template<typename CapacityUnitsT = CapacityUnitsConfiguration>
200 DescribeIndexResult& WithCapacityUnits(CapacityUnitsT&& value) { SetCapacityUnits(std::forward<CapacityUnitsT>(value)); return *this;}
202
204
207 inline const Aws::Vector<UserTokenConfiguration>& GetUserTokenConfigurations() const { return m_userTokenConfigurations; }
208 template<typename UserTokenConfigurationsT = Aws::Vector<UserTokenConfiguration>>
209 void SetUserTokenConfigurations(UserTokenConfigurationsT&& value) { m_userTokenConfigurationsHasBeenSet = true; m_userTokenConfigurations = std::forward<UserTokenConfigurationsT>(value); }
210 template<typename UserTokenConfigurationsT = Aws::Vector<UserTokenConfiguration>>
211 DescribeIndexResult& WithUserTokenConfigurations(UserTokenConfigurationsT&& value) { SetUserTokenConfigurations(std::forward<UserTokenConfigurationsT>(value)); return *this;}
212 template<typename UserTokenConfigurationsT = UserTokenConfiguration>
213 DescribeIndexResult& AddUserTokenConfigurations(UserTokenConfigurationsT&& value) { m_userTokenConfigurationsHasBeenSet = true; m_userTokenConfigurations.emplace_back(std::forward<UserTokenConfigurationsT>(value)); return *this; }
215
217
220 inline UserContextPolicy GetUserContextPolicy() const { return m_userContextPolicy; }
221 inline void SetUserContextPolicy(UserContextPolicy value) { m_userContextPolicyHasBeenSet = true; m_userContextPolicy = value; }
224
226
231 inline const UserGroupResolutionConfiguration& GetUserGroupResolutionConfiguration() const { return m_userGroupResolutionConfiguration; }
232 template<typename UserGroupResolutionConfigurationT = UserGroupResolutionConfiguration>
233 void SetUserGroupResolutionConfiguration(UserGroupResolutionConfigurationT&& value) { m_userGroupResolutionConfigurationHasBeenSet = true; m_userGroupResolutionConfiguration = std::forward<UserGroupResolutionConfigurationT>(value); }
234 template<typename UserGroupResolutionConfigurationT = UserGroupResolutionConfiguration>
235 DescribeIndexResult& WithUserGroupResolutionConfiguration(UserGroupResolutionConfigurationT&& value) { SetUserGroupResolutionConfiguration(std::forward<UserGroupResolutionConfigurationT>(value)); return *this;}
237
239
240 inline const Aws::String& GetRequestId() const { return m_requestId; }
241 template<typename RequestIdT = Aws::String>
242 void SetRequestId(RequestIdT&& value) { m_requestIdHasBeenSet = true; m_requestId = std::forward<RequestIdT>(value); }
243 template<typename RequestIdT = Aws::String>
244 DescribeIndexResult& WithRequestId(RequestIdT&& value) { SetRequestId(std::forward<RequestIdT>(value)); return *this;}
246 private:
247
248 Aws::String m_name;
249 bool m_nameHasBeenSet = false;
250
251 Aws::String m_id;
252 bool m_idHasBeenSet = false;
253
255 bool m_editionHasBeenSet = false;
256
257 Aws::String m_roleArn;
258 bool m_roleArnHasBeenSet = false;
259
260 ServerSideEncryptionConfiguration m_serverSideEncryptionConfiguration;
261 bool m_serverSideEncryptionConfigurationHasBeenSet = false;
262
264 bool m_statusHasBeenSet = false;
265
266 Aws::String m_description;
267 bool m_descriptionHasBeenSet = false;
268
269 Aws::Utils::DateTime m_createdAt{};
270 bool m_createdAtHasBeenSet = false;
271
272 Aws::Utils::DateTime m_updatedAt{};
273 bool m_updatedAtHasBeenSet = false;
274
275 Aws::Vector<DocumentMetadataConfiguration> m_documentMetadataConfigurations;
276 bool m_documentMetadataConfigurationsHasBeenSet = false;
277
278 IndexStatistics m_indexStatistics;
279 bool m_indexStatisticsHasBeenSet = false;
280
281 Aws::String m_errorMessage;
282 bool m_errorMessageHasBeenSet = false;
283
284 CapacityUnitsConfiguration m_capacityUnits;
285 bool m_capacityUnitsHasBeenSet = false;
286
287 Aws::Vector<UserTokenConfiguration> m_userTokenConfigurations;
288 bool m_userTokenConfigurationsHasBeenSet = false;
289
291 bool m_userContextPolicyHasBeenSet = false;
292
293 UserGroupResolutionConfiguration m_userGroupResolutionConfiguration;
294 bool m_userGroupResolutionConfigurationHasBeenSet = false;
295
296 Aws::String m_requestId;
297 bool m_requestIdHasBeenSet = false;
298 };
299
300} // namespace Model
301} // namespace kendra
302} // 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