AWS SDK for C++

AWS SDK for C++ Version 1.11.612

Loading...
Searching...
No Matches
HyperParameterTrainingJobSummary.h
1
6#pragma once
7#include <aws/sagemaker/SageMaker_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/DateTime.h>
10#include <aws/sagemaker/model/TrainingJobStatus.h>
11#include <aws/core/utils/memory/stl/AWSMap.h>
12#include <aws/sagemaker/model/FinalHyperParameterTuningJobObjectiveMetric.h>
13#include <aws/sagemaker/model/ObjectiveStatus.h>
14#include <utility>
15
16namespace Aws
17{
18namespace Utils
19{
20namespace Json
21{
22 class JsonValue;
23 class JsonView;
24} // namespace Json
25} // namespace Utils
26namespace SageMaker
27{
28namespace Model
29{
30
38 {
39 public:
40 AWS_SAGEMAKER_API HyperParameterTrainingJobSummary() = default;
43 AWS_SAGEMAKER_API Aws::Utils::Json::JsonValue Jsonize() const;
44
45
47
50 inline const Aws::String& GetTrainingJobDefinitionName() const { return m_trainingJobDefinitionName; }
51 inline bool TrainingJobDefinitionNameHasBeenSet() const { return m_trainingJobDefinitionNameHasBeenSet; }
52 template<typename TrainingJobDefinitionNameT = Aws::String>
53 void SetTrainingJobDefinitionName(TrainingJobDefinitionNameT&& value) { m_trainingJobDefinitionNameHasBeenSet = true; m_trainingJobDefinitionName = std::forward<TrainingJobDefinitionNameT>(value); }
54 template<typename TrainingJobDefinitionNameT = Aws::String>
55 HyperParameterTrainingJobSummary& WithTrainingJobDefinitionName(TrainingJobDefinitionNameT&& value) { SetTrainingJobDefinitionName(std::forward<TrainingJobDefinitionNameT>(value)); return *this;}
57
59
62 inline const Aws::String& GetTrainingJobName() const { return m_trainingJobName; }
63 inline bool TrainingJobNameHasBeenSet() const { return m_trainingJobNameHasBeenSet; }
64 template<typename TrainingJobNameT = Aws::String>
65 void SetTrainingJobName(TrainingJobNameT&& value) { m_trainingJobNameHasBeenSet = true; m_trainingJobName = std::forward<TrainingJobNameT>(value); }
66 template<typename TrainingJobNameT = Aws::String>
67 HyperParameterTrainingJobSummary& WithTrainingJobName(TrainingJobNameT&& value) { SetTrainingJobName(std::forward<TrainingJobNameT>(value)); return *this;}
69
71
74 inline const Aws::String& GetTrainingJobArn() const { return m_trainingJobArn; }
75 inline bool TrainingJobArnHasBeenSet() const { return m_trainingJobArnHasBeenSet; }
76 template<typename TrainingJobArnT = Aws::String>
77 void SetTrainingJobArn(TrainingJobArnT&& value) { m_trainingJobArnHasBeenSet = true; m_trainingJobArn = std::forward<TrainingJobArnT>(value); }
78 template<typename TrainingJobArnT = Aws::String>
79 HyperParameterTrainingJobSummary& WithTrainingJobArn(TrainingJobArnT&& value) { SetTrainingJobArn(std::forward<TrainingJobArnT>(value)); return *this;}
81
83
86 inline const Aws::String& GetTuningJobName() const { return m_tuningJobName; }
87 inline bool TuningJobNameHasBeenSet() const { return m_tuningJobNameHasBeenSet; }
88 template<typename TuningJobNameT = Aws::String>
89 void SetTuningJobName(TuningJobNameT&& value) { m_tuningJobNameHasBeenSet = true; m_tuningJobName = std::forward<TuningJobNameT>(value); }
90 template<typename TuningJobNameT = Aws::String>
91 HyperParameterTrainingJobSummary& WithTuningJobName(TuningJobNameT&& value) { SetTuningJobName(std::forward<TuningJobNameT>(value)); return *this;}
93
95
98 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
99 inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; }
100 template<typename CreationTimeT = Aws::Utils::DateTime>
101 void SetCreationTime(CreationTimeT&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::forward<CreationTimeT>(value); }
102 template<typename CreationTimeT = Aws::Utils::DateTime>
103 HyperParameterTrainingJobSummary& WithCreationTime(CreationTimeT&& value) { SetCreationTime(std::forward<CreationTimeT>(value)); return *this;}
105
107
110 inline const Aws::Utils::DateTime& GetTrainingStartTime() const { return m_trainingStartTime; }
111 inline bool TrainingStartTimeHasBeenSet() const { return m_trainingStartTimeHasBeenSet; }
112 template<typename TrainingStartTimeT = Aws::Utils::DateTime>
113 void SetTrainingStartTime(TrainingStartTimeT&& value) { m_trainingStartTimeHasBeenSet = true; m_trainingStartTime = std::forward<TrainingStartTimeT>(value); }
114 template<typename TrainingStartTimeT = Aws::Utils::DateTime>
115 HyperParameterTrainingJobSummary& WithTrainingStartTime(TrainingStartTimeT&& value) { SetTrainingStartTime(std::forward<TrainingStartTimeT>(value)); return *this;}
117
119
126 inline const Aws::Utils::DateTime& GetTrainingEndTime() const { return m_trainingEndTime; }
127 inline bool TrainingEndTimeHasBeenSet() const { return m_trainingEndTimeHasBeenSet; }
128 template<typename TrainingEndTimeT = Aws::Utils::DateTime>
129 void SetTrainingEndTime(TrainingEndTimeT&& value) { m_trainingEndTimeHasBeenSet = true; m_trainingEndTime = std::forward<TrainingEndTimeT>(value); }
130 template<typename TrainingEndTimeT = Aws::Utils::DateTime>
131 HyperParameterTrainingJobSummary& WithTrainingEndTime(TrainingEndTimeT&& value) { SetTrainingEndTime(std::forward<TrainingEndTimeT>(value)); return *this;}
133
135
138 inline TrainingJobStatus GetTrainingJobStatus() const { return m_trainingJobStatus; }
139 inline bool TrainingJobStatusHasBeenSet() const { return m_trainingJobStatusHasBeenSet; }
140 inline void SetTrainingJobStatus(TrainingJobStatus value) { m_trainingJobStatusHasBeenSet = true; m_trainingJobStatus = value; }
143
145
148 inline const Aws::Map<Aws::String, Aws::String>& GetTunedHyperParameters() const { return m_tunedHyperParameters; }
149 inline bool TunedHyperParametersHasBeenSet() const { return m_tunedHyperParametersHasBeenSet; }
150 template<typename TunedHyperParametersT = Aws::Map<Aws::String, Aws::String>>
151 void SetTunedHyperParameters(TunedHyperParametersT&& value) { m_tunedHyperParametersHasBeenSet = true; m_tunedHyperParameters = std::forward<TunedHyperParametersT>(value); }
152 template<typename TunedHyperParametersT = Aws::Map<Aws::String, Aws::String>>
153 HyperParameterTrainingJobSummary& WithTunedHyperParameters(TunedHyperParametersT&& value) { SetTunedHyperParameters(std::forward<TunedHyperParametersT>(value)); return *this;}
154 template<typename TunedHyperParametersKeyT = Aws::String, typename TunedHyperParametersValueT = Aws::String>
155 HyperParameterTrainingJobSummary& AddTunedHyperParameters(TunedHyperParametersKeyT&& key, TunedHyperParametersValueT&& value) {
156 m_tunedHyperParametersHasBeenSet = true; m_tunedHyperParameters.emplace(std::forward<TunedHyperParametersKeyT>(key), std::forward<TunedHyperParametersValueT>(value)); return *this;
157 }
159
161
164 inline const Aws::String& GetFailureReason() const { return m_failureReason; }
165 inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; }
166 template<typename FailureReasonT = Aws::String>
167 void SetFailureReason(FailureReasonT&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::forward<FailureReasonT>(value); }
168 template<typename FailureReasonT = Aws::String>
169 HyperParameterTrainingJobSummary& WithFailureReason(FailureReasonT&& value) { SetFailureReason(std::forward<FailureReasonT>(value)); return *this;}
171
173
179 inline const FinalHyperParameterTuningJobObjectiveMetric& GetFinalHyperParameterTuningJobObjectiveMetric() const { return m_finalHyperParameterTuningJobObjectiveMetric; }
180 inline bool FinalHyperParameterTuningJobObjectiveMetricHasBeenSet() const { return m_finalHyperParameterTuningJobObjectiveMetricHasBeenSet; }
181 template<typename FinalHyperParameterTuningJobObjectiveMetricT = FinalHyperParameterTuningJobObjectiveMetric>
182 void SetFinalHyperParameterTuningJobObjectiveMetric(FinalHyperParameterTuningJobObjectiveMetricT&& value) { m_finalHyperParameterTuningJobObjectiveMetricHasBeenSet = true; m_finalHyperParameterTuningJobObjectiveMetric = std::forward<FinalHyperParameterTuningJobObjectiveMetricT>(value); }
183 template<typename FinalHyperParameterTuningJobObjectiveMetricT = FinalHyperParameterTuningJobObjectiveMetric>
184 HyperParameterTrainingJobSummary& WithFinalHyperParameterTuningJobObjectiveMetric(FinalHyperParameterTuningJobObjectiveMetricT&& value) { SetFinalHyperParameterTuningJobObjectiveMetric(std::forward<FinalHyperParameterTuningJobObjectiveMetricT>(value)); return *this;}
186
188
198 inline ObjectiveStatus GetObjectiveStatus() const { return m_objectiveStatus; }
199 inline bool ObjectiveStatusHasBeenSet() const { return m_objectiveStatusHasBeenSet; }
200 inline void SetObjectiveStatus(ObjectiveStatus value) { m_objectiveStatusHasBeenSet = true; m_objectiveStatus = value; }
203 private:
204
205 Aws::String m_trainingJobDefinitionName;
206 bool m_trainingJobDefinitionNameHasBeenSet = false;
207
208 Aws::String m_trainingJobName;
209 bool m_trainingJobNameHasBeenSet = false;
210
211 Aws::String m_trainingJobArn;
212 bool m_trainingJobArnHasBeenSet = false;
213
214 Aws::String m_tuningJobName;
215 bool m_tuningJobNameHasBeenSet = false;
216
217 Aws::Utils::DateTime m_creationTime{};
218 bool m_creationTimeHasBeenSet = false;
219
220 Aws::Utils::DateTime m_trainingStartTime{};
221 bool m_trainingStartTimeHasBeenSet = false;
222
223 Aws::Utils::DateTime m_trainingEndTime{};
224 bool m_trainingEndTimeHasBeenSet = false;
225
227 bool m_trainingJobStatusHasBeenSet = false;
228
229 Aws::Map<Aws::String, Aws::String> m_tunedHyperParameters;
230 bool m_tunedHyperParametersHasBeenSet = false;
231
232 Aws::String m_failureReason;
233 bool m_failureReasonHasBeenSet = false;
234
235 FinalHyperParameterTuningJobObjectiveMetric m_finalHyperParameterTuningJobObjectiveMetric;
236 bool m_finalHyperParameterTuningJobObjectiveMetricHasBeenSet = false;
237
238 ObjectiveStatus m_objectiveStatus{ObjectiveStatus::NOT_SET};
239 bool m_objectiveStatusHasBeenSet = false;
240 };
241
242} // namespace Model
243} // namespace SageMaker
244} // namespace Aws
HyperParameterTrainingJobSummary & WithTrainingStartTime(TrainingStartTimeT &&value)
AWS_SAGEMAKER_API Aws::Utils::Json::JsonValue Jsonize() const
HyperParameterTrainingJobSummary & WithTrainingJobName(TrainingJobNameT &&value)
HyperParameterTrainingJobSummary & WithTrainingJobArn(TrainingJobArnT &&value)
HyperParameterTrainingJobSummary & WithFailureReason(FailureReasonT &&value)
AWS_SAGEMAKER_API HyperParameterTrainingJobSummary & operator=(Aws::Utils::Json::JsonView jsonValue)
const FinalHyperParameterTuningJobObjectiveMetric & GetFinalHyperParameterTuningJobObjectiveMetric() const
HyperParameterTrainingJobSummary & WithObjectiveStatus(ObjectiveStatus value)
HyperParameterTrainingJobSummary & WithTrainingJobDefinitionName(TrainingJobDefinitionNameT &&value)
HyperParameterTrainingJobSummary & WithTuningJobName(TuningJobNameT &&value)
const Aws::Map< Aws::String, Aws::String > & GetTunedHyperParameters() const
HyperParameterTrainingJobSummary & AddTunedHyperParameters(TunedHyperParametersKeyT &&key, TunedHyperParametersValueT &&value)
AWS_SAGEMAKER_API HyperParameterTrainingJobSummary()=default
AWS_SAGEMAKER_API HyperParameterTrainingJobSummary(Aws::Utils::Json::JsonView jsonValue)
HyperParameterTrainingJobSummary & WithTrainingEndTime(TrainingEndTimeT &&value)
HyperParameterTrainingJobSummary & WithFinalHyperParameterTuningJobObjectiveMetric(FinalHyperParameterTuningJobObjectiveMetricT &&value)
HyperParameterTrainingJobSummary & WithTrainingJobStatus(TrainingJobStatus value)
HyperParameterTrainingJobSummary & WithTunedHyperParameters(TunedHyperParametersT &&value)
HyperParameterTrainingJobSummary & WithCreationTime(CreationTimeT &&value)
void SetFinalHyperParameterTuningJobObjectiveMetric(FinalHyperParameterTuningJobObjectiveMetricT &&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
Aws::Utils::Json::JsonValue JsonValue