AWS SDK for C++

AWS SDK for C++ Version 1.11.847

Loading...
Searching...
No Matches
GetProfileRecommendationsRequest.h
1
6#pragma once
7#include <aws/core/utils/memory/stl/AWSMap.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/customer-profiles/CustomerProfilesRequest.h>
11#include <aws/customer-profiles/CustomerProfiles_EXPORTS.h>
12#include <aws/customer-profiles/model/MetadataConfig.h>
13#include <aws/customer-profiles/model/RecommendationDiversityConfig.h>
14#include <aws/customer-profiles/model/RecommenderFilter.h>
15#include <aws/customer-profiles/model/RecommenderPromotionalFilter.h>
16
17#include <utility>
18
19namespace Aws {
20namespace CustomerProfiles {
21namespace Model {
22
26 public:
27 AWS_CUSTOMERPROFILES_API GetProfileRecommendationsRequest() = default;
28
29 // Service request name is the Operation name which will send this request out,
30 // each operation should has unique request name, so that we can get operation's name from this request.
31 // Note: this is not true for response, multiple operations may have the same response name,
32 // so we can not get operation's name from response.
33 inline virtual const char* GetServiceRequestName() const override { return "GetProfileRecommendations"; }
34
35 AWS_CUSTOMERPROFILES_API Aws::String SerializePayload() const override;
36
38
41 inline const Aws::String& GetDomainName() const { return m_domainName; }
42 inline bool DomainNameHasBeenSet() const { return m_domainNameHasBeenSet; }
43 template <typename DomainNameT = Aws::String>
44 void SetDomainName(DomainNameT&& value) {
45 m_domainNameHasBeenSet = true;
46 m_domainName = std::forward<DomainNameT>(value);
47 }
48 template <typename DomainNameT = Aws::String>
50 SetDomainName(std::forward<DomainNameT>(value));
51 return *this;
52 }
54
56
60 inline const Aws::String& GetProfileId() const { return m_profileId; }
61 inline bool ProfileIdHasBeenSet() const { return m_profileIdHasBeenSet; }
62 template <typename ProfileIdT = Aws::String>
63 void SetProfileId(ProfileIdT&& value) {
64 m_profileIdHasBeenSet = true;
65 m_profileId = std::forward<ProfileIdT>(value);
66 }
67 template <typename ProfileIdT = Aws::String>
69 SetProfileId(std::forward<ProfileIdT>(value));
70 return *this;
71 }
73
75
78 inline const Aws::String& GetRecommenderName() const { return m_recommenderName; }
79 inline bool RecommenderNameHasBeenSet() const { return m_recommenderNameHasBeenSet; }
80 template <typename RecommenderNameT = Aws::String>
81 void SetRecommenderName(RecommenderNameT&& value) {
82 m_recommenderNameHasBeenSet = true;
83 m_recommenderName = std::forward<RecommenderNameT>(value);
84 }
85 template <typename RecommenderNameT = Aws::String>
87 SetRecommenderName(std::forward<RecommenderNameT>(value));
88 return *this;
89 }
91
93
97 inline const Aws::Map<Aws::String, Aws::String>& GetContext() const { return m_context; }
98 inline bool ContextHasBeenSet() const { return m_contextHasBeenSet; }
99 template <typename ContextT = Aws::Map<Aws::String, Aws::String>>
100 void SetContext(ContextT&& value) {
101 m_contextHasBeenSet = true;
102 m_context = std::forward<ContextT>(value);
103 }
104 template <typename ContextT = Aws::Map<Aws::String, Aws::String>>
106 SetContext(std::forward<ContextT>(value));
107 return *this;
108 }
109 template <typename ContextKeyT = Aws::String, typename ContextValueT = Aws::String>
110 GetProfileRecommendationsRequest& AddContext(ContextKeyT&& key, ContextValueT&& value) {
111 m_contextHasBeenSet = true;
112 m_context.emplace(std::forward<ContextKeyT>(key), std::forward<ContextValueT>(value));
113 return *this;
114 }
116
118
122 inline const Aws::Vector<RecommenderFilter>& GetRecommenderFilters() const { return m_recommenderFilters; }
123 inline bool RecommenderFiltersHasBeenSet() const { return m_recommenderFiltersHasBeenSet; }
124 template <typename RecommenderFiltersT = Aws::Vector<RecommenderFilter>>
125 void SetRecommenderFilters(RecommenderFiltersT&& value) {
126 m_recommenderFiltersHasBeenSet = true;
127 m_recommenderFilters = std::forward<RecommenderFiltersT>(value);
128 }
129 template <typename RecommenderFiltersT = Aws::Vector<RecommenderFilter>>
131 SetRecommenderFilters(std::forward<RecommenderFiltersT>(value));
132 return *this;
133 }
134 template <typename RecommenderFiltersT = RecommenderFilter>
136 m_recommenderFiltersHasBeenSet = true;
137 m_recommenderFilters.emplace_back(std::forward<RecommenderFiltersT>(value));
138 return *this;
139 }
141
143
149 return m_recommenderPromotionalFilters;
150 }
151 inline bool RecommenderPromotionalFiltersHasBeenSet() const { return m_recommenderPromotionalFiltersHasBeenSet; }
152 template <typename RecommenderPromotionalFiltersT = Aws::Vector<RecommenderPromotionalFilter>>
153 void SetRecommenderPromotionalFilters(RecommenderPromotionalFiltersT&& value) {
154 m_recommenderPromotionalFiltersHasBeenSet = true;
155 m_recommenderPromotionalFilters = std::forward<RecommenderPromotionalFiltersT>(value);
156 }
157 template <typename RecommenderPromotionalFiltersT = Aws::Vector<RecommenderPromotionalFilter>>
159 SetRecommenderPromotionalFilters(std::forward<RecommenderPromotionalFiltersT>(value));
160 return *this;
161 }
162 template <typename RecommenderPromotionalFiltersT = RecommenderPromotionalFilter>
164 m_recommenderPromotionalFiltersHasBeenSet = true;
165 m_recommenderPromotionalFilters.emplace_back(std::forward<RecommenderPromotionalFiltersT>(value));
166 return *this;
167 }
169
171
176 inline const Aws::Vector<Aws::String>& GetCandidateIds() const { return m_candidateIds; }
177 inline bool CandidateIdsHasBeenSet() const { return m_candidateIdsHasBeenSet; }
178 template <typename CandidateIdsT = Aws::Vector<Aws::String>>
179 void SetCandidateIds(CandidateIdsT&& value) {
180 m_candidateIdsHasBeenSet = true;
181 m_candidateIds = std::forward<CandidateIdsT>(value);
182 }
183 template <typename CandidateIdsT = Aws::Vector<Aws::String>>
185 SetCandidateIds(std::forward<CandidateIdsT>(value));
186 return *this;
187 }
188 template <typename CandidateIdsT = Aws::String>
190 m_candidateIdsHasBeenSet = true;
191 m_candidateIds.emplace_back(std::forward<CandidateIdsT>(value));
192 return *this;
193 }
195
197
200 inline int GetMaxResults() const { return m_maxResults; }
201 inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
202 inline void SetMaxResults(int value) {
203 m_maxResultsHasBeenSet = true;
204 m_maxResults = value;
205 }
207 SetMaxResults(value);
208 return *this;
209 }
211
213
218 inline const MetadataConfig& GetMetadataConfig() const { return m_metadataConfig; }
219 inline bool MetadataConfigHasBeenSet() const { return m_metadataConfigHasBeenSet; }
220 template <typename MetadataConfigT = MetadataConfig>
221 void SetMetadataConfig(MetadataConfigT&& value) {
222 m_metadataConfigHasBeenSet = true;
223 m_metadataConfig = std::forward<MetadataConfigT>(value);
224 }
225 template <typename MetadataConfigT = MetadataConfig>
227 SetMetadataConfig(std::forward<MetadataConfigT>(value));
228 return *this;
229 }
231
233
238 inline const RecommendationDiversityConfig& GetDiversityConfig() const { return m_diversityConfig; }
239 inline bool DiversityConfigHasBeenSet() const { return m_diversityConfigHasBeenSet; }
240 template <typename DiversityConfigT = RecommendationDiversityConfig>
241 void SetDiversityConfig(DiversityConfigT&& value) {
242 m_diversityConfigHasBeenSet = true;
243 m_diversityConfig = std::forward<DiversityConfigT>(value);
244 }
245 template <typename DiversityConfigT = RecommendationDiversityConfig>
247 SetDiversityConfig(std::forward<DiversityConfigT>(value));
248 return *this;
249 }
251 private:
252 Aws::String m_domainName;
253
254 Aws::String m_profileId;
255
256 Aws::String m_recommenderName;
257
259
260 Aws::Vector<RecommenderFilter> m_recommenderFilters;
261
262 Aws::Vector<RecommenderPromotionalFilter> m_recommenderPromotionalFilters;
263
264 Aws::Vector<Aws::String> m_candidateIds;
265
266 int m_maxResults{0};
267
268 MetadataConfig m_metadataConfig;
269
270 RecommendationDiversityConfig m_diversityConfig;
271 bool m_domainNameHasBeenSet = false;
272 bool m_profileIdHasBeenSet = false;
273 bool m_recommenderNameHasBeenSet = false;
274 bool m_contextHasBeenSet = false;
275 bool m_recommenderFiltersHasBeenSet = false;
276 bool m_recommenderPromotionalFiltersHasBeenSet = false;
277 bool m_candidateIdsHasBeenSet = false;
278 bool m_maxResultsHasBeenSet = false;
279 bool m_metadataConfigHasBeenSet = false;
280 bool m_diversityConfigHasBeenSet = false;
281};
282
283} // namespace Model
284} // namespace CustomerProfiles
285} // namespace Aws
GetProfileRecommendationsRequest & AddRecommenderFilters(RecommenderFiltersT &&value)
GetProfileRecommendationsRequest & AddContext(ContextKeyT &&key, ContextValueT &&value)
AWS_CUSTOMERPROFILES_API GetProfileRecommendationsRequest()=default
GetProfileRecommendationsRequest & WithProfileId(ProfileIdT &&value)
AWS_CUSTOMERPROFILES_API Aws::String SerializePayload() const override
GetProfileRecommendationsRequest & WithRecommenderFilters(RecommenderFiltersT &&value)
GetProfileRecommendationsRequest & AddCandidateIds(CandidateIdsT &&value)
GetProfileRecommendationsRequest & WithMetadataConfig(MetadataConfigT &&value)
const Aws::Vector< RecommenderPromotionalFilter > & GetRecommenderPromotionalFilters() const
GetProfileRecommendationsRequest & AddRecommenderPromotionalFilters(RecommenderPromotionalFiltersT &&value)
GetProfileRecommendationsRequest & WithRecommenderPromotionalFilters(RecommenderPromotionalFiltersT &&value)
const Aws::Map< Aws::String, Aws::String > & GetContext() const
GetProfileRecommendationsRequest & WithCandidateIds(CandidateIdsT &&value)
GetProfileRecommendationsRequest & WithDomainName(DomainNameT &&value)
GetProfileRecommendationsRequest & WithDiversityConfig(DiversityConfigT &&value)
GetProfileRecommendationsRequest & WithRecommenderName(RecommenderNameT &&value)
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector