AWS SDK for C++  1.9.40
AWS SDK for C++
ListTrainingJobsForHyperParameterTuningJobRequest.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 "ListTrainingJobsForHyperParameterTuningJob"; }
34 
35  Aws::String SerializePayload() const override;
36 
38 
39 
43  inline const Aws::String& GetHyperParameterTuningJobName() const{ return m_hyperParameterTuningJobName; }
44 
48  inline bool HyperParameterTuningJobNameHasBeenSet() const { return m_hyperParameterTuningJobNameHasBeenSet; }
49 
53  inline void SetHyperParameterTuningJobName(const Aws::String& value) { m_hyperParameterTuningJobNameHasBeenSet = true; m_hyperParameterTuningJobName = value; }
54 
58  inline void SetHyperParameterTuningJobName(Aws::String&& value) { m_hyperParameterTuningJobNameHasBeenSet = true; m_hyperParameterTuningJobName = std::move(value); }
59 
63  inline void SetHyperParameterTuningJobName(const char* value) { m_hyperParameterTuningJobNameHasBeenSet = true; m_hyperParameterTuningJobName.assign(value); }
64 
68  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithHyperParameterTuningJobName(const Aws::String& value) { SetHyperParameterTuningJobName(value); return *this;}
69 
73  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithHyperParameterTuningJobName(Aws::String&& value) { SetHyperParameterTuningJobName(std::move(value)); return *this;}
74 
78  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithHyperParameterTuningJobName(const char* value) { SetHyperParameterTuningJobName(value); return *this;}
79 
80 
87  inline const Aws::String& GetNextToken() const{ return m_nextToken; }
88 
95  inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
96 
103  inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
104 
111  inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
112 
119  inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
120 
127  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
128 
135  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
136 
143  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
144 
145 
149  inline int GetMaxResults() const{ return m_maxResults; }
150 
154  inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
155 
159  inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
160 
164  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
165 
166 
170  inline const TrainingJobStatus& GetStatusEquals() const{ return m_statusEquals; }
171 
175  inline bool StatusEqualsHasBeenSet() const { return m_statusEqualsHasBeenSet; }
176 
180  inline void SetStatusEquals(const TrainingJobStatus& value) { m_statusEqualsHasBeenSet = true; m_statusEquals = value; }
181 
185  inline void SetStatusEquals(TrainingJobStatus&& value) { m_statusEqualsHasBeenSet = true; m_statusEquals = std::move(value); }
186 
190  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithStatusEquals(const TrainingJobStatus& value) { SetStatusEquals(value); return *this;}
191 
195  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithStatusEquals(TrainingJobStatus&& value) { SetStatusEquals(std::move(value)); return *this;}
196 
197 
203  inline const TrainingJobSortByOptions& GetSortBy() const{ return m_sortBy; }
204 
210  inline bool SortByHasBeenSet() const { return m_sortByHasBeenSet; }
211 
217  inline void SetSortBy(const TrainingJobSortByOptions& value) { m_sortByHasBeenSet = true; m_sortBy = value; }
218 
224  inline void SetSortBy(TrainingJobSortByOptions&& value) { m_sortByHasBeenSet = true; m_sortBy = std::move(value); }
225 
231  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithSortBy(const TrainingJobSortByOptions& value) { SetSortBy(value); return *this;}
232 
238  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithSortBy(TrainingJobSortByOptions&& value) { SetSortBy(std::move(value)); return *this;}
239 
240 
244  inline const SortOrder& GetSortOrder() const{ return m_sortOrder; }
245 
249  inline bool SortOrderHasBeenSet() const { return m_sortOrderHasBeenSet; }
250 
254  inline void SetSortOrder(const SortOrder& value) { m_sortOrderHasBeenSet = true; m_sortOrder = value; }
255 
259  inline void SetSortOrder(SortOrder&& value) { m_sortOrderHasBeenSet = true; m_sortOrder = std::move(value); }
260 
264  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithSortOrder(const SortOrder& value) { SetSortOrder(value); return *this;}
265 
269  inline ListTrainingJobsForHyperParameterTuningJobRequest& WithSortOrder(SortOrder&& value) { SetSortOrder(std::move(value)); return *this;}
270 
271  private:
272 
273  Aws::String m_hyperParameterTuningJobName;
274  bool m_hyperParameterTuningJobNameHasBeenSet;
275 
276  Aws::String m_nextToken;
277  bool m_nextTokenHasBeenSet;
278 
279  int m_maxResults;
280  bool m_maxResultsHasBeenSet;
281 
282  TrainingJobStatus m_statusEquals;
283  bool m_statusEqualsHasBeenSet;
284 
285  TrainingJobSortByOptions m_sortBy;
286  bool m_sortByHasBeenSet;
287 
288  SortOrder m_sortOrder;
289  bool m_sortOrderHasBeenSet;
290  };
291 
292 } // namespace Model
293 } // namespace SageMaker
294 } // namespace Aws
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithSortBy
ListTrainingJobsForHyperParameterTuningJobRequest & WithSortBy(TrainingJobSortByOptions &&value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:238
Aws::SavingsPlans::Model::SavingsPlanProductType::NOT_SET
@ NOT_SET
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetSortOrder
void SetSortOrder(SortOrder &&value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:259
TrainingJobSortByOptions.h
SageMaker_EXPORTS.h
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::NextTokenHasBeenSet
bool NextTokenHasBeenSet() const
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:95
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::SageMaker::Model::SortOrder
SortOrder
Definition: SortOrder.h:17
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetSortBy
void SetSortBy(const TrainingJobSortByOptions &value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:217
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetNextToken
const Aws::String & GetNextToken() const
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:87
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetMaxResults
void SetMaxResults(int value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:159
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithSortOrder
ListTrainingJobsForHyperParameterTuningJobRequest & WithSortOrder(const SortOrder &value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:264
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetHyperParameterTuningJobName
void SetHyperParameterTuningJobName(Aws::String &&value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:58
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetNextToken
void SetNextToken(const char *value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:119
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetSortBy
const TrainingJobSortByOptions & GetSortBy() const
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:203
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SortByHasBeenSet
bool SortByHasBeenSet() const
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:210
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetNextToken
void SetNextToken(Aws::String &&value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:111
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::StatusEqualsHasBeenSet
bool StatusEqualsHasBeenSet() const
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:175
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetStatusEquals
const TrainingJobStatus & GetStatusEquals() const
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:170
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::MaxResultsHasBeenSet
bool MaxResultsHasBeenSet() const
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:154
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithHyperParameterTuningJobName
ListTrainingJobsForHyperParameterTuningJobRequest & WithHyperParameterTuningJobName(Aws::String &&value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:73
Aws::SageMaker::SageMakerRequest
Definition: SageMakerRequest.h:17
SortOrder.h
AWS_SAGEMAKER_API
#define AWS_SAGEMAKER_API
Definition: SageMaker_EXPORTS.h:28
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetSortBy
void SetSortBy(TrainingJobSortByOptions &&value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:224
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithNextToken
ListTrainingJobsForHyperParameterTuningJobRequest & WithNextToken(const Aws::String &value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:127
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetHyperParameterTuningJobName
void SetHyperParameterTuningJobName(const char *value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:63
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::HyperParameterTuningJobNameHasBeenSet
bool HyperParameterTuningJobNameHasBeenSet() const
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:48
Aws::SageMaker::Model::TrainingJobSortByOptions
TrainingJobSortByOptions
Definition: TrainingJobSortByOptions.h:17
TrainingJobStatus.h
AWSString.h
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetNextToken
void SetNextToken(const Aws::String &value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:103
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithMaxResults
ListTrainingJobsForHyperParameterTuningJobRequest & WithMaxResults(int value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:164
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetStatusEquals
void SetStatusEquals(const TrainingJobStatus &value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:180
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetMaxResults
int GetMaxResults() const
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:149
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SortOrderHasBeenSet
bool SortOrderHasBeenSet() const
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:249
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithHyperParameterTuningJobName
ListTrainingJobsForHyperParameterTuningJobRequest & WithHyperParameterTuningJobName(const char *value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:78
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetSortOrder
void SetSortOrder(const SortOrder &value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:254
Aws::SageMaker::Model::TrainingJobStatus
TrainingJobStatus
Definition: TrainingJobStatus.h:17
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:33
Aws
Definition: AccessManagementClient.h:15
SageMakerRequest.h
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithNextToken
ListTrainingJobsForHyperParameterTuningJobRequest & WithNextToken(Aws::String &&value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:135
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetSortOrder
const SortOrder & GetSortOrder() const
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:244
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithSortOrder
ListTrainingJobsForHyperParameterTuningJobRequest & WithSortOrder(SortOrder &&value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:269
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetStatusEquals
void SetStatusEquals(TrainingJobStatus &&value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:185
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithSortBy
ListTrainingJobsForHyperParameterTuningJobRequest & WithSortBy(const TrainingJobSortByOptions &value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:231
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::ListTrainingJobsForHyperParameterTuningJobRequest
ListTrainingJobsForHyperParameterTuningJobRequest()
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithStatusEquals
ListTrainingJobsForHyperParameterTuningJobRequest & WithStatusEquals(TrainingJobStatus &&value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:195
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithNextToken
ListTrainingJobsForHyperParameterTuningJobRequest & WithNextToken(const char *value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:143
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::SetHyperParameterTuningJobName
void SetHyperParameterTuningJobName(const Aws::String &value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:53
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithHyperParameterTuningJobName
ListTrainingJobsForHyperParameterTuningJobRequest & WithHyperParameterTuningJobName(const Aws::String &value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:68
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:25
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::GetHyperParameterTuningJobName
const Aws::String & GetHyperParameterTuningJobName() const
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:43
Aws::SageMaker::Model::ListTrainingJobsForHyperParameterTuningJobRequest::WithStatusEquals
ListTrainingJobsForHyperParameterTuningJobRequest & WithStatusEquals(const TrainingJobStatus &value)
Definition: ListTrainingJobsForHyperParameterTuningJobRequest.h:190