AWS SDK for C++

AWS SDK for C++ Version 1.11.817

Loading...
Searching...
No Matches
DescribeClusterResult.h
1
6#pragma once
7#include <aws/core/http/HttpResponse.h>
8#include <aws/core/utils/DateTime.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/sagemaker/SageMaker_EXPORTS.h>
12#include <aws/sagemaker/model/ClusterAutoScalingConfigOutput.h>
13#include <aws/sagemaker/model/ClusterInstanceGroupDetails.h>
14#include <aws/sagemaker/model/ClusterNodeProvisioningMode.h>
15#include <aws/sagemaker/model/ClusterNodeRecovery.h>
16#include <aws/sagemaker/model/ClusterOrchestrator.h>
17#include <aws/sagemaker/model/ClusterRestrictedInstanceGroupDetails.h>
18#include <aws/sagemaker/model/ClusterRestrictedInstanceGroupsConfigOutput.h>
19#include <aws/sagemaker/model/ClusterStatus.h>
20#include <aws/sagemaker/model/ClusterTieredStorageConfig.h>
21#include <aws/sagemaker/model/VpcConfig.h>
22
23#include <utility>
24
25namespace Aws {
26template <typename RESULT_TYPE>
27class AmazonWebServiceResult;
28
29namespace Utils {
30namespace Json {
31class JsonValue;
32} // namespace Json
33} // namespace Utils
34namespace SageMaker {
35namespace Model {
37 public:
38 AWS_SAGEMAKER_API DescribeClusterResult() = default;
41
43
46 inline const Aws::String& GetClusterArn() const { return m_clusterArn; }
47 template <typename ClusterArnT = Aws::String>
48 void SetClusterArn(ClusterArnT&& value) {
49 m_clusterArnHasBeenSet = true;
50 m_clusterArn = std::forward<ClusterArnT>(value);
51 }
52 template <typename ClusterArnT = Aws::String>
53 DescribeClusterResult& WithClusterArn(ClusterArnT&& value) {
54 SetClusterArn(std::forward<ClusterArnT>(value));
55 return *this;
56 }
58
60
63 inline const Aws::String& GetClusterName() const { return m_clusterName; }
64 template <typename ClusterNameT = Aws::String>
65 void SetClusterName(ClusterNameT&& value) {
66 m_clusterNameHasBeenSet = true;
67 m_clusterName = std::forward<ClusterNameT>(value);
68 }
69 template <typename ClusterNameT = Aws::String>
70 DescribeClusterResult& WithClusterName(ClusterNameT&& value) {
71 SetClusterName(std::forward<ClusterNameT>(value));
72 return *this;
73 }
75
77
80 inline ClusterStatus GetClusterStatus() const { return m_clusterStatus; }
81 inline void SetClusterStatus(ClusterStatus value) {
82 m_clusterStatusHasBeenSet = true;
83 m_clusterStatus = value;
84 }
86 SetClusterStatus(value);
87 return *this;
88 }
90
92
95 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
96 template <typename CreationTimeT = Aws::Utils::DateTime>
97 void SetCreationTime(CreationTimeT&& value) {
98 m_creationTimeHasBeenSet = true;
99 m_creationTime = std::forward<CreationTimeT>(value);
100 }
101 template <typename CreationTimeT = Aws::Utils::DateTime>
102 DescribeClusterResult& WithCreationTime(CreationTimeT&& value) {
103 SetCreationTime(std::forward<CreationTimeT>(value));
104 return *this;
105 }
107
109
112 inline const Aws::String& GetFailureMessage() const { return m_failureMessage; }
113 template <typename FailureMessageT = Aws::String>
114 void SetFailureMessage(FailureMessageT&& value) {
115 m_failureMessageHasBeenSet = true;
116 m_failureMessage = std::forward<FailureMessageT>(value);
117 }
118 template <typename FailureMessageT = Aws::String>
119 DescribeClusterResult& WithFailureMessage(FailureMessageT&& value) {
120 SetFailureMessage(std::forward<FailureMessageT>(value));
121 return *this;
122 }
124
126
129 inline const Aws::Vector<ClusterInstanceGroupDetails>& GetInstanceGroups() const { return m_instanceGroups; }
130 template <typename InstanceGroupsT = Aws::Vector<ClusterInstanceGroupDetails>>
131 void SetInstanceGroups(InstanceGroupsT&& value) {
132 m_instanceGroupsHasBeenSet = true;
133 m_instanceGroups = std::forward<InstanceGroupsT>(value);
134 }
135 template <typename InstanceGroupsT = Aws::Vector<ClusterInstanceGroupDetails>>
136 DescribeClusterResult& WithInstanceGroups(InstanceGroupsT&& value) {
137 SetInstanceGroups(std::forward<InstanceGroupsT>(value));
138 return *this;
139 }
140 template <typename InstanceGroupsT = ClusterInstanceGroupDetails>
141 DescribeClusterResult& AddInstanceGroups(InstanceGroupsT&& value) {
142 m_instanceGroupsHasBeenSet = true;
143 m_instanceGroups.emplace_back(std::forward<InstanceGroupsT>(value));
144 return *this;
145 }
147
149
154 return m_restrictedInstanceGroups;
155 }
156 template <typename RestrictedInstanceGroupsT = Aws::Vector<ClusterRestrictedInstanceGroupDetails>>
157 void SetRestrictedInstanceGroups(RestrictedInstanceGroupsT&& value) {
158 m_restrictedInstanceGroupsHasBeenSet = true;
159 m_restrictedInstanceGroups = std::forward<RestrictedInstanceGroupsT>(value);
160 }
161 template <typename RestrictedInstanceGroupsT = Aws::Vector<ClusterRestrictedInstanceGroupDetails>>
162 DescribeClusterResult& WithRestrictedInstanceGroups(RestrictedInstanceGroupsT&& value) {
163 SetRestrictedInstanceGroups(std::forward<RestrictedInstanceGroupsT>(value));
164 return *this;
165 }
166 template <typename RestrictedInstanceGroupsT = ClusterRestrictedInstanceGroupDetails>
167 DescribeClusterResult& AddRestrictedInstanceGroups(RestrictedInstanceGroupsT&& value) {
168 m_restrictedInstanceGroupsHasBeenSet = true;
169 m_restrictedInstanceGroups.emplace_back(std::forward<RestrictedInstanceGroupsT>(value));
170 return *this;
171 }
173
175
180 return m_restrictedInstanceGroupsConfig;
181 }
182 template <typename RestrictedInstanceGroupsConfigT = ClusterRestrictedInstanceGroupsConfigOutput>
183 void SetRestrictedInstanceGroupsConfig(RestrictedInstanceGroupsConfigT&& value) {
184 m_restrictedInstanceGroupsConfigHasBeenSet = true;
185 m_restrictedInstanceGroupsConfig = std::forward<RestrictedInstanceGroupsConfigT>(value);
186 }
187 template <typename RestrictedInstanceGroupsConfigT = ClusterRestrictedInstanceGroupsConfigOutput>
188 DescribeClusterResult& WithRestrictedInstanceGroupsConfig(RestrictedInstanceGroupsConfigT&& value) {
189 SetRestrictedInstanceGroupsConfig(std::forward<RestrictedInstanceGroupsConfigT>(value));
190 return *this;
191 }
193
195
196 inline const VpcConfig& GetVpcConfig() const { return m_vpcConfig; }
197 template <typename VpcConfigT = VpcConfig>
198 void SetVpcConfig(VpcConfigT&& value) {
199 m_vpcConfigHasBeenSet = true;
200 m_vpcConfig = std::forward<VpcConfigT>(value);
201 }
202 template <typename VpcConfigT = VpcConfig>
204 SetVpcConfig(std::forward<VpcConfigT>(value));
205 return *this;
206 }
208
210
213 inline const ClusterOrchestrator& GetOrchestrator() const { return m_orchestrator; }
214 template <typename OrchestratorT = ClusterOrchestrator>
215 void SetOrchestrator(OrchestratorT&& value) {
216 m_orchestratorHasBeenSet = true;
217 m_orchestrator = std::forward<OrchestratorT>(value);
218 }
219 template <typename OrchestratorT = ClusterOrchestrator>
220 DescribeClusterResult& WithOrchestrator(OrchestratorT&& value) {
221 SetOrchestrator(std::forward<OrchestratorT>(value));
222 return *this;
223 }
225
227
232 inline const ClusterTieredStorageConfig& GetTieredStorageConfig() const { return m_tieredStorageConfig; }
233 template <typename TieredStorageConfigT = ClusterTieredStorageConfig>
234 void SetTieredStorageConfig(TieredStorageConfigT&& value) {
235 m_tieredStorageConfigHasBeenSet = true;
236 m_tieredStorageConfig = std::forward<TieredStorageConfigT>(value);
237 }
238 template <typename TieredStorageConfigT = ClusterTieredStorageConfig>
239 DescribeClusterResult& WithTieredStorageConfig(TieredStorageConfigT&& value) {
240 SetTieredStorageConfig(std::forward<TieredStorageConfigT>(value));
241 return *this;
242 }
244
246
249 inline ClusterNodeRecovery GetNodeRecovery() const { return m_nodeRecovery; }
251 m_nodeRecoveryHasBeenSet = true;
252 m_nodeRecovery = value;
253 }
255 SetNodeRecovery(value);
256 return *this;
257 }
259
261
264 inline ClusterNodeProvisioningMode GetNodeProvisioningMode() const { return m_nodeProvisioningMode; }
266 m_nodeProvisioningModeHasBeenSet = true;
267 m_nodeProvisioningMode = value;
268 }
271 return *this;
272 }
274
276
280 inline const Aws::String& GetClusterRole() const { return m_clusterRole; }
281 template <typename ClusterRoleT = Aws::String>
282 void SetClusterRole(ClusterRoleT&& value) {
283 m_clusterRoleHasBeenSet = true;
284 m_clusterRole = std::forward<ClusterRoleT>(value);
285 }
286 template <typename ClusterRoleT = Aws::String>
287 DescribeClusterResult& WithClusterRole(ClusterRoleT&& value) {
288 SetClusterRole(std::forward<ClusterRoleT>(value));
289 return *this;
290 }
292
294
297 inline const ClusterAutoScalingConfigOutput& GetAutoScaling() const { return m_autoScaling; }
298 template <typename AutoScalingT = ClusterAutoScalingConfigOutput>
299 void SetAutoScaling(AutoScalingT&& value) {
300 m_autoScalingHasBeenSet = true;
301 m_autoScaling = std::forward<AutoScalingT>(value);
302 }
303 template <typename AutoScalingT = ClusterAutoScalingConfigOutput>
304 DescribeClusterResult& WithAutoScaling(AutoScalingT&& value) {
305 SetAutoScaling(std::forward<AutoScalingT>(value));
306 return *this;
307 }
309
311
312 inline const Aws::String& GetRequestId() const { return m_requestId; }
313 template <typename RequestIdT = Aws::String>
314 void SetRequestId(RequestIdT&& value) {
315 m_requestIdHasBeenSet = true;
316 m_requestId = std::forward<RequestIdT>(value);
317 }
318 template <typename RequestIdT = Aws::String>
320 SetRequestId(std::forward<RequestIdT>(value));
321 return *this;
322 }
324 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
325
326 private:
327 Aws::String m_clusterArn;
328
329 Aws::String m_clusterName;
330
331 ClusterStatus m_clusterStatus{ClusterStatus::NOT_SET};
332
333 Aws::Utils::DateTime m_creationTime{};
334
335 Aws::String m_failureMessage;
336
338
340
341 ClusterRestrictedInstanceGroupsConfigOutput m_restrictedInstanceGroupsConfig;
342
343 VpcConfig m_vpcConfig;
344
345 ClusterOrchestrator m_orchestrator;
346
347 ClusterTieredStorageConfig m_tieredStorageConfig;
348
350
352
353 Aws::String m_clusterRole;
354
355 ClusterAutoScalingConfigOutput m_autoScaling;
356
357 Aws::String m_requestId;
358 Aws::Http::HttpResponseCode m_HttpResponseCode;
359 bool m_clusterArnHasBeenSet = false;
360 bool m_clusterNameHasBeenSet = false;
361 bool m_clusterStatusHasBeenSet = false;
362 bool m_creationTimeHasBeenSet = false;
363 bool m_failureMessageHasBeenSet = false;
364 bool m_instanceGroupsHasBeenSet = false;
365 bool m_restrictedInstanceGroupsHasBeenSet = false;
366 bool m_restrictedInstanceGroupsConfigHasBeenSet = false;
367 bool m_vpcConfigHasBeenSet = false;
368 bool m_orchestratorHasBeenSet = false;
369 bool m_tieredStorageConfigHasBeenSet = false;
370 bool m_nodeRecoveryHasBeenSet = false;
371 bool m_nodeProvisioningModeHasBeenSet = false;
372 bool m_clusterRoleHasBeenSet = false;
373 bool m_autoScalingHasBeenSet = false;
374 bool m_requestIdHasBeenSet = false;
375};
376
377} // namespace Model
378} // namespace SageMaker
379} // namespace Aws
DescribeClusterResult & WithRestrictedInstanceGroups(RestrictedInstanceGroupsT &&value)
void SetRestrictedInstanceGroups(RestrictedInstanceGroupsT &&value)
DescribeClusterResult & WithRequestId(RequestIdT &&value)
DescribeClusterResult & WithOrchestrator(OrchestratorT &&value)
DescribeClusterResult & WithTieredStorageConfig(TieredStorageConfigT &&value)
DescribeClusterResult & WithCreationTime(CreationTimeT &&value)
const ClusterAutoScalingConfigOutput & GetAutoScaling() const
DescribeClusterResult & WithRestrictedInstanceGroupsConfig(RestrictedInstanceGroupsConfigT &&value)
const ClusterRestrictedInstanceGroupsConfigOutput & GetRestrictedInstanceGroupsConfig() const
DescribeClusterResult & WithNodeProvisioningMode(ClusterNodeProvisioningMode value)
DescribeClusterResult & WithVpcConfig(VpcConfigT &&value)
DescribeClusterResult & AddRestrictedInstanceGroups(RestrictedInstanceGroupsT &&value)
DescribeClusterResult & AddInstanceGroups(InstanceGroupsT &&value)
DescribeClusterResult & WithClusterName(ClusterNameT &&value)
AWS_SAGEMAKER_API DescribeClusterResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
const Aws::Utils::DateTime & GetCreationTime() const
DescribeClusterResult & WithFailureMessage(FailureMessageT &&value)
const ClusterOrchestrator & GetOrchestrator() const
DescribeClusterResult & WithClusterStatus(ClusterStatus value)
DescribeClusterResult & WithInstanceGroups(InstanceGroupsT &&value)
const ClusterTieredStorageConfig & GetTieredStorageConfig() const
DescribeClusterResult & WithClusterRole(ClusterRoleT &&value)
DescribeClusterResult & WithAutoScaling(AutoScalingT &&value)
DescribeClusterResult & WithNodeRecovery(ClusterNodeRecovery value)
Aws::Http::HttpResponseCode GetHttpResponseCode() const
void SetNodeProvisioningMode(ClusterNodeProvisioningMode value)
void SetRestrictedInstanceGroupsConfig(RestrictedInstanceGroupsConfigT &&value)
AWS_SAGEMAKER_API DescribeClusterResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
AWS_SAGEMAKER_API DescribeClusterResult()=default
ClusterNodeProvisioningMode GetNodeProvisioningMode() const
const Aws::Vector< ClusterRestrictedInstanceGroupDetails > & GetRestrictedInstanceGroups() const
const Aws::Vector< ClusterInstanceGroupDetails > & GetInstanceGroups() const
void SetTieredStorageConfig(TieredStorageConfigT &&value)
DescribeClusterResult & WithClusterArn(ClusterArnT &&value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue