AWS SDK for C++

AWS SDK for C++ Version 1.11.930

Loading...
Searching...
No Matches
Index.h
1
6#pragma once
7#include <aws/core/utils/DateTime.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/s3vectors/S3Vectors_EXPORTS.h>
10#include <aws/s3vectors/model/DataType.h>
11#include <aws/s3vectors/model/DistanceMetric.h>
12#include <aws/s3vectors/model/EncryptionConfiguration.h>
13#include <aws/s3vectors/model/IndexMode.h>
14#include <aws/s3vectors/model/MetadataConfiguration.h>
15
16#include <utility>
17
18namespace Aws {
19namespace Utils {
20namespace Json {
21class JsonValue;
22class JsonView;
23} // namespace Json
24} // namespace Utils
25namespace S3Vectors {
26namespace Model {
27
33class Index {
34 public:
35 AWS_S3VECTORS_API Index() = default;
36 AWS_S3VECTORS_API Index(Aws::Utils::Json::JsonView jsonValue);
37 AWS_S3VECTORS_API Index& operator=(Aws::Utils::Json::JsonView jsonValue);
38 AWS_S3VECTORS_API Aws::Utils::Json::JsonValue Jsonize() const;
39
41
44 inline const Aws::String& GetVectorBucketName() const { return m_vectorBucketName; }
45 inline bool VectorBucketNameHasBeenSet() const { return m_vectorBucketNameHasBeenSet; }
46 template <typename VectorBucketNameT = Aws::String>
47 void SetVectorBucketName(VectorBucketNameT&& value) {
48 m_vectorBucketNameHasBeenSet = true;
49 m_vectorBucketName = std::forward<VectorBucketNameT>(value);
50 }
51 template <typename VectorBucketNameT = Aws::String>
52 Index& WithVectorBucketName(VectorBucketNameT&& value) {
53 SetVectorBucketName(std::forward<VectorBucketNameT>(value));
54 return *this;
55 }
57
59
62 inline const Aws::String& GetIndexName() const { return m_indexName; }
63 inline bool IndexNameHasBeenSet() const { return m_indexNameHasBeenSet; }
64 template <typename IndexNameT = Aws::String>
65 void SetIndexName(IndexNameT&& value) {
66 m_indexNameHasBeenSet = true;
67 m_indexName = std::forward<IndexNameT>(value);
68 }
69 template <typename IndexNameT = Aws::String>
70 Index& WithIndexName(IndexNameT&& value) {
71 SetIndexName(std::forward<IndexNameT>(value));
72 return *this;
73 }
75
77
80 inline const Aws::String& GetIndexArn() const { return m_indexArn; }
81 inline bool IndexArnHasBeenSet() const { return m_indexArnHasBeenSet; }
82 template <typename IndexArnT = Aws::String>
83 void SetIndexArn(IndexArnT&& value) {
84 m_indexArnHasBeenSet = true;
85 m_indexArn = std::forward<IndexArnT>(value);
86 }
87 template <typename IndexArnT = Aws::String>
88 Index& WithIndexArn(IndexArnT&& value) {
89 SetIndexArn(std::forward<IndexArnT>(value));
90 return *this;
91 }
93
95
98 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
99 inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; }
100 template <typename CreationTimeT = Aws::Utils::DateTime>
101 void SetCreationTime(CreationTimeT&& value) {
102 m_creationTimeHasBeenSet = true;
103 m_creationTime = std::forward<CreationTimeT>(value);
104 }
105 template <typename CreationTimeT = Aws::Utils::DateTime>
106 Index& WithCreationTime(CreationTimeT&& value) {
107 SetCreationTime(std::forward<CreationTimeT>(value));
108 return *this;
109 }
111
113
116 inline DataType GetDataType() const { return m_dataType; }
117 inline bool DataTypeHasBeenSet() const { return m_dataTypeHasBeenSet; }
118 inline void SetDataType(DataType value) {
119 m_dataTypeHasBeenSet = true;
120 m_dataType = value;
121 }
122 inline Index& WithDataType(DataType value) {
123 SetDataType(value);
124 return *this;
125 }
127
129
133 inline int GetDimension() const { return m_dimension; }
134 inline bool DimensionHasBeenSet() const { return m_dimensionHasBeenSet; }
135 inline void SetDimension(int value) {
136 m_dimensionHasBeenSet = true;
137 m_dimension = value;
138 }
139 inline Index& WithDimension(int value) {
140 SetDimension(value);
141 return *this;
142 }
144
146
149 inline DistanceMetric GetDistanceMetric() const { return m_distanceMetric; }
150 inline bool DistanceMetricHasBeenSet() const { return m_distanceMetricHasBeenSet; }
152 m_distanceMetricHasBeenSet = true;
153 m_distanceMetric = value;
154 }
156 SetDistanceMetric(value);
157 return *this;
158 }
160
162
165 inline const MetadataConfiguration& GetMetadataConfiguration() const { return m_metadataConfiguration; }
166 inline bool MetadataConfigurationHasBeenSet() const { return m_metadataConfigurationHasBeenSet; }
167 template <typename MetadataConfigurationT = MetadataConfiguration>
168 void SetMetadataConfiguration(MetadataConfigurationT&& value) {
169 m_metadataConfigurationHasBeenSet = true;
170 m_metadataConfiguration = std::forward<MetadataConfigurationT>(value);
171 }
172 template <typename MetadataConfigurationT = MetadataConfiguration>
173 Index& WithMetadataConfiguration(MetadataConfigurationT&& value) {
174 SetMetadataConfiguration(std::forward<MetadataConfigurationT>(value));
175 return *this;
176 }
178
180
185 inline const EncryptionConfiguration& GetEncryptionConfiguration() const { return m_encryptionConfiguration; }
186 inline bool EncryptionConfigurationHasBeenSet() const { return m_encryptionConfigurationHasBeenSet; }
187 template <typename EncryptionConfigurationT = EncryptionConfiguration>
188 void SetEncryptionConfiguration(EncryptionConfigurationT&& value) {
189 m_encryptionConfigurationHasBeenSet = true;
190 m_encryptionConfiguration = std::forward<EncryptionConfigurationT>(value);
191 }
192 template <typename EncryptionConfigurationT = EncryptionConfiguration>
193 Index& WithEncryptionConfiguration(EncryptionConfigurationT&& value) {
194 SetEncryptionConfiguration(std::forward<EncryptionConfigurationT>(value));
195 return *this;
196 }
198
200
206 inline IndexMode GetIndexMode() const { return m_indexMode; }
207 inline bool IndexModeHasBeenSet() const { return m_indexModeHasBeenSet; }
208 inline void SetIndexMode(IndexMode value) {
209 m_indexModeHasBeenSet = true;
210 m_indexMode = value;
211 }
213 SetIndexMode(value);
214 return *this;
215 }
217 private:
218 Aws::String m_vectorBucketName;
219
220 Aws::String m_indexName;
221
222 Aws::String m_indexArn;
223
224 Aws::Utils::DateTime m_creationTime{};
225
226 DataType m_dataType{DataType::NOT_SET};
227
228 int m_dimension{0};
229
230 DistanceMetric m_distanceMetric{DistanceMetric::NOT_SET};
231
232 MetadataConfiguration m_metadataConfiguration;
233
234 EncryptionConfiguration m_encryptionConfiguration;
235
236 IndexMode m_indexMode{IndexMode::NOT_SET};
237 bool m_vectorBucketNameHasBeenSet = false;
238 bool m_indexNameHasBeenSet = false;
239 bool m_indexArnHasBeenSet = false;
240 bool m_creationTimeHasBeenSet = false;
241 bool m_dataTypeHasBeenSet = false;
242 bool m_dimensionHasBeenSet = false;
243 bool m_distanceMetricHasBeenSet = false;
244 bool m_metadataConfigurationHasBeenSet = false;
245 bool m_encryptionConfigurationHasBeenSet = false;
246 bool m_indexModeHasBeenSet = false;
247};
248
249} // namespace Model
250} // namespace S3Vectors
251} // namespace Aws
void SetVectorBucketName(VectorBucketNameT &&value)
Definition Index.h:47
void SetDimension(int value)
Definition Index.h:135
void SetIndexMode(IndexMode value)
Definition Index.h:208
AWS_S3VECTORS_API Index & operator=(Aws::Utils::Json::JsonView jsonValue)
void SetDistanceMetric(DistanceMetric value)
Definition Index.h:151
bool DistanceMetricHasBeenSet() const
Definition Index.h:150
const Aws::String & GetIndexName() const
Definition Index.h:62
void SetIndexName(IndexNameT &&value)
Definition Index.h:65
void SetIndexArn(IndexArnT &&value)
Definition Index.h:83
const Aws::String & GetVectorBucketName() const
Definition Index.h:44
Index & WithCreationTime(CreationTimeT &&value)
Definition Index.h:106
bool VectorBucketNameHasBeenSet() const
Definition Index.h:45
Index & WithDataType(DataType value)
Definition Index.h:122
Index & WithDistanceMetric(DistanceMetric value)
Definition Index.h:155
void SetMetadataConfiguration(MetadataConfigurationT &&value)
Definition Index.h:168
const EncryptionConfiguration & GetEncryptionConfiguration() const
Definition Index.h:185
DataType GetDataType() const
Definition Index.h:116
bool DimensionHasBeenSet() const
Definition Index.h:134
bool IndexArnHasBeenSet() const
Definition Index.h:81
AWS_S3VECTORS_API Index()=default
AWS_S3VECTORS_API Aws::Utils::Json::JsonValue Jsonize() const
const Aws::String & GetIndexArn() const
Definition Index.h:80
IndexMode GetIndexMode() const
Definition Index.h:206
Index & WithMetadataConfiguration(MetadataConfigurationT &&value)
Definition Index.h:173
Index & WithIndexArn(IndexArnT &&value)
Definition Index.h:88
bool IndexNameHasBeenSet() const
Definition Index.h:63
Index & WithVectorBucketName(VectorBucketNameT &&value)
Definition Index.h:52
AWS_S3VECTORS_API Index(Aws::Utils::Json::JsonView jsonValue)
bool DataTypeHasBeenSet() const
Definition Index.h:117
const MetadataConfiguration & GetMetadataConfiguration() const
Definition Index.h:165
Index & WithIndexName(IndexNameT &&value)
Definition Index.h:70
bool EncryptionConfigurationHasBeenSet() const
Definition Index.h:186
bool MetadataConfigurationHasBeenSet() const
Definition Index.h:166
void SetDataType(DataType value)
Definition Index.h:118
Index & WithDimension(int value)
Definition Index.h:139
Index & WithEncryptionConfiguration(EncryptionConfigurationT &&value)
Definition Index.h:193
const Aws::Utils::DateTime & GetCreationTime() const
Definition Index.h:98
bool CreationTimeHasBeenSet() const
Definition Index.h:99
Index & WithIndexMode(IndexMode value)
Definition Index.h:212
DistanceMetric GetDistanceMetric() const
Definition Index.h:149
bool IndexModeHasBeenSet() const
Definition Index.h:207
void SetCreationTime(CreationTimeT &&value)
Definition Index.h:101
void SetEncryptionConfiguration(EncryptionConfigurationT &&value)
Definition Index.h:188
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Aws::Utils::Json::JsonValue JsonValue