AWS SDK for C++  1.9.154
AWS SDK for C++
HyperParameterSpecification.h
Go to the documentation of this file.
1 
6 #pragma once
11 #include <utility>
12 
13 namespace Aws
14 {
15 namespace Utils
16 {
17 namespace Json
18 {
19  class JsonValue;
20  class JsonView;
21 } // namespace Json
22 } // namespace Utils
23 namespace SageMaker
24 {
25 namespace Model
26 {
27 
35  {
36  public:
41 
42 
46  inline const Aws::String& GetName() const{ return m_name; }
47 
51  inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
52 
56  inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
57 
61  inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
62 
66  inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
67 
71  inline HyperParameterSpecification& WithName(const Aws::String& value) { SetName(value); return *this;}
72 
76  inline HyperParameterSpecification& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
77 
81  inline HyperParameterSpecification& WithName(const char* value) { SetName(value); return *this;}
82 
83 
87  inline const Aws::String& GetDescription() const{ return m_description; }
88 
92  inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
93 
97  inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
98 
102  inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
103 
107  inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
108 
112  inline HyperParameterSpecification& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
113 
117  inline HyperParameterSpecification& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
118 
122  inline HyperParameterSpecification& WithDescription(const char* value) { SetDescription(value); return *this;}
123 
124 
130  inline const ParameterType& GetType() const{ return m_type; }
131 
137  inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; }
138 
144  inline void SetType(const ParameterType& value) { m_typeHasBeenSet = true; m_type = value; }
145 
151  inline void SetType(ParameterType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); }
152 
158  inline HyperParameterSpecification& WithType(const ParameterType& value) { SetType(value); return *this;}
159 
165  inline HyperParameterSpecification& WithType(ParameterType&& value) { SetType(std::move(value)); return *this;}
166 
167 
171  inline const ParameterRange& GetRange() const{ return m_range; }
172 
176  inline bool RangeHasBeenSet() const { return m_rangeHasBeenSet; }
177 
181  inline void SetRange(const ParameterRange& value) { m_rangeHasBeenSet = true; m_range = value; }
182 
186  inline void SetRange(ParameterRange&& value) { m_rangeHasBeenSet = true; m_range = std::move(value); }
187 
191  inline HyperParameterSpecification& WithRange(const ParameterRange& value) { SetRange(value); return *this;}
192 
196  inline HyperParameterSpecification& WithRange(ParameterRange&& value) { SetRange(std::move(value)); return *this;}
197 
198 
203  inline bool GetIsTunable() const{ return m_isTunable; }
204 
209  inline bool IsTunableHasBeenSet() const { return m_isTunableHasBeenSet; }
210 
215  inline void SetIsTunable(bool value) { m_isTunableHasBeenSet = true; m_isTunable = value; }
216 
221  inline HyperParameterSpecification& WithIsTunable(bool value) { SetIsTunable(value); return *this;}
222 
223 
227  inline bool GetIsRequired() const{ return m_isRequired; }
228 
232  inline bool IsRequiredHasBeenSet() const { return m_isRequiredHasBeenSet; }
233 
237  inline void SetIsRequired(bool value) { m_isRequiredHasBeenSet = true; m_isRequired = value; }
238 
242  inline HyperParameterSpecification& WithIsRequired(bool value) { SetIsRequired(value); return *this;}
243 
244 
249  inline const Aws::String& GetDefaultValue() const{ return m_defaultValue; }
250 
255  inline bool DefaultValueHasBeenSet() const { return m_defaultValueHasBeenSet; }
256 
261  inline void SetDefaultValue(const Aws::String& value) { m_defaultValueHasBeenSet = true; m_defaultValue = value; }
262 
267  inline void SetDefaultValue(Aws::String&& value) { m_defaultValueHasBeenSet = true; m_defaultValue = std::move(value); }
268 
273  inline void SetDefaultValue(const char* value) { m_defaultValueHasBeenSet = true; m_defaultValue.assign(value); }
274 
279  inline HyperParameterSpecification& WithDefaultValue(const Aws::String& value) { SetDefaultValue(value); return *this;}
280 
285  inline HyperParameterSpecification& WithDefaultValue(Aws::String&& value) { SetDefaultValue(std::move(value)); return *this;}
286 
291  inline HyperParameterSpecification& WithDefaultValue(const char* value) { SetDefaultValue(value); return *this;}
292 
293  private:
294 
295  Aws::String m_name;
296  bool m_nameHasBeenSet;
297 
298  Aws::String m_description;
299  bool m_descriptionHasBeenSet;
300 
301  ParameterType m_type;
302  bool m_typeHasBeenSet;
303 
304  ParameterRange m_range;
305  bool m_rangeHasBeenSet;
306 
307  bool m_isTunable;
308  bool m_isTunableHasBeenSet;
309 
310  bool m_isRequired;
311  bool m_isRequiredHasBeenSet;
312 
313  Aws::String m_defaultValue;
314  bool m_defaultValueHasBeenSet;
315  };
316 
317 } // namespace Model
318 } // namespace SageMaker
319 } // namespace Aws
Aws::SavingsPlans::Model::SavingsPlanProductType::NOT_SET
@ NOT_SET
Aws::SageMaker::Model::HyperParameterSpecification::SetIsTunable
void SetIsTunable(bool value)
Definition: HyperParameterSpecification.h:215
SageMaker_EXPORTS.h
Aws::SageMaker::Model::HyperParameterSpecification::GetIsRequired
bool GetIsRequired() const
Definition: HyperParameterSpecification.h:227
Aws::SageMaker::Model::HyperParameterSpecification::TypeHasBeenSet
bool TypeHasBeenSet() const
Definition: HyperParameterSpecification.h:137
Aws::SageMaker::Model::HyperParameterSpecification::WithRange
HyperParameterSpecification & WithRange(ParameterRange &&value)
Definition: HyperParameterSpecification.h:196
Aws::SageMaker::Model::HyperParameterSpecification::IsTunableHasBeenSet
bool IsTunableHasBeenSet() const
Definition: HyperParameterSpecification.h:209
Aws::SageMaker::Model::HyperParameterSpecification::WithDescription
HyperParameterSpecification & WithDescription(const Aws::String &value)
Definition: HyperParameterSpecification.h:112
Aws::SageMaker::Model::HyperParameterSpecification::SetType
void SetType(ParameterType &&value)
Definition: HyperParameterSpecification.h:151
Aws::SageMaker::Model::HyperParameterSpecification::WithType
HyperParameterSpecification & WithType(const ParameterType &value)
Definition: HyperParameterSpecification.h:158
Aws::SageMaker::Model::HyperParameterSpecification::WithName
HyperParameterSpecification & WithName(const char *value)
Definition: HyperParameterSpecification.h:81
Aws::SageMaker::Model::HyperParameterSpecification::WithName
HyperParameterSpecification & WithName(const Aws::String &value)
Definition: HyperParameterSpecification.h:71
Aws::SageMaker::Model::HyperParameterSpecification::IsRequiredHasBeenSet
bool IsRequiredHasBeenSet() const
Definition: HyperParameterSpecification.h:232
Aws::SageMaker::Model::HyperParameterSpecification::SetDescription
void SetDescription(const char *value)
Definition: HyperParameterSpecification.h:107
Aws::SageMaker::Model::HyperParameterSpecification::WithDescription
HyperParameterSpecification & WithDescription(const char *value)
Definition: HyperParameterSpecification.h:122
Aws::SageMaker::Model::HyperParameterSpecification
Definition: HyperParameterSpecification.h:35
ParameterRange.h
Aws::SageMaker::Model::HyperParameterSpecification::HyperParameterSpecification
HyperParameterSpecification()
Aws::SageMaker::Model::HyperParameterSpecification::WithType
HyperParameterSpecification & WithType(ParameterType &&value)
Definition: HyperParameterSpecification.h:165
Aws::SageMaker::Model::HyperParameterSpecification::SetDescription
void SetDescription(Aws::String &&value)
Definition: HyperParameterSpecification.h:102
Aws::SageMaker::Model::HyperParameterSpecification::HyperParameterSpecification
HyperParameterSpecification(Aws::Utils::Json::JsonView jsonValue)
ParameterType.h
Aws::SageMaker::Model::HyperParameterSpecification::SetDefaultValue
void SetDefaultValue(const Aws::String &value)
Definition: HyperParameterSpecification.h:261
Aws::SageMaker::Model::HyperParameterSpecification::WithDefaultValue
HyperParameterSpecification & WithDefaultValue(const char *value)
Definition: HyperParameterSpecification.h:291
Aws::SageMaker::Model::HyperParameterSpecification::RangeHasBeenSet
bool RangeHasBeenSet() const
Definition: HyperParameterSpecification.h:176
Aws::SageMaker::Model::HyperParameterSpecification::GetName
const Aws::String & GetName() const
Definition: HyperParameterSpecification.h:46
Aws::SageMaker::Model::HyperParameterSpecification::SetName
void SetName(const Aws::String &value)
Definition: HyperParameterSpecification.h:56
AWS_SAGEMAKER_API
#define AWS_SAGEMAKER_API
Definition: SageMaker_EXPORTS.h:28
Aws::SageMaker::Model::HyperParameterSpecification::SetName
void SetName(Aws::String &&value)
Definition: HyperParameterSpecification.h:61
Aws::SageMaker::Model::HyperParameterSpecification::SetName
void SetName(const char *value)
Definition: HyperParameterSpecification.h:66
Aws::SageMaker::Model::ParameterType
ParameterType
Definition: ParameterType.h:17
Aws::SageMaker::Model::HyperParameterSpecification::SetIsRequired
void SetIsRequired(bool value)
Definition: HyperParameterSpecification.h:237
Aws::SageMaker::Model::HyperParameterSpecification::SetRange
void SetRange(const ParameterRange &value)
Definition: HyperParameterSpecification.h:181
Aws::SageMaker::Model::HyperParameterSpecification::WithDescription
HyperParameterSpecification & WithDescription(Aws::String &&value)
Definition: HyperParameterSpecification.h:117
Aws::SageMaker::Model::HyperParameterSpecification::SetType
void SetType(const ParameterType &value)
Definition: HyperParameterSpecification.h:144
Aws::SageMaker::Model::HyperParameterSpecification::SetDefaultValue
void SetDefaultValue(const char *value)
Definition: HyperParameterSpecification.h:273
Aws::Utils::Json::JsonView
Definition: JsonSerializer.h:235
AWSString.h
Aws::Utils::Json::JsonValue
Definition: JsonSerializer.h:33
Aws::SageMaker::Model::HyperParameterSpecification::GetDescription
const Aws::String & GetDescription() const
Definition: HyperParameterSpecification.h:87
Aws::SageMaker::Model::HyperParameterSpecification::NameHasBeenSet
bool NameHasBeenSet() const
Definition: HyperParameterSpecification.h:51
Aws::SageMaker::Model::HyperParameterSpecification::GetIsTunable
bool GetIsTunable() const
Definition: HyperParameterSpecification.h:203
Aws::SageMaker::Model::HyperParameterSpecification::SetDescription
void SetDescription(const Aws::String &value)
Definition: HyperParameterSpecification.h:97
Aws::SageMaker::Model::HyperParameterSpecification::WithRange
HyperParameterSpecification & WithRange(const ParameterRange &value)
Definition: HyperParameterSpecification.h:191
Aws::SageMaker::Model::HyperParameterSpecification::GetRange
const ParameterRange & GetRange() const
Definition: HyperParameterSpecification.h:171
Aws::SageMaker::Model::HyperParameterSpecification::DescriptionHasBeenSet
bool DescriptionHasBeenSet() const
Definition: HyperParameterSpecification.h:92
Aws::SageMaker::Model::HyperParameterSpecification::GetType
const ParameterType & GetType() const
Definition: HyperParameterSpecification.h:130
Aws::SageMaker::Model::HyperParameterSpecification::WithDefaultValue
HyperParameterSpecification & WithDefaultValue(Aws::String &&value)
Definition: HyperParameterSpecification.h:285
Aws::SageMaker::Model::HyperParameterSpecification::WithDefaultValue
HyperParameterSpecification & WithDefaultValue(const Aws::String &value)
Definition: HyperParameterSpecification.h:279
Aws::SageMaker::Model::HyperParameterSpecification::WithIsRequired
HyperParameterSpecification & WithIsRequired(bool value)
Definition: HyperParameterSpecification.h:242
Aws::SageMaker::Model::HyperParameterSpecification::WithName
HyperParameterSpecification & WithName(Aws::String &&value)
Definition: HyperParameterSpecification.h:76
Aws::SageMaker::Model::HyperParameterSpecification::GetDefaultValue
const Aws::String & GetDefaultValue() const
Definition: HyperParameterSpecification.h:249
Aws::MigrationHubStrategyRecommendations::Model::OutputFormat::NOT_SET
@ NOT_SET
Aws::SageMaker::Model::ParameterRange
Definition: ParameterRange.h:35
Aws
Definition: AccessManagementClient.h:15
Aws::SageMaker::Model::HyperParameterSpecification::WithIsTunable
HyperParameterSpecification & WithIsTunable(bool value)
Definition: HyperParameterSpecification.h:221
Aws::SageMaker::Model::HyperParameterSpecification::operator=
HyperParameterSpecification & operator=(Aws::Utils::Json::JsonView jsonValue)
Aws::SageMaker::Model::HyperParameterSpecification::SetDefaultValue
void SetDefaultValue(Aws::String &&value)
Definition: HyperParameterSpecification.h:267
Aws::SageMaker::Model::HyperParameterSpecification::SetRange
void SetRange(ParameterRange &&value)
Definition: HyperParameterSpecification.h:186
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::SageMaker::Model::HyperParameterSpecification::Jsonize
Aws::Utils::Json::JsonValue Jsonize() const
Aws::SageMaker::Model::HyperParameterSpecification::DefaultValueHasBeenSet
bool DefaultValueHasBeenSet() const
Definition: HyperParameterSpecification.h:255