AWS SDK for C++

AWS SDK for C++ Version 1.11.607

Loading...
Searching...
No Matches
Index.h
1
6#pragma once
7#include <aws/s3vectors/S3Vectors_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/DateTime.h>
10#include <aws/s3vectors/model/DataType.h>
11#include <aws/s3vectors/model/DistanceMetric.h>
12#include <aws/s3vectors/model/MetadataConfiguration.h>
13#include <utility>
14
15namespace Aws
16{
17namespace Utils
18{
19namespace Json
20{
21 class JsonValue;
22 class JsonView;
23} // namespace Json
24} // namespace Utils
25namespace S3Vectors
26{
27namespace Model
28{
29
37 class Index
38 {
39 public:
40 AWS_S3VECTORS_API Index() = default;
41 AWS_S3VECTORS_API Index(Aws::Utils::Json::JsonView jsonValue);
42 AWS_S3VECTORS_API Index& operator=(Aws::Utils::Json::JsonView jsonValue);
43 AWS_S3VECTORS_API Aws::Utils::Json::JsonValue Jsonize() const;
44
45
47
50 inline const Aws::String& GetVectorBucketName() const { return m_vectorBucketName; }
51 inline bool VectorBucketNameHasBeenSet() const { return m_vectorBucketNameHasBeenSet; }
52 template<typename VectorBucketNameT = Aws::String>
53 void SetVectorBucketName(VectorBucketNameT&& value) { m_vectorBucketNameHasBeenSet = true; m_vectorBucketName = std::forward<VectorBucketNameT>(value); }
54 template<typename VectorBucketNameT = Aws::String>
55 Index& WithVectorBucketName(VectorBucketNameT&& value) { SetVectorBucketName(std::forward<VectorBucketNameT>(value)); return *this;}
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) { m_indexNameHasBeenSet = true; m_indexName = std::forward<IndexNameT>(value); }
66 template<typename IndexNameT = Aws::String>
67 Index& WithIndexName(IndexNameT&& value) { SetIndexName(std::forward<IndexNameT>(value)); return *this;}
69
71
74 inline const Aws::String& GetIndexArn() const { return m_indexArn; }
75 inline bool IndexArnHasBeenSet() const { return m_indexArnHasBeenSet; }
76 template<typename IndexArnT = Aws::String>
77 void SetIndexArn(IndexArnT&& value) { m_indexArnHasBeenSet = true; m_indexArn = std::forward<IndexArnT>(value); }
78 template<typename IndexArnT = Aws::String>
79 Index& WithIndexArn(IndexArnT&& value) { SetIndexArn(std::forward<IndexArnT>(value)); return *this;}
81
83
86 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
87 inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; }
88 template<typename CreationTimeT = Aws::Utils::DateTime>
89 void SetCreationTime(CreationTimeT&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::forward<CreationTimeT>(value); }
90 template<typename CreationTimeT = Aws::Utils::DateTime>
91 Index& WithCreationTime(CreationTimeT&& value) { SetCreationTime(std::forward<CreationTimeT>(value)); return *this;}
93
95
98 inline DataType GetDataType() const { return m_dataType; }
99 inline bool DataTypeHasBeenSet() const { return m_dataTypeHasBeenSet; }
100 inline void SetDataType(DataType value) { m_dataTypeHasBeenSet = true; m_dataType = value; }
101 inline Index& WithDataType(DataType value) { SetDataType(value); return *this;}
103
105
109 inline int GetDimension() const { return m_dimension; }
110 inline bool DimensionHasBeenSet() const { return m_dimensionHasBeenSet; }
111 inline void SetDimension(int value) { m_dimensionHasBeenSet = true; m_dimension = value; }
112 inline Index& WithDimension(int value) { SetDimension(value); return *this;}
114
116
119 inline DistanceMetric GetDistanceMetric() const { return m_distanceMetric; }
120 inline bool DistanceMetricHasBeenSet() const { return m_distanceMetricHasBeenSet; }
121 inline void SetDistanceMetric(DistanceMetric value) { m_distanceMetricHasBeenSet = true; m_distanceMetric = value; }
122 inline Index& WithDistanceMetric(DistanceMetric value) { SetDistanceMetric(value); return *this;}
124
126
129 inline const MetadataConfiguration& GetMetadataConfiguration() const { return m_metadataConfiguration; }
130 inline bool MetadataConfigurationHasBeenSet() const { return m_metadataConfigurationHasBeenSet; }
131 template<typename MetadataConfigurationT = MetadataConfiguration>
132 void SetMetadataConfiguration(MetadataConfigurationT&& value) { m_metadataConfigurationHasBeenSet = true; m_metadataConfiguration = std::forward<MetadataConfigurationT>(value); }
133 template<typename MetadataConfigurationT = MetadataConfiguration>
134 Index& WithMetadataConfiguration(MetadataConfigurationT&& value) { SetMetadataConfiguration(std::forward<MetadataConfigurationT>(value)); return *this;}
136 private:
137
138 Aws::String m_vectorBucketName;
139 bool m_vectorBucketNameHasBeenSet = false;
140
141 Aws::String m_indexName;
142 bool m_indexNameHasBeenSet = false;
143
144 Aws::String m_indexArn;
145 bool m_indexArnHasBeenSet = false;
146
147 Aws::Utils::DateTime m_creationTime{};
148 bool m_creationTimeHasBeenSet = false;
149
150 DataType m_dataType{DataType::NOT_SET};
151 bool m_dataTypeHasBeenSet = false;
152
153 int m_dimension{0};
154 bool m_dimensionHasBeenSet = false;
155
156 DistanceMetric m_distanceMetric{DistanceMetric::NOT_SET};
157 bool m_distanceMetricHasBeenSet = false;
158
159 MetadataConfiguration m_metadataConfiguration;
160 bool m_metadataConfigurationHasBeenSet = false;
161 };
162
163} // namespace Model
164} // namespace S3Vectors
165} // namespace Aws
void SetVectorBucketName(VectorBucketNameT &&value)
Definition Index.h:53
void SetDimension(int value)
Definition Index.h:111
AWS_S3VECTORS_API Index & operator=(Aws::Utils::Json::JsonView jsonValue)
void SetDistanceMetric(DistanceMetric value)
Definition Index.h:121
bool DistanceMetricHasBeenSet() const
Definition Index.h:120
const Aws::String & GetIndexName() const
Definition Index.h:62
void SetIndexName(IndexNameT &&value)
Definition Index.h:65
void SetIndexArn(IndexArnT &&value)
Definition Index.h:77
const Aws::String & GetVectorBucketName() const
Definition Index.h:50
Index & WithCreationTime(CreationTimeT &&value)
Definition Index.h:91
bool VectorBucketNameHasBeenSet() const
Definition Index.h:51
Index & WithDataType(DataType value)
Definition Index.h:101
Index & WithDistanceMetric(DistanceMetric value)
Definition Index.h:122
void SetMetadataConfiguration(MetadataConfigurationT &&value)
Definition Index.h:132
DataType GetDataType() const
Definition Index.h:98
bool DimensionHasBeenSet() const
Definition Index.h:110
bool IndexArnHasBeenSet() const
Definition Index.h:75
AWS_S3VECTORS_API Index()=default
AWS_S3VECTORS_API Aws::Utils::Json::JsonValue Jsonize() const
const Aws::String & GetIndexArn() const
Definition Index.h:74
Index & WithMetadataConfiguration(MetadataConfigurationT &&value)
Definition Index.h:134
Index & WithIndexArn(IndexArnT &&value)
Definition Index.h:79
bool IndexNameHasBeenSet() const
Definition Index.h:63
Index & WithVectorBucketName(VectorBucketNameT &&value)
Definition Index.h:55
AWS_S3VECTORS_API Index(Aws::Utils::Json::JsonView jsonValue)
bool DataTypeHasBeenSet() const
Definition Index.h:99
const MetadataConfiguration & GetMetadataConfiguration() const
Definition Index.h:129
Index & WithIndexName(IndexNameT &&value)
Definition Index.h:67
bool MetadataConfigurationHasBeenSet() const
Definition Index.h:130
void SetDataType(DataType value)
Definition Index.h:100
Index & WithDimension(int value)
Definition Index.h:112
const Aws::Utils::DateTime & GetCreationTime() const
Definition Index.h:86
bool CreationTimeHasBeenSet() const
Definition Index.h:87
DistanceMetric GetDistanceMetric() const
Definition Index.h:119
void SetCreationTime(CreationTimeT &&value)
Definition Index.h:89
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Aws::Utils::Json::JsonValue JsonValue