AWS SDK for C++

AWS SDK for C++ Version 1.11.607

Loading...
Searching...
No Matches
DescribePredictorResult.h
1
6#pragma once
7#include <aws/forecast/ForecastService_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/forecast/model/AutoMLOverrideStrategy.h>
11#include <aws/core/utils/memory/stl/AWSMap.h>
12#include <aws/forecast/model/EvaluationParameters.h>
13#include <aws/forecast/model/HyperParameterTuningJobConfig.h>
14#include <aws/forecast/model/InputDataConfig.h>
15#include <aws/forecast/model/FeaturizationConfig.h>
16#include <aws/forecast/model/EncryptionConfig.h>
17#include <aws/forecast/model/PredictorExecutionDetails.h>
18#include <aws/core/utils/DateTime.h>
19#include <aws/forecast/model/OptimizationMetric.h>
20#include <utility>
21
22namespace Aws
23{
24template<typename RESULT_TYPE>
25class AmazonWebServiceResult;
26
27namespace Utils
28{
29namespace Json
30{
31 class JsonValue;
32} // namespace Json
33} // namespace Utils
34namespace ForecastService
35{
36namespace Model
37{
39 {
40 public:
41 AWS_FORECASTSERVICE_API DescribePredictorResult() = default;
44
45
47
50 inline const Aws::String& GetPredictorArn() const { return m_predictorArn; }
51 template<typename PredictorArnT = Aws::String>
52 void SetPredictorArn(PredictorArnT&& value) { m_predictorArnHasBeenSet = true; m_predictorArn = std::forward<PredictorArnT>(value); }
53 template<typename PredictorArnT = Aws::String>
54 DescribePredictorResult& WithPredictorArn(PredictorArnT&& value) { SetPredictorArn(std::forward<PredictorArnT>(value)); return *this;}
56
58
61 inline const Aws::String& GetPredictorName() const { return m_predictorName; }
62 template<typename PredictorNameT = Aws::String>
63 void SetPredictorName(PredictorNameT&& value) { m_predictorNameHasBeenSet = true; m_predictorName = std::forward<PredictorNameT>(value); }
64 template<typename PredictorNameT = Aws::String>
65 DescribePredictorResult& WithPredictorName(PredictorNameT&& value) { SetPredictorName(std::forward<PredictorNameT>(value)); return *this;}
67
69
72 inline const Aws::String& GetAlgorithmArn() const { return m_algorithmArn; }
73 template<typename AlgorithmArnT = Aws::String>
74 void SetAlgorithmArn(AlgorithmArnT&& value) { m_algorithmArnHasBeenSet = true; m_algorithmArn = std::forward<AlgorithmArnT>(value); }
75 template<typename AlgorithmArnT = Aws::String>
76 DescribePredictorResult& WithAlgorithmArn(AlgorithmArnT&& value) { SetAlgorithmArn(std::forward<AlgorithmArnT>(value)); return *this;}
78
80
84 inline const Aws::Vector<Aws::String>& GetAutoMLAlgorithmArns() const { return m_autoMLAlgorithmArns; }
85 template<typename AutoMLAlgorithmArnsT = Aws::Vector<Aws::String>>
86 void SetAutoMLAlgorithmArns(AutoMLAlgorithmArnsT&& value) { m_autoMLAlgorithmArnsHasBeenSet = true; m_autoMLAlgorithmArns = std::forward<AutoMLAlgorithmArnsT>(value); }
87 template<typename AutoMLAlgorithmArnsT = Aws::Vector<Aws::String>>
88 DescribePredictorResult& WithAutoMLAlgorithmArns(AutoMLAlgorithmArnsT&& value) { SetAutoMLAlgorithmArns(std::forward<AutoMLAlgorithmArnsT>(value)); return *this;}
89 template<typename AutoMLAlgorithmArnsT = Aws::String>
90 DescribePredictorResult& AddAutoMLAlgorithmArns(AutoMLAlgorithmArnsT&& value) { m_autoMLAlgorithmArnsHasBeenSet = true; m_autoMLAlgorithmArns.emplace_back(std::forward<AutoMLAlgorithmArnsT>(value)); return *this; }
92
94
98 inline int GetForecastHorizon() const { return m_forecastHorizon; }
99 inline void SetForecastHorizon(int value) { m_forecastHorizonHasBeenSet = true; m_forecastHorizon = value; }
100 inline DescribePredictorResult& WithForecastHorizon(int value) { SetForecastHorizon(value); return *this;}
102
104
108 inline const Aws::Vector<Aws::String>& GetForecastTypes() const { return m_forecastTypes; }
109 template<typename ForecastTypesT = Aws::Vector<Aws::String>>
110 void SetForecastTypes(ForecastTypesT&& value) { m_forecastTypesHasBeenSet = true; m_forecastTypes = std::forward<ForecastTypesT>(value); }
111 template<typename ForecastTypesT = Aws::Vector<Aws::String>>
112 DescribePredictorResult& WithForecastTypes(ForecastTypesT&& value) { SetForecastTypes(std::forward<ForecastTypesT>(value)); return *this;}
113 template<typename ForecastTypesT = Aws::String>
114 DescribePredictorResult& AddForecastTypes(ForecastTypesT&& value) { m_forecastTypesHasBeenSet = true; m_forecastTypes.emplace_back(std::forward<ForecastTypesT>(value)); return *this; }
116
118
121 inline bool GetPerformAutoML() const { return m_performAutoML; }
122 inline void SetPerformAutoML(bool value) { m_performAutoMLHasBeenSet = true; m_performAutoML = value; }
123 inline DescribePredictorResult& WithPerformAutoML(bool value) { SetPerformAutoML(value); return *this;}
125
127
135 inline AutoMLOverrideStrategy GetAutoMLOverrideStrategy() const { return m_autoMLOverrideStrategy; }
136 inline void SetAutoMLOverrideStrategy(AutoMLOverrideStrategy value) { m_autoMLOverrideStrategyHasBeenSet = true; m_autoMLOverrideStrategy = value; }
139
141
145 inline bool GetPerformHPO() const { return m_performHPO; }
146 inline void SetPerformHPO(bool value) { m_performHPOHasBeenSet = true; m_performHPO = value; }
147 inline DescribePredictorResult& WithPerformHPO(bool value) { SetPerformHPO(value); return *this;}
149
151
157 inline const Aws::Map<Aws::String, Aws::String>& GetTrainingParameters() const { return m_trainingParameters; }
158 template<typename TrainingParametersT = Aws::Map<Aws::String, Aws::String>>
159 void SetTrainingParameters(TrainingParametersT&& value) { m_trainingParametersHasBeenSet = true; m_trainingParameters = std::forward<TrainingParametersT>(value); }
160 template<typename TrainingParametersT = Aws::Map<Aws::String, Aws::String>>
161 DescribePredictorResult& WithTrainingParameters(TrainingParametersT&& value) { SetTrainingParameters(std::forward<TrainingParametersT>(value)); return *this;}
162 template<typename TrainingParametersKeyT = Aws::String, typename TrainingParametersValueT = Aws::String>
163 DescribePredictorResult& AddTrainingParameters(TrainingParametersKeyT&& key, TrainingParametersValueT&& value) {
164 m_trainingParametersHasBeenSet = true; m_trainingParameters.emplace(std::forward<TrainingParametersKeyT>(key), std::forward<TrainingParametersValueT>(value)); return *this;
165 }
167
169
175 inline const EvaluationParameters& GetEvaluationParameters() const { return m_evaluationParameters; }
176 template<typename EvaluationParametersT = EvaluationParameters>
177 void SetEvaluationParameters(EvaluationParametersT&& value) { m_evaluationParametersHasBeenSet = true; m_evaluationParameters = std::forward<EvaluationParametersT>(value); }
178 template<typename EvaluationParametersT = EvaluationParameters>
179 DescribePredictorResult& WithEvaluationParameters(EvaluationParametersT&& value) { SetEvaluationParameters(std::forward<EvaluationParametersT>(value)); return *this;}
181
183
186 inline const HyperParameterTuningJobConfig& GetHPOConfig() const { return m_hPOConfig; }
187 template<typename HPOConfigT = HyperParameterTuningJobConfig>
188 void SetHPOConfig(HPOConfigT&& value) { m_hPOConfigHasBeenSet = true; m_hPOConfig = std::forward<HPOConfigT>(value); }
189 template<typename HPOConfigT = HyperParameterTuningJobConfig>
190 DescribePredictorResult& WithHPOConfig(HPOConfigT&& value) { SetHPOConfig(std::forward<HPOConfigT>(value)); return *this;}
192
194
198 inline const InputDataConfig& GetInputDataConfig() const { return m_inputDataConfig; }
199 template<typename InputDataConfigT = InputDataConfig>
200 void SetInputDataConfig(InputDataConfigT&& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = std::forward<InputDataConfigT>(value); }
201 template<typename InputDataConfigT = InputDataConfig>
202 DescribePredictorResult& WithInputDataConfig(InputDataConfigT&& value) { SetInputDataConfig(std::forward<InputDataConfigT>(value)); return *this;}
204
206
209 inline const FeaturizationConfig& GetFeaturizationConfig() const { return m_featurizationConfig; }
210 template<typename FeaturizationConfigT = FeaturizationConfig>
211 void SetFeaturizationConfig(FeaturizationConfigT&& value) { m_featurizationConfigHasBeenSet = true; m_featurizationConfig = std::forward<FeaturizationConfigT>(value); }
212 template<typename FeaturizationConfigT = FeaturizationConfig>
213 DescribePredictorResult& WithFeaturizationConfig(FeaturizationConfigT&& value) { SetFeaturizationConfig(std::forward<FeaturizationConfigT>(value)); return *this;}
215
217
221 inline const EncryptionConfig& GetEncryptionConfig() const { return m_encryptionConfig; }
222 template<typename EncryptionConfigT = EncryptionConfig>
223 void SetEncryptionConfig(EncryptionConfigT&& value) { m_encryptionConfigHasBeenSet = true; m_encryptionConfig = std::forward<EncryptionConfigT>(value); }
224 template<typename EncryptionConfigT = EncryptionConfig>
225 DescribePredictorResult& WithEncryptionConfig(EncryptionConfigT&& value) { SetEncryptionConfig(std::forward<EncryptionConfigT>(value)); return *this;}
227
229
234 inline const PredictorExecutionDetails& GetPredictorExecutionDetails() const { return m_predictorExecutionDetails; }
235 template<typename PredictorExecutionDetailsT = PredictorExecutionDetails>
236 void SetPredictorExecutionDetails(PredictorExecutionDetailsT&& value) { m_predictorExecutionDetailsHasBeenSet = true; m_predictorExecutionDetails = std::forward<PredictorExecutionDetailsT>(value); }
237 template<typename PredictorExecutionDetailsT = PredictorExecutionDetails>
238 DescribePredictorResult& WithPredictorExecutionDetails(PredictorExecutionDetailsT&& value) { SetPredictorExecutionDetails(std::forward<PredictorExecutionDetailsT>(value)); return *this;}
240
242
246 inline long long GetEstimatedTimeRemainingInMinutes() const { return m_estimatedTimeRemainingInMinutes; }
247 inline void SetEstimatedTimeRemainingInMinutes(long long value) { m_estimatedTimeRemainingInMinutesHasBeenSet = true; m_estimatedTimeRemainingInMinutes = value; }
250
252
255 inline bool GetIsAutoPredictor() const { return m_isAutoPredictor; }
256 inline void SetIsAutoPredictor(bool value) { m_isAutoPredictorHasBeenSet = true; m_isAutoPredictor = value; }
257 inline DescribePredictorResult& WithIsAutoPredictor(bool value) { SetIsAutoPredictor(value); return *this;}
259
261
265 inline const Aws::Vector<Aws::String>& GetDatasetImportJobArns() const { return m_datasetImportJobArns; }
266 template<typename DatasetImportJobArnsT = Aws::Vector<Aws::String>>
267 void SetDatasetImportJobArns(DatasetImportJobArnsT&& value) { m_datasetImportJobArnsHasBeenSet = true; m_datasetImportJobArns = std::forward<DatasetImportJobArnsT>(value); }
268 template<typename DatasetImportJobArnsT = Aws::Vector<Aws::String>>
269 DescribePredictorResult& WithDatasetImportJobArns(DatasetImportJobArnsT&& value) { SetDatasetImportJobArns(std::forward<DatasetImportJobArnsT>(value)); return *this;}
270 template<typename DatasetImportJobArnsT = Aws::String>
271 DescribePredictorResult& AddDatasetImportJobArns(DatasetImportJobArnsT&& value) { m_datasetImportJobArnsHasBeenSet = true; m_datasetImportJobArns.emplace_back(std::forward<DatasetImportJobArnsT>(value)); return *this; }
273
275
285 inline const Aws::String& GetStatus() const { return m_status; }
286 template<typename StatusT = Aws::String>
287 void SetStatus(StatusT&& value) { m_statusHasBeenSet = true; m_status = std::forward<StatusT>(value); }
288 template<typename StatusT = Aws::String>
289 DescribePredictorResult& WithStatus(StatusT&& value) { SetStatus(std::forward<StatusT>(value)); return *this;}
291
293
296 inline const Aws::String& GetMessage() const { return m_message; }
297 template<typename MessageT = Aws::String>
298 void SetMessage(MessageT&& value) { m_messageHasBeenSet = true; m_message = std::forward<MessageT>(value); }
299 template<typename MessageT = Aws::String>
300 DescribePredictorResult& WithMessage(MessageT&& value) { SetMessage(std::forward<MessageT>(value)); return *this;}
302
304
307 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
308 template<typename CreationTimeT = Aws::Utils::DateTime>
309 void SetCreationTime(CreationTimeT&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::forward<CreationTimeT>(value); }
310 template<typename CreationTimeT = Aws::Utils::DateTime>
311 DescribePredictorResult& WithCreationTime(CreationTimeT&& value) { SetCreationTime(std::forward<CreationTimeT>(value)); return *this;}
313
315
324 inline const Aws::Utils::DateTime& GetLastModificationTime() const { return m_lastModificationTime; }
325 template<typename LastModificationTimeT = Aws::Utils::DateTime>
326 void SetLastModificationTime(LastModificationTimeT&& value) { m_lastModificationTimeHasBeenSet = true; m_lastModificationTime = std::forward<LastModificationTimeT>(value); }
327 template<typename LastModificationTimeT = Aws::Utils::DateTime>
328 DescribePredictorResult& WithLastModificationTime(LastModificationTimeT&& value) { SetLastModificationTime(std::forward<LastModificationTimeT>(value)); return *this;}
330
332
335 inline OptimizationMetric GetOptimizationMetric() const { return m_optimizationMetric; }
336 inline void SetOptimizationMetric(OptimizationMetric value) { m_optimizationMetricHasBeenSet = true; m_optimizationMetric = value; }
339
341
342 inline const Aws::String& GetRequestId() const { return m_requestId; }
343 template<typename RequestIdT = Aws::String>
344 void SetRequestId(RequestIdT&& value) { m_requestIdHasBeenSet = true; m_requestId = std::forward<RequestIdT>(value); }
345 template<typename RequestIdT = Aws::String>
346 DescribePredictorResult& WithRequestId(RequestIdT&& value) { SetRequestId(std::forward<RequestIdT>(value)); return *this;}
348 private:
349
350 Aws::String m_predictorArn;
351 bool m_predictorArnHasBeenSet = false;
352
353 Aws::String m_predictorName;
354 bool m_predictorNameHasBeenSet = false;
355
356 Aws::String m_algorithmArn;
357 bool m_algorithmArnHasBeenSet = false;
358
359 Aws::Vector<Aws::String> m_autoMLAlgorithmArns;
360 bool m_autoMLAlgorithmArnsHasBeenSet = false;
361
362 int m_forecastHorizon{0};
363 bool m_forecastHorizonHasBeenSet = false;
364
365 Aws::Vector<Aws::String> m_forecastTypes;
366 bool m_forecastTypesHasBeenSet = false;
367
368 bool m_performAutoML{false};
369 bool m_performAutoMLHasBeenSet = false;
370
372 bool m_autoMLOverrideStrategyHasBeenSet = false;
373
374 bool m_performHPO{false};
375 bool m_performHPOHasBeenSet = false;
376
377 Aws::Map<Aws::String, Aws::String> m_trainingParameters;
378 bool m_trainingParametersHasBeenSet = false;
379
380 EvaluationParameters m_evaluationParameters;
381 bool m_evaluationParametersHasBeenSet = false;
382
383 HyperParameterTuningJobConfig m_hPOConfig;
384 bool m_hPOConfigHasBeenSet = false;
385
386 InputDataConfig m_inputDataConfig;
387 bool m_inputDataConfigHasBeenSet = false;
388
389 FeaturizationConfig m_featurizationConfig;
390 bool m_featurizationConfigHasBeenSet = false;
391
392 EncryptionConfig m_encryptionConfig;
393 bool m_encryptionConfigHasBeenSet = false;
394
395 PredictorExecutionDetails m_predictorExecutionDetails;
396 bool m_predictorExecutionDetailsHasBeenSet = false;
397
398 long long m_estimatedTimeRemainingInMinutes{0};
399 bool m_estimatedTimeRemainingInMinutesHasBeenSet = false;
400
401 bool m_isAutoPredictor{false};
402 bool m_isAutoPredictorHasBeenSet = false;
403
404 Aws::Vector<Aws::String> m_datasetImportJobArns;
405 bool m_datasetImportJobArnsHasBeenSet = false;
406
407 Aws::String m_status;
408 bool m_statusHasBeenSet = false;
409
410 Aws::String m_message;
411 bool m_messageHasBeenSet = false;
412
413 Aws::Utils::DateTime m_creationTime{};
414 bool m_creationTimeHasBeenSet = false;
415
416 Aws::Utils::DateTime m_lastModificationTime{};
417 bool m_lastModificationTimeHasBeenSet = false;
418
420 bool m_optimizationMetricHasBeenSet = false;
421
422 Aws::String m_requestId;
423 bool m_requestIdHasBeenSet = false;
424 };
425
426} // namespace Model
427} // namespace ForecastService
428} // namespace Aws
DescribePredictorResult & WithCreationTime(CreationTimeT &&value)
const Aws::Vector< Aws::String > & GetAutoMLAlgorithmArns() const
DescribePredictorResult & WithStatus(StatusT &&value)
DescribePredictorResult & WithDatasetImportJobArns(DatasetImportJobArnsT &&value)
const Aws::Vector< Aws::String > & GetDatasetImportJobArns() const
DescribePredictorResult & WithLastModificationTime(LastModificationTimeT &&value)
AWS_FORECASTSERVICE_API DescribePredictorResult()=default
DescribePredictorResult & WithInputDataConfig(InputDataConfigT &&value)
DescribePredictorResult & WithAlgorithmArn(AlgorithmArnT &&value)
const HyperParameterTuningJobConfig & GetHPOConfig() const
DescribePredictorResult & WithIsAutoPredictor(bool value)
DescribePredictorResult & AddTrainingParameters(TrainingParametersKeyT &&key, TrainingParametersValueT &&value)
DescribePredictorResult & WithEvaluationParameters(EvaluationParametersT &&value)
DescribePredictorResult & WithRequestId(RequestIdT &&value)
DescribePredictorResult & WithEstimatedTimeRemainingInMinutes(long long value)
DescribePredictorResult & AddAutoMLAlgorithmArns(AutoMLAlgorithmArnsT &&value)
DescribePredictorResult & AddForecastTypes(ForecastTypesT &&value)
AWS_FORECASTSERVICE_API DescribePredictorResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribePredictorResult & WithPredictorArn(PredictorArnT &&value)
DescribePredictorResult & WithAutoMLOverrideStrategy(AutoMLOverrideStrategy value)
void SetPredictorExecutionDetails(PredictorExecutionDetailsT &&value)
const Aws::Map< Aws::String, Aws::String > & GetTrainingParameters() const
const EvaluationParameters & GetEvaluationParameters() const
DescribePredictorResult & WithFeaturizationConfig(FeaturizationConfigT &&value)
DescribePredictorResult & WithTrainingParameters(TrainingParametersT &&value)
DescribePredictorResult & WithPredictorExecutionDetails(PredictorExecutionDetailsT &&value)
DescribePredictorResult & WithHPOConfig(HPOConfigT &&value)
DescribePredictorResult & WithAutoMLAlgorithmArns(AutoMLAlgorithmArnsT &&value)
DescribePredictorResult & WithOptimizationMetric(OptimizationMetric value)
DescribePredictorResult & WithPredictorName(PredictorNameT &&value)
DescribePredictorResult & WithForecastTypes(ForecastTypesT &&value)
DescribePredictorResult & WithMessage(MessageT &&value)
const PredictorExecutionDetails & GetPredictorExecutionDetails() const
const Aws::Vector< Aws::String > & GetForecastTypes() const
DescribePredictorResult & WithEncryptionConfig(EncryptionConfigT &&value)
DescribePredictorResult & AddDatasetImportJobArns(DatasetImportJobArnsT &&value)
AWS_FORECASTSERVICE_API DescribePredictorResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
const Aws::Utils::DateTime & GetLastModificationTime() const
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
Aws::Utils::Json::JsonValue JsonValue