AWS SDK for C++  1.9.158
AWS SDK for C++
ListCandidatesForAutoMLJobRequest.h
Go to the documentation of this file.
1 
6 #pragma once
13 #include <utility>
14 
15 namespace Aws
16 {
17 namespace SageMaker
18 {
19 namespace Model
20 {
21 
25  {
26  public:
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 "ListCandidatesForAutoMLJob"; }
34 
35  Aws::String SerializePayload() const override;
36 
38 
39 
43  inline const Aws::String& GetAutoMLJobName() const{ return m_autoMLJobName; }
44 
48  inline bool AutoMLJobNameHasBeenSet() const { return m_autoMLJobNameHasBeenSet; }
49 
53  inline void SetAutoMLJobName(const Aws::String& value) { m_autoMLJobNameHasBeenSet = true; m_autoMLJobName = value; }
54 
58  inline void SetAutoMLJobName(Aws::String&& value) { m_autoMLJobNameHasBeenSet = true; m_autoMLJobName = std::move(value); }
59 
63  inline void SetAutoMLJobName(const char* value) { m_autoMLJobNameHasBeenSet = true; m_autoMLJobName.assign(value); }
64 
68  inline ListCandidatesForAutoMLJobRequest& WithAutoMLJobName(const Aws::String& value) { SetAutoMLJobName(value); return *this;}
69 
73  inline ListCandidatesForAutoMLJobRequest& WithAutoMLJobName(Aws::String&& value) { SetAutoMLJobName(std::move(value)); return *this;}
74 
78  inline ListCandidatesForAutoMLJobRequest& WithAutoMLJobName(const char* value) { SetAutoMLJobName(value); return *this;}
79 
80 
84  inline const CandidateStatus& GetStatusEquals() const{ return m_statusEquals; }
85 
89  inline bool StatusEqualsHasBeenSet() const { return m_statusEqualsHasBeenSet; }
90 
94  inline void SetStatusEquals(const CandidateStatus& value) { m_statusEqualsHasBeenSet = true; m_statusEquals = value; }
95 
99  inline void SetStatusEquals(CandidateStatus&& value) { m_statusEqualsHasBeenSet = true; m_statusEquals = std::move(value); }
100 
104  inline ListCandidatesForAutoMLJobRequest& WithStatusEquals(const CandidateStatus& value) { SetStatusEquals(value); return *this;}
105 
109  inline ListCandidatesForAutoMLJobRequest& WithStatusEquals(CandidateStatus&& value) { SetStatusEquals(std::move(value)); return *this;}
110 
111 
115  inline const Aws::String& GetCandidateNameEquals() const{ return m_candidateNameEquals; }
116 
120  inline bool CandidateNameEqualsHasBeenSet() const { return m_candidateNameEqualsHasBeenSet; }
121 
125  inline void SetCandidateNameEquals(const Aws::String& value) { m_candidateNameEqualsHasBeenSet = true; m_candidateNameEquals = value; }
126 
130  inline void SetCandidateNameEquals(Aws::String&& value) { m_candidateNameEqualsHasBeenSet = true; m_candidateNameEquals = std::move(value); }
131 
135  inline void SetCandidateNameEquals(const char* value) { m_candidateNameEqualsHasBeenSet = true; m_candidateNameEquals.assign(value); }
136 
140  inline ListCandidatesForAutoMLJobRequest& WithCandidateNameEquals(const Aws::String& value) { SetCandidateNameEquals(value); return *this;}
141 
145  inline ListCandidatesForAutoMLJobRequest& WithCandidateNameEquals(Aws::String&& value) { SetCandidateNameEquals(std::move(value)); return *this;}
146 
150  inline ListCandidatesForAutoMLJobRequest& WithCandidateNameEquals(const char* value) { SetCandidateNameEquals(value); return *this;}
151 
152 
156  inline const AutoMLSortOrder& GetSortOrder() const{ return m_sortOrder; }
157 
161  inline bool SortOrderHasBeenSet() const { return m_sortOrderHasBeenSet; }
162 
166  inline void SetSortOrder(const AutoMLSortOrder& value) { m_sortOrderHasBeenSet = true; m_sortOrder = value; }
167 
171  inline void SetSortOrder(AutoMLSortOrder&& value) { m_sortOrderHasBeenSet = true; m_sortOrder = std::move(value); }
172 
176  inline ListCandidatesForAutoMLJobRequest& WithSortOrder(const AutoMLSortOrder& value) { SetSortOrder(value); return *this;}
177 
181  inline ListCandidatesForAutoMLJobRequest& WithSortOrder(AutoMLSortOrder&& value) { SetSortOrder(std::move(value)); return *this;}
182 
183 
188  inline const CandidateSortBy& GetSortBy() const{ return m_sortBy; }
189 
194  inline bool SortByHasBeenSet() const { return m_sortByHasBeenSet; }
195 
200  inline void SetSortBy(const CandidateSortBy& value) { m_sortByHasBeenSet = true; m_sortBy = value; }
201 
206  inline void SetSortBy(CandidateSortBy&& value) { m_sortByHasBeenSet = true; m_sortBy = std::move(value); }
207 
212  inline ListCandidatesForAutoMLJobRequest& WithSortBy(const CandidateSortBy& value) { SetSortBy(value); return *this;}
213 
218  inline ListCandidatesForAutoMLJobRequest& WithSortBy(CandidateSortBy&& value) { SetSortBy(std::move(value)); return *this;}
219 
220 
224  inline int GetMaxResults() const{ return m_maxResults; }
225 
229  inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
230 
234  inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
235 
239  inline ListCandidatesForAutoMLJobRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
240 
241 
246  inline const Aws::String& GetNextToken() const{ return m_nextToken; }
247 
252  inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
253 
258  inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
259 
264  inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
265 
270  inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
271 
276  inline ListCandidatesForAutoMLJobRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
277 
282  inline ListCandidatesForAutoMLJobRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
283 
288  inline ListCandidatesForAutoMLJobRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
289 
290  private:
291 
292  Aws::String m_autoMLJobName;
293  bool m_autoMLJobNameHasBeenSet;
294 
295  CandidateStatus m_statusEquals;
296  bool m_statusEqualsHasBeenSet;
297 
298  Aws::String m_candidateNameEquals;
299  bool m_candidateNameEqualsHasBeenSet;
300 
301  AutoMLSortOrder m_sortOrder;
302  bool m_sortOrderHasBeenSet;
303 
304  CandidateSortBy m_sortBy;
305  bool m_sortByHasBeenSet;
306 
307  int m_maxResults;
308  bool m_maxResultsHasBeenSet;
309 
310  Aws::String m_nextToken;
311  bool m_nextTokenHasBeenSet;
312  };
313 
314 } // namespace Model
315 } // namespace SageMaker
316 } // namespace Aws
Aws::SavingsPlans::Model::SavingsPlanProductType::NOT_SET
@ NOT_SET
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithAutoMLJobName
ListCandidatesForAutoMLJobRequest & WithAutoMLJobName(const Aws::String &value)
Definition: ListCandidatesForAutoMLJobRequest.h:68
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::CandidateNameEqualsHasBeenSet
bool CandidateNameEqualsHasBeenSet() const
Definition: ListCandidatesForAutoMLJobRequest.h:120
Aws::SageMaker::Model::CandidateSortBy
CandidateSortBy
Definition: CandidateSortBy.h:17
SageMaker_EXPORTS.h
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::GetSortOrder
const AutoMLSortOrder & GetSortOrder() const
Definition: ListCandidatesForAutoMLJobRequest.h:156
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithCandidateNameEquals
ListCandidatesForAutoMLJobRequest & WithCandidateNameEquals(const Aws::String &value)
Definition: ListCandidatesForAutoMLJobRequest.h:140
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::GetAutoMLJobName
const Aws::String & GetAutoMLJobName() const
Definition: ListCandidatesForAutoMLJobRequest.h:43
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::GetStatusEquals
const CandidateStatus & GetStatusEquals() const
Definition: ListCandidatesForAutoMLJobRequest.h:84
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SortOrderHasBeenSet
bool SortOrderHasBeenSet() const
Definition: ListCandidatesForAutoMLJobRequest.h:161
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetNextToken
void SetNextToken(const char *value)
Definition: ListCandidatesForAutoMLJobRequest.h:270
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetCandidateNameEquals
void SetCandidateNameEquals(const char *value)
Definition: ListCandidatesForAutoMLJobRequest.h:135
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithNextToken
ListCandidatesForAutoMLJobRequest & WithNextToken(const Aws::String &value)
Definition: ListCandidatesForAutoMLJobRequest.h:276
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::MaxResultsHasBeenSet
bool MaxResultsHasBeenSet() const
Definition: ListCandidatesForAutoMLJobRequest.h:229
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithMaxResults
ListCandidatesForAutoMLJobRequest & WithMaxResults(int value)
Definition: ListCandidatesForAutoMLJobRequest.h:239
CandidateSortBy.h
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::GetCandidateNameEquals
const Aws::String & GetCandidateNameEquals() const
Definition: ListCandidatesForAutoMLJobRequest.h:115
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithSortBy
ListCandidatesForAutoMLJobRequest & WithSortBy(CandidateSortBy &&value)
Definition: ListCandidatesForAutoMLJobRequest.h:218
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::ListCandidatesForAutoMLJobRequest
ListCandidatesForAutoMLJobRequest()
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetStatusEquals
void SetStatusEquals(const CandidateStatus &value)
Definition: ListCandidatesForAutoMLJobRequest.h:94
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetCandidateNameEquals
void SetCandidateNameEquals(Aws::String &&value)
Definition: ListCandidatesForAutoMLJobRequest.h:130
Aws::SageMaker::SageMakerRequest
Definition: SageMakerRequest.h:17
AWS_SAGEMAKER_API
#define AWS_SAGEMAKER_API
Definition: SageMaker_EXPORTS.h:28
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetSortOrder
void SetSortOrder(AutoMLSortOrder &&value)
Definition: ListCandidatesForAutoMLJobRequest.h:171
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithAutoMLJobName
ListCandidatesForAutoMLJobRequest & WithAutoMLJobName(const char *value)
Definition: ListCandidatesForAutoMLJobRequest.h:78
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetAutoMLJobName
void SetAutoMLJobName(const Aws::String &value)
Definition: ListCandidatesForAutoMLJobRequest.h:53
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithAutoMLJobName
ListCandidatesForAutoMLJobRequest & WithAutoMLJobName(Aws::String &&value)
Definition: ListCandidatesForAutoMLJobRequest.h:73
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetNextToken
void SetNextToken(Aws::String &&value)
Definition: ListCandidatesForAutoMLJobRequest.h:264
AWSString.h
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::GetSortBy
const CandidateSortBy & GetSortBy() const
Definition: ListCandidatesForAutoMLJobRequest.h:188
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: ListCandidatesForAutoMLJobRequest.h:33
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SortByHasBeenSet
bool SortByHasBeenSet() const
Definition: ListCandidatesForAutoMLJobRequest.h:194
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::StatusEqualsHasBeenSet
bool StatusEqualsHasBeenSet() const
Definition: ListCandidatesForAutoMLJobRequest.h:89
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::AutoMLJobNameHasBeenSet
bool AutoMLJobNameHasBeenSet() const
Definition: ListCandidatesForAutoMLJobRequest.h:48
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithStatusEquals
ListCandidatesForAutoMLJobRequest & WithStatusEquals(const CandidateStatus &value)
Definition: ListCandidatesForAutoMLJobRequest.h:104
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetAutoMLJobName
void SetAutoMLJobName(const char *value)
Definition: ListCandidatesForAutoMLJobRequest.h:63
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithCandidateNameEquals
ListCandidatesForAutoMLJobRequest & WithCandidateNameEquals(const char *value)
Definition: ListCandidatesForAutoMLJobRequest.h:150
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithSortBy
ListCandidatesForAutoMLJobRequest & WithSortBy(const CandidateSortBy &value)
Definition: ListCandidatesForAutoMLJobRequest.h:212
AutoMLSortOrder.h
CandidateStatus.h
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetMaxResults
void SetMaxResults(int value)
Definition: ListCandidatesForAutoMLJobRequest.h:234
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetStatusEquals
void SetStatusEquals(CandidateStatus &&value)
Definition: ListCandidatesForAutoMLJobRequest.h:99
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithSortOrder
ListCandidatesForAutoMLJobRequest & WithSortOrder(AutoMLSortOrder &&value)
Definition: ListCandidatesForAutoMLJobRequest.h:181
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithNextToken
ListCandidatesForAutoMLJobRequest & WithNextToken(const char *value)
Definition: ListCandidatesForAutoMLJobRequest.h:288
Aws
Definition: AccessManagementClient.h:15
Aws::SageMaker::Model::CandidateStatus
CandidateStatus
Definition: CandidateStatus.h:17
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithSortOrder
ListCandidatesForAutoMLJobRequest & WithSortOrder(const AutoMLSortOrder &value)
Definition: ListCandidatesForAutoMLJobRequest.h:176
SageMakerRequest.h
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetSortBy
void SetSortBy(const CandidateSortBy &value)
Definition: ListCandidatesForAutoMLJobRequest.h:200
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithNextToken
ListCandidatesForAutoMLJobRequest & WithNextToken(Aws::String &&value)
Definition: ListCandidatesForAutoMLJobRequest.h:282
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithStatusEquals
ListCandidatesForAutoMLJobRequest & WithStatusEquals(CandidateStatus &&value)
Definition: ListCandidatesForAutoMLJobRequest.h:109
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetAutoMLJobName
void SetAutoMLJobName(Aws::String &&value)
Definition: ListCandidatesForAutoMLJobRequest.h:58
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetCandidateNameEquals
void SetCandidateNameEquals(const Aws::String &value)
Definition: ListCandidatesForAutoMLJobRequest.h:125
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::GetNextToken
const Aws::String & GetNextToken() const
Definition: ListCandidatesForAutoMLJobRequest.h:246
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest
Definition: ListCandidatesForAutoMLJobRequest.h:25
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetSortBy
void SetSortBy(CandidateSortBy &&value)
Definition: ListCandidatesForAutoMLJobRequest.h:206
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::NextTokenHasBeenSet
bool NextTokenHasBeenSet() const
Definition: ListCandidatesForAutoMLJobRequest.h:252
Aws::SageMaker::Model::AutoMLSortOrder
AutoMLSortOrder
Definition: AutoMLSortOrder.h:17
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::GetMaxResults
int GetMaxResults() const
Definition: ListCandidatesForAutoMLJobRequest.h:224
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetNextToken
void SetNextToken(const Aws::String &value)
Definition: ListCandidatesForAutoMLJobRequest.h:258
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::SetSortOrder
void SetSortOrder(const AutoMLSortOrder &value)
Definition: ListCandidatesForAutoMLJobRequest.h:166
Aws::SageMaker::Model::ListCandidatesForAutoMLJobRequest::WithCandidateNameEquals
ListCandidatesForAutoMLJobRequest & WithCandidateNameEquals(Aws::String &&value)
Definition: ListCandidatesForAutoMLJobRequest.h:145