AWS SDK for C++

AWS SDK for C++ Version 1.11.930

Loading...
Searching...
No Matches
GetVectorsRequest.h
1
6#pragma once
7#include <aws/core/utils/memory/stl/AWSString.h>
8#include <aws/core/utils/memory/stl/AWSVector.h>
9#include <aws/s3vectors/S3VectorsRequest.h>
10#include <aws/s3vectors/S3Vectors_EXPORTS.h>
11
12#include <utility>
13
14namespace Aws {
15namespace S3Vectors {
16namespace Model {
17
21 public:
22 AWS_S3VECTORS_API GetVectorsRequest() = default;
23
24 // Service request name is the Operation name which will send this request out,
25 // each operation should has unique request name, so that we can get operation's name from this request.
26 // Note: this is not true for response, multiple operations may have the same response name,
27 // so we can not get operation's name from response.
28 inline virtual const char* GetServiceRequestName() const override { return "GetVectors"; }
29
30 AWS_S3VECTORS_API Aws::String SerializePayload() const override;
31
33
36 inline const Aws::String& GetVectorBucketName() const { return m_vectorBucketName; }
37 inline bool VectorBucketNameHasBeenSet() const { return m_vectorBucketNameHasBeenSet; }
38 template <typename VectorBucketNameT = Aws::String>
39 void SetVectorBucketName(VectorBucketNameT&& value) {
40 m_vectorBucketNameHasBeenSet = true;
41 m_vectorBucketName = std::forward<VectorBucketNameT>(value);
42 }
43 template <typename VectorBucketNameT = Aws::String>
44 GetVectorsRequest& WithVectorBucketName(VectorBucketNameT&& value) {
45 SetVectorBucketName(std::forward<VectorBucketNameT>(value));
46 return *this;
47 }
49
51
54 inline const Aws::String& GetIndexName() const { return m_indexName; }
55 inline bool IndexNameHasBeenSet() const { return m_indexNameHasBeenSet; }
56 template <typename IndexNameT = Aws::String>
57 void SetIndexName(IndexNameT&& value) {
58 m_indexNameHasBeenSet = true;
59 m_indexName = std::forward<IndexNameT>(value);
60 }
61 template <typename IndexNameT = Aws::String>
62 GetVectorsRequest& WithIndexName(IndexNameT&& value) {
63 SetIndexName(std::forward<IndexNameT>(value));
64 return *this;
65 }
67
69
72 inline const Aws::String& GetIndexArn() const { return m_indexArn; }
73 inline bool IndexArnHasBeenSet() const { return m_indexArnHasBeenSet; }
74 template <typename IndexArnT = Aws::String>
75 void SetIndexArn(IndexArnT&& value) {
76 m_indexArnHasBeenSet = true;
77 m_indexArn = std::forward<IndexArnT>(value);
78 }
79 template <typename IndexArnT = Aws::String>
80 GetVectorsRequest& WithIndexArn(IndexArnT&& value) {
81 SetIndexArn(std::forward<IndexArnT>(value));
82 return *this;
83 }
85
87
90 inline const Aws::Vector<Aws::String>& GetKeys() const { return m_keys; }
91 inline bool KeysHasBeenSet() const { return m_keysHasBeenSet; }
92 template <typename KeysT = Aws::Vector<Aws::String>>
93 void SetKeys(KeysT&& value) {
94 m_keysHasBeenSet = true;
95 m_keys = std::forward<KeysT>(value);
96 }
97 template <typename KeysT = Aws::Vector<Aws::String>>
98 GetVectorsRequest& WithKeys(KeysT&& value) {
99 SetKeys(std::forward<KeysT>(value));
100 return *this;
101 }
102 template <typename KeysT = Aws::String>
103 GetVectorsRequest& AddKeys(KeysT&& value) {
104 m_keysHasBeenSet = true;
105 m_keys.emplace_back(std::forward<KeysT>(value));
106 return *this;
107 }
109
111
115 inline bool GetReturnData() const { return m_returnData; }
116 inline bool ReturnDataHasBeenSet() const { return m_returnDataHasBeenSet; }
117 inline void SetReturnData(bool value) {
118 m_returnDataHasBeenSet = true;
119 m_returnData = value;
120 }
121 inline GetVectorsRequest& WithReturnData(bool value) {
122 SetReturnData(value);
123 return *this;
124 }
126
128
132 inline bool GetReturnMetadata() const { return m_returnMetadata; }
133 inline bool ReturnMetadataHasBeenSet() const { return m_returnMetadataHasBeenSet; }
134 inline void SetReturnMetadata(bool value) {
135 m_returnMetadataHasBeenSet = true;
136 m_returnMetadata = value;
137 }
139 SetReturnMetadata(value);
140 return *this;
141 }
143 private:
144 Aws::String m_vectorBucketName;
145
146 Aws::String m_indexName;
147
148 Aws::String m_indexArn;
149
151
152 bool m_returnData{false};
153
154 bool m_returnMetadata{false};
155 bool m_vectorBucketNameHasBeenSet = false;
156 bool m_indexNameHasBeenSet = false;
157 bool m_indexArnHasBeenSet = false;
158 bool m_keysHasBeenSet = false;
159 bool m_returnDataHasBeenSet = false;
160 bool m_returnMetadataHasBeenSet = false;
161};
162
163} // namespace Model
164} // namespace S3Vectors
165} // namespace Aws
AWS_S3VECTORS_API Aws::String SerializePayload() const override
void SetVectorBucketName(VectorBucketNameT &&value)
GetVectorsRequest & AddKeys(KeysT &&value)
const Aws::String & GetVectorBucketName() const
virtual const char * GetServiceRequestName() const override
AWS_S3VECTORS_API GetVectorsRequest()=default
GetVectorsRequest & WithVectorBucketName(VectorBucketNameT &&value)
const Aws::String & GetIndexName() const
GetVectorsRequest & WithIndexArn(IndexArnT &&value)
const Aws::Vector< Aws::String > & GetKeys() const
GetVectorsRequest & WithIndexName(IndexNameT &&value)
const Aws::String & GetIndexArn() const
GetVectorsRequest & WithKeys(KeysT &&value)
GetVectorsRequest & WithReturnData(bool value)
GetVectorsRequest & WithReturnMetadata(bool value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector