AWS SDK for C++

AWS SDK for C++ Version 1.11.788

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/ClusterStatus.h>
19#include <aws/sagemaker/model/ClusterTieredStorageConfig.h>
20#include <aws/sagemaker/model/VpcConfig.h>
21
22#include <utility>
23
24namespace Aws {
25template <typename RESULT_TYPE>
26class AmazonWebServiceResult;
27
28namespace Utils {
29namespace Json {
30class JsonValue;
31} // namespace Json
32} // namespace Utils
33namespace SageMaker {
34namespace Model {
36 public:
37 AWS_SAGEMAKER_API DescribeClusterResult() = default;
40
42
45 inline const Aws::String& GetClusterArn() const { return m_clusterArn; }
46 template <typename ClusterArnT = Aws::String>
47 void SetClusterArn(ClusterArnT&& value) {
48 m_clusterArnHasBeenSet = true;
49 m_clusterArn = std::forward<ClusterArnT>(value);
50 }
51 template <typename ClusterArnT = Aws::String>
52 DescribeClusterResult& WithClusterArn(ClusterArnT&& value) {
53 SetClusterArn(std::forward<ClusterArnT>(value));
54 return *this;
55 }
57
59
62 inline const Aws::String& GetClusterName() const { return m_clusterName; }
63 template <typename ClusterNameT = Aws::String>
64 void SetClusterName(ClusterNameT&& value) {
65 m_clusterNameHasBeenSet = true;
66 m_clusterName = std::forward<ClusterNameT>(value);
67 }
68 template <typename ClusterNameT = Aws::String>
69 DescribeClusterResult& WithClusterName(ClusterNameT&& value) {
70 SetClusterName(std::forward<ClusterNameT>(value));
71 return *this;
72 }
74
76
79 inline ClusterStatus GetClusterStatus() const { return m_clusterStatus; }
80 inline void SetClusterStatus(ClusterStatus value) {
81 m_clusterStatusHasBeenSet = true;
82 m_clusterStatus = value;
83 }
85 SetClusterStatus(value);
86 return *this;
87 }
89
91
94 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
95 template <typename CreationTimeT = Aws::Utils::DateTime>
96 void SetCreationTime(CreationTimeT&& value) {
97 m_creationTimeHasBeenSet = true;
98 m_creationTime = std::forward<CreationTimeT>(value);
99 }
100 template <typename CreationTimeT = Aws::Utils::DateTime>
101 DescribeClusterResult& WithCreationTime(CreationTimeT&& value) {
102 SetCreationTime(std::forward<CreationTimeT>(value));
103 return *this;
104 }
106
108
111 inline const Aws::String& GetFailureMessage() const { return m_failureMessage; }
112 template <typename FailureMessageT = Aws::String>
113 void SetFailureMessage(FailureMessageT&& value) {
114 m_failureMessageHasBeenSet = true;
115 m_failureMessage = std::forward<FailureMessageT>(value);
116 }
117 template <typename FailureMessageT = Aws::String>
118 DescribeClusterResult& WithFailureMessage(FailureMessageT&& value) {
119 SetFailureMessage(std::forward<FailureMessageT>(value));
120 return *this;
121 }
123
125
128 inline const Aws::Vector<ClusterInstanceGroupDetails>& GetInstanceGroups() const { return m_instanceGroups; }
129 template <typename InstanceGroupsT = Aws::Vector<ClusterInstanceGroupDetails>>
130 void SetInstanceGroups(InstanceGroupsT&& value) {
131 m_instanceGroupsHasBeenSet = true;
132 m_instanceGroups = std::forward<InstanceGroupsT>(value);
133 }
134 template <typename InstanceGroupsT = Aws::Vector<ClusterInstanceGroupDetails>>
135 DescribeClusterResult& WithInstanceGroups(InstanceGroupsT&& value) {
136 SetInstanceGroups(std::forward<InstanceGroupsT>(value));
137 return *this;
138 }
139 template <typename InstanceGroupsT = ClusterInstanceGroupDetails>
140 DescribeClusterResult& AddInstanceGroups(InstanceGroupsT&& value) {
141 m_instanceGroupsHasBeenSet = true;
142 m_instanceGroups.emplace_back(std::forward<InstanceGroupsT>(value));
143 return *this;
144 }
146
148
153 return m_restrictedInstanceGroups;
154 }
155 template <typename RestrictedInstanceGroupsT = Aws::Vector<ClusterRestrictedInstanceGroupDetails>>
156 void SetRestrictedInstanceGroups(RestrictedInstanceGroupsT&& value) {
157 m_restrictedInstanceGroupsHasBeenSet = true;
158 m_restrictedInstanceGroups = std::forward<RestrictedInstanceGroupsT>(value);
159 }
160 template <typename RestrictedInstanceGroupsT = Aws::Vector<ClusterRestrictedInstanceGroupDetails>>
161 DescribeClusterResult& WithRestrictedInstanceGroups(RestrictedInstanceGroupsT&& value) {
162 SetRestrictedInstanceGroups(std::forward<RestrictedInstanceGroupsT>(value));
163 return *this;
164 }
165 template <typename RestrictedInstanceGroupsT = ClusterRestrictedInstanceGroupDetails>
166 DescribeClusterResult& AddRestrictedInstanceGroups(RestrictedInstanceGroupsT&& value) {
167 m_restrictedInstanceGroupsHasBeenSet = true;
168 m_restrictedInstanceGroups.emplace_back(std::forward<RestrictedInstanceGroupsT>(value));
169 return *this;
170 }
172
174
175 inline const VpcConfig& GetVpcConfig() const { return m_vpcConfig; }
176 template <typename VpcConfigT = VpcConfig>
177 void SetVpcConfig(VpcConfigT&& value) {
178 m_vpcConfigHasBeenSet = true;
179 m_vpcConfig = std::forward<VpcConfigT>(value);
180 }
181 template <typename VpcConfigT = VpcConfig>
183 SetVpcConfig(std::forward<VpcConfigT>(value));
184 return *this;
185 }
187
189
192 inline const ClusterOrchestrator& GetOrchestrator() const { return m_orchestrator; }
193 template <typename OrchestratorT = ClusterOrchestrator>
194 void SetOrchestrator(OrchestratorT&& value) {
195 m_orchestratorHasBeenSet = true;
196 m_orchestrator = std::forward<OrchestratorT>(value);
197 }
198 template <typename OrchestratorT = ClusterOrchestrator>
199 DescribeClusterResult& WithOrchestrator(OrchestratorT&& value) {
200 SetOrchestrator(std::forward<OrchestratorT>(value));
201 return *this;
202 }
204
206
211 inline const ClusterTieredStorageConfig& GetTieredStorageConfig() const { return m_tieredStorageConfig; }
212 template <typename TieredStorageConfigT = ClusterTieredStorageConfig>
213 void SetTieredStorageConfig(TieredStorageConfigT&& value) {
214 m_tieredStorageConfigHasBeenSet = true;
215 m_tieredStorageConfig = std::forward<TieredStorageConfigT>(value);
216 }
217 template <typename TieredStorageConfigT = ClusterTieredStorageConfig>
218 DescribeClusterResult& WithTieredStorageConfig(TieredStorageConfigT&& value) {
219 SetTieredStorageConfig(std::forward<TieredStorageConfigT>(value));
220 return *this;
221 }
223
225
228 inline ClusterNodeRecovery GetNodeRecovery() const { return m_nodeRecovery; }
230 m_nodeRecoveryHasBeenSet = true;
231 m_nodeRecovery = value;
232 }
234 SetNodeRecovery(value);
235 return *this;
236 }
238
240
243 inline ClusterNodeProvisioningMode GetNodeProvisioningMode() const { return m_nodeProvisioningMode; }
245 m_nodeProvisioningModeHasBeenSet = true;
246 m_nodeProvisioningMode = value;
247 }
250 return *this;
251 }
253
255
259 inline const Aws::String& GetClusterRole() const { return m_clusterRole; }
260 template <typename ClusterRoleT = Aws::String>
261 void SetClusterRole(ClusterRoleT&& value) {
262 m_clusterRoleHasBeenSet = true;
263 m_clusterRole = std::forward<ClusterRoleT>(value);
264 }
265 template <typename ClusterRoleT = Aws::String>
266 DescribeClusterResult& WithClusterRole(ClusterRoleT&& value) {
267 SetClusterRole(std::forward<ClusterRoleT>(value));
268 return *this;
269 }
271
273
276 inline const ClusterAutoScalingConfigOutput& GetAutoScaling() const { return m_autoScaling; }
277 template <typename AutoScalingT = ClusterAutoScalingConfigOutput>
278 void SetAutoScaling(AutoScalingT&& value) {
279 m_autoScalingHasBeenSet = true;
280 m_autoScaling = std::forward<AutoScalingT>(value);
281 }
282 template <typename AutoScalingT = ClusterAutoScalingConfigOutput>
283 DescribeClusterResult& WithAutoScaling(AutoScalingT&& value) {
284 SetAutoScaling(std::forward<AutoScalingT>(value));
285 return *this;
286 }
288
290
291 inline const Aws::String& GetRequestId() const { return m_requestId; }
292 template <typename RequestIdT = Aws::String>
293 void SetRequestId(RequestIdT&& value) {
294 m_requestIdHasBeenSet = true;
295 m_requestId = std::forward<RequestIdT>(value);
296 }
297 template <typename RequestIdT = Aws::String>
299 SetRequestId(std::forward<RequestIdT>(value));
300 return *this;
301 }
303 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
304
305 private:
306 Aws::String m_clusterArn;
307
308 Aws::String m_clusterName;
309
310 ClusterStatus m_clusterStatus{ClusterStatus::NOT_SET};
311
312 Aws::Utils::DateTime m_creationTime{};
313
314 Aws::String m_failureMessage;
315
317
319
320 VpcConfig m_vpcConfig;
321
322 ClusterOrchestrator m_orchestrator;
323
324 ClusterTieredStorageConfig m_tieredStorageConfig;
325
327
329
330 Aws::String m_clusterRole;
331
332 ClusterAutoScalingConfigOutput m_autoScaling;
333
334 Aws::String m_requestId;
335 Aws::Http::HttpResponseCode m_HttpResponseCode;
336 bool m_clusterArnHasBeenSet = false;
337 bool m_clusterNameHasBeenSet = false;
338 bool m_clusterStatusHasBeenSet = false;
339 bool m_creationTimeHasBeenSet = false;
340 bool m_failureMessageHasBeenSet = false;
341 bool m_instanceGroupsHasBeenSet = false;
342 bool m_restrictedInstanceGroupsHasBeenSet = false;
343 bool m_vpcConfigHasBeenSet = false;
344 bool m_orchestratorHasBeenSet = false;
345 bool m_tieredStorageConfigHasBeenSet = false;
346 bool m_nodeRecoveryHasBeenSet = false;
347 bool m_nodeProvisioningModeHasBeenSet = false;
348 bool m_clusterRoleHasBeenSet = false;
349 bool m_autoScalingHasBeenSet = false;
350 bool m_requestIdHasBeenSet = false;
351};
352
353} // namespace Model
354} // namespace SageMaker
355} // 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 & 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)
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