AWS SDK for C++

AWS SDK for C++ Version 1.11.754

Loading...
Searching...
No Matches
JobMetadata.h
1
6#pragma once
7#include <aws/core/utils/DateTime.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/snowball/Snowball_EXPORTS.h>
10#include <aws/snowball/model/DataTransfer.h>
11#include <aws/snowball/model/DeviceConfiguration.h>
12#include <aws/snowball/model/ImpactLevel.h>
13#include <aws/snowball/model/JobLogs.h>
14#include <aws/snowball/model/JobResource.h>
15#include <aws/snowball/model/JobState.h>
16#include <aws/snowball/model/JobType.h>
17#include <aws/snowball/model/Notification.h>
18#include <aws/snowball/model/OnDeviceServiceConfiguration.h>
19#include <aws/snowball/model/PickupDetails.h>
20#include <aws/snowball/model/RemoteManagement.h>
21#include <aws/snowball/model/ShippingDetails.h>
22#include <aws/snowball/model/SnowballCapacity.h>
23#include <aws/snowball/model/SnowballType.h>
24#include <aws/snowball/model/TaxDocuments.h>
25
26#include <utility>
27
28namespace Aws {
29namespace Utils {
30namespace Json {
31class JsonValue;
32class JsonView;
33} // namespace Json
34} // namespace Utils
35namespace Snowball {
36namespace Model {
37
47 public:
48 AWS_SNOWBALL_API JobMetadata() = default;
49 AWS_SNOWBALL_API JobMetadata(Aws::Utils::Json::JsonView jsonValue);
50 AWS_SNOWBALL_API JobMetadata& operator=(Aws::Utils::Json::JsonView jsonValue);
51 AWS_SNOWBALL_API Aws::Utils::Json::JsonValue Jsonize() const;
52
54
58 inline const Aws::String& GetJobId() const { return m_jobId; }
59 inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; }
60 template <typename JobIdT = Aws::String>
61 void SetJobId(JobIdT&& value) {
62 m_jobIdHasBeenSet = true;
63 m_jobId = std::forward<JobIdT>(value);
64 }
65 template <typename JobIdT = Aws::String>
66 JobMetadata& WithJobId(JobIdT&& value) {
67 SetJobId(std::forward<JobIdT>(value));
68 return *this;
69 }
71
73
76 inline JobState GetJobState() const { return m_jobState; }
77 inline bool JobStateHasBeenSet() const { return m_jobStateHasBeenSet; }
78 inline void SetJobState(JobState value) {
79 m_jobStateHasBeenSet = true;
80 m_jobState = value;
81 }
83 SetJobState(value);
84 return *this;
85 }
87
89
92 inline JobType GetJobType() const { return m_jobType; }
93 inline bool JobTypeHasBeenSet() const { return m_jobTypeHasBeenSet; }
94 inline void SetJobType(JobType value) {
95 m_jobTypeHasBeenSet = true;
96 m_jobType = value;
97 }
99 SetJobType(value);
100 return *this;
101 }
103
105
108 inline SnowballType GetSnowballType() const { return m_snowballType; }
109 inline bool SnowballTypeHasBeenSet() const { return m_snowballTypeHasBeenSet; }
110 inline void SetSnowballType(SnowballType value) {
111 m_snowballTypeHasBeenSet = true;
112 m_snowballType = value;
113 }
115 SetSnowballType(value);
116 return *this;
117 }
119
121
124 inline const Aws::Utils::DateTime& GetCreationDate() const { return m_creationDate; }
125 inline bool CreationDateHasBeenSet() const { return m_creationDateHasBeenSet; }
126 template <typename CreationDateT = Aws::Utils::DateTime>
127 void SetCreationDate(CreationDateT&& value) {
128 m_creationDateHasBeenSet = true;
129 m_creationDate = std::forward<CreationDateT>(value);
130 }
131 template <typename CreationDateT = Aws::Utils::DateTime>
132 JobMetadata& WithCreationDate(CreationDateT&& value) {
133 SetCreationDate(std::forward<CreationDateT>(value));
134 return *this;
135 }
137
139
144 inline const JobResource& GetResources() const { return m_resources; }
145 inline bool ResourcesHasBeenSet() const { return m_resourcesHasBeenSet; }
146 template <typename ResourcesT = JobResource>
147 void SetResources(ResourcesT&& value) {
148 m_resourcesHasBeenSet = true;
149 m_resources = std::forward<ResourcesT>(value);
150 }
151 template <typename ResourcesT = JobResource>
152 JobMetadata& WithResources(ResourcesT&& value) {
153 SetResources(std::forward<ResourcesT>(value));
154 return *this;
155 }
157
159
162 inline const Aws::String& GetDescription() const { return m_description; }
163 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
164 template <typename DescriptionT = Aws::String>
165 void SetDescription(DescriptionT&& value) {
166 m_descriptionHasBeenSet = true;
167 m_description = std::forward<DescriptionT>(value);
168 }
169 template <typename DescriptionT = Aws::String>
170 JobMetadata& WithDescription(DescriptionT&& value) {
171 SetDescription(std::forward<DescriptionT>(value));
172 return *this;
173 }
175
177
183 inline const Aws::String& GetKmsKeyARN() const { return m_kmsKeyARN; }
184 inline bool KmsKeyARNHasBeenSet() const { return m_kmsKeyARNHasBeenSet; }
185 template <typename KmsKeyARNT = Aws::String>
186 void SetKmsKeyARN(KmsKeyARNT&& value) {
187 m_kmsKeyARNHasBeenSet = true;
188 m_kmsKeyARN = std::forward<KmsKeyARNT>(value);
189 }
190 template <typename KmsKeyARNT = Aws::String>
191 JobMetadata& WithKmsKeyARN(KmsKeyARNT&& value) {
192 SetKmsKeyARN(std::forward<KmsKeyARNT>(value));
193 return *this;
194 }
196
198
203 inline const Aws::String& GetRoleARN() const { return m_roleARN; }
204 inline bool RoleARNHasBeenSet() const { return m_roleARNHasBeenSet; }
205 template <typename RoleARNT = Aws::String>
206 void SetRoleARN(RoleARNT&& value) {
207 m_roleARNHasBeenSet = true;
208 m_roleARN = std::forward<RoleARNT>(value);
209 }
210 template <typename RoleARNT = Aws::String>
211 JobMetadata& WithRoleARN(RoleARNT&& value) {
212 SetRoleARN(std::forward<RoleARNT>(value));
213 return *this;
214 }
216
218
221 inline const Aws::String& GetAddressId() const { return m_addressId; }
222 inline bool AddressIdHasBeenSet() const { return m_addressIdHasBeenSet; }
223 template <typename AddressIdT = Aws::String>
224 void SetAddressId(AddressIdT&& value) {
225 m_addressIdHasBeenSet = true;
226 m_addressId = std::forward<AddressIdT>(value);
227 }
228 template <typename AddressIdT = Aws::String>
229 JobMetadata& WithAddressId(AddressIdT&& value) {
230 SetAddressId(std::forward<AddressIdT>(value));
231 return *this;
232 }
234
236
240 inline const ShippingDetails& GetShippingDetails() const { return m_shippingDetails; }
241 inline bool ShippingDetailsHasBeenSet() const { return m_shippingDetailsHasBeenSet; }
242 template <typename ShippingDetailsT = ShippingDetails>
243 void SetShippingDetails(ShippingDetailsT&& value) {
244 m_shippingDetailsHasBeenSet = true;
245 m_shippingDetails = std::forward<ShippingDetailsT>(value);
246 }
247 template <typename ShippingDetailsT = ShippingDetails>
248 JobMetadata& WithShippingDetails(ShippingDetailsT&& value) {
249 SetShippingDetails(std::forward<ShippingDetailsT>(value));
250 return *this;
251 }
253
255
264 inline SnowballCapacity GetSnowballCapacityPreference() const { return m_snowballCapacityPreference; }
265 inline bool SnowballCapacityPreferenceHasBeenSet() const { return m_snowballCapacityPreferenceHasBeenSet; }
267 m_snowballCapacityPreferenceHasBeenSet = true;
268 m_snowballCapacityPreference = value;
269 }
272 return *this;
273 }
275
277
283 inline const Notification& GetNotification() const { return m_notification; }
284 inline bool NotificationHasBeenSet() const { return m_notificationHasBeenSet; }
285 template <typename NotificationT = Notification>
286 void SetNotification(NotificationT&& value) {
287 m_notificationHasBeenSet = true;
288 m_notification = std::forward<NotificationT>(value);
289 }
290 template <typename NotificationT = Notification>
291 JobMetadata& WithNotification(NotificationT&& value) {
292 SetNotification(std::forward<NotificationT>(value));
293 return *this;
294 }
296
298
304 inline const DataTransfer& GetDataTransferProgress() const { return m_dataTransferProgress; }
305 inline bool DataTransferProgressHasBeenSet() const { return m_dataTransferProgressHasBeenSet; }
306 template <typename DataTransferProgressT = DataTransfer>
307 void SetDataTransferProgress(DataTransferProgressT&& value) {
308 m_dataTransferProgressHasBeenSet = true;
309 m_dataTransferProgress = std::forward<DataTransferProgressT>(value);
310 }
311 template <typename DataTransferProgressT = DataTransfer>
312 JobMetadata& WithDataTransferProgress(DataTransferProgressT&& value) {
313 SetDataTransferProgress(std::forward<DataTransferProgressT>(value));
314 return *this;
315 }
317
319
325 inline const JobLogs& GetJobLogInfo() const { return m_jobLogInfo; }
326 inline bool JobLogInfoHasBeenSet() const { return m_jobLogInfoHasBeenSet; }
327 template <typename JobLogInfoT = JobLogs>
328 void SetJobLogInfo(JobLogInfoT&& value) {
329 m_jobLogInfoHasBeenSet = true;
330 m_jobLogInfo = std::forward<JobLogInfoT>(value);
331 }
332 template <typename JobLogInfoT = JobLogs>
333 JobMetadata& WithJobLogInfo(JobLogInfoT&& value) {
334 SetJobLogInfo(std::forward<JobLogInfoT>(value));
335 return *this;
336 }
338
340
344 inline const Aws::String& GetClusterId() const { return m_clusterId; }
345 inline bool ClusterIdHasBeenSet() const { return m_clusterIdHasBeenSet; }
346 template <typename ClusterIdT = Aws::String>
347 void SetClusterId(ClusterIdT&& value) {
348 m_clusterIdHasBeenSet = true;
349 m_clusterId = std::forward<ClusterIdT>(value);
350 }
351 template <typename ClusterIdT = Aws::String>
352 JobMetadata& WithClusterId(ClusterIdT&& value) {
353 SetClusterId(std::forward<ClusterIdT>(value));
354 return *this;
355 }
357
359
363 inline const Aws::String& GetForwardingAddressId() const { return m_forwardingAddressId; }
364 inline bool ForwardingAddressIdHasBeenSet() const { return m_forwardingAddressIdHasBeenSet; }
365 template <typename ForwardingAddressIdT = Aws::String>
366 void SetForwardingAddressId(ForwardingAddressIdT&& value) {
367 m_forwardingAddressIdHasBeenSet = true;
368 m_forwardingAddressId = std::forward<ForwardingAddressIdT>(value);
369 }
370 template <typename ForwardingAddressIdT = Aws::String>
371 JobMetadata& WithForwardingAddressId(ForwardingAddressIdT&& value) {
372 SetForwardingAddressId(std::forward<ForwardingAddressIdT>(value));
373 return *this;
374 }
376
378
382 inline const TaxDocuments& GetTaxDocuments() const { return m_taxDocuments; }
383 inline bool TaxDocumentsHasBeenSet() const { return m_taxDocumentsHasBeenSet; }
384 template <typename TaxDocumentsT = TaxDocuments>
385 void SetTaxDocuments(TaxDocumentsT&& value) {
386 m_taxDocumentsHasBeenSet = true;
387 m_taxDocuments = std::forward<TaxDocumentsT>(value);
388 }
389 template <typename TaxDocumentsT = TaxDocuments>
390 JobMetadata& WithTaxDocuments(TaxDocumentsT&& value) {
391 SetTaxDocuments(std::forward<TaxDocumentsT>(value));
392 return *this;
393 }
395
397
398 inline const DeviceConfiguration& GetDeviceConfiguration() const { return m_deviceConfiguration; }
399 inline bool DeviceConfigurationHasBeenSet() const { return m_deviceConfigurationHasBeenSet; }
400 template <typename DeviceConfigurationT = DeviceConfiguration>
401 void SetDeviceConfiguration(DeviceConfigurationT&& value) {
402 m_deviceConfigurationHasBeenSet = true;
403 m_deviceConfiguration = std::forward<DeviceConfigurationT>(value);
404 }
405 template <typename DeviceConfigurationT = DeviceConfiguration>
406 JobMetadata& WithDeviceConfiguration(DeviceConfigurationT&& value) {
407 SetDeviceConfiguration(std::forward<DeviceConfigurationT>(value));
408 return *this;
409 }
411
413
420 inline RemoteManagement GetRemoteManagement() const { return m_remoteManagement; }
421 inline bool RemoteManagementHasBeenSet() const { return m_remoteManagementHasBeenSet; }
423 m_remoteManagementHasBeenSet = true;
424 m_remoteManagement = value;
425 }
427 SetRemoteManagement(value);
428 return *this;
429 }
431
433
436 inline const Aws::String& GetLongTermPricingId() const { return m_longTermPricingId; }
437 inline bool LongTermPricingIdHasBeenSet() const { return m_longTermPricingIdHasBeenSet; }
438 template <typename LongTermPricingIdT = Aws::String>
439 void SetLongTermPricingId(LongTermPricingIdT&& value) {
440 m_longTermPricingIdHasBeenSet = true;
441 m_longTermPricingId = std::forward<LongTermPricingIdT>(value);
442 }
443 template <typename LongTermPricingIdT = Aws::String>
444 JobMetadata& WithLongTermPricingId(LongTermPricingIdT&& value) {
445 SetLongTermPricingId(std::forward<LongTermPricingIdT>(value));
446 return *this;
447 }
449
451
455 inline const OnDeviceServiceConfiguration& GetOnDeviceServiceConfiguration() const { return m_onDeviceServiceConfiguration; }
456 inline bool OnDeviceServiceConfigurationHasBeenSet() const { return m_onDeviceServiceConfigurationHasBeenSet; }
457 template <typename OnDeviceServiceConfigurationT = OnDeviceServiceConfiguration>
458 void SetOnDeviceServiceConfiguration(OnDeviceServiceConfigurationT&& value) {
459 m_onDeviceServiceConfigurationHasBeenSet = true;
460 m_onDeviceServiceConfiguration = std::forward<OnDeviceServiceConfigurationT>(value);
461 }
462 template <typename OnDeviceServiceConfigurationT = OnDeviceServiceConfiguration>
463 JobMetadata& WithOnDeviceServiceConfiguration(OnDeviceServiceConfigurationT&& value) {
464 SetOnDeviceServiceConfiguration(std::forward<OnDeviceServiceConfigurationT>(value));
465 return *this;
466 }
468
470
474 inline ImpactLevel GetImpactLevel() const { return m_impactLevel; }
475 inline bool ImpactLevelHasBeenSet() const { return m_impactLevelHasBeenSet; }
476 inline void SetImpactLevel(ImpactLevel value) {
477 m_impactLevelHasBeenSet = true;
478 m_impactLevel = value;
479 }
481 SetImpactLevel(value);
482 return *this;
483 }
485
487
490 inline const PickupDetails& GetPickupDetails() const { return m_pickupDetails; }
491 inline bool PickupDetailsHasBeenSet() const { return m_pickupDetailsHasBeenSet; }
492 template <typename PickupDetailsT = PickupDetails>
493 void SetPickupDetails(PickupDetailsT&& value) {
494 m_pickupDetailsHasBeenSet = true;
495 m_pickupDetails = std::forward<PickupDetailsT>(value);
496 }
497 template <typename PickupDetailsT = PickupDetails>
498 JobMetadata& WithPickupDetails(PickupDetailsT&& value) {
499 SetPickupDetails(std::forward<PickupDetailsT>(value));
500 return *this;
501 }
503
505
508 inline const Aws::String& GetSnowballId() const { return m_snowballId; }
509 inline bool SnowballIdHasBeenSet() const { return m_snowballIdHasBeenSet; }
510 template <typename SnowballIdT = Aws::String>
511 void SetSnowballId(SnowballIdT&& value) {
512 m_snowballIdHasBeenSet = true;
513 m_snowballId = std::forward<SnowballIdT>(value);
514 }
515 template <typename SnowballIdT = Aws::String>
516 JobMetadata& WithSnowballId(SnowballIdT&& value) {
517 SetSnowballId(std::forward<SnowballIdT>(value));
518 return *this;
519 }
521 private:
522 Aws::String m_jobId;
523
524 JobState m_jobState{JobState::NOT_SET};
525
526 JobType m_jobType{JobType::NOT_SET};
527
528 SnowballType m_snowballType{SnowballType::NOT_SET};
529
530 Aws::Utils::DateTime m_creationDate{};
531
532 JobResource m_resources;
533
534 Aws::String m_description;
535
536 Aws::String m_kmsKeyARN;
537
538 Aws::String m_roleARN;
539
540 Aws::String m_addressId;
541
542 ShippingDetails m_shippingDetails;
543
544 SnowballCapacity m_snowballCapacityPreference{SnowballCapacity::NOT_SET};
545
546 Notification m_notification;
547
548 DataTransfer m_dataTransferProgress;
549
550 JobLogs m_jobLogInfo;
551
552 Aws::String m_clusterId;
553
554 Aws::String m_forwardingAddressId;
555
556 TaxDocuments m_taxDocuments;
557
558 DeviceConfiguration m_deviceConfiguration;
559
561
562 Aws::String m_longTermPricingId;
563
564 OnDeviceServiceConfiguration m_onDeviceServiceConfiguration;
565
566 ImpactLevel m_impactLevel{ImpactLevel::NOT_SET};
567
568 PickupDetails m_pickupDetails;
569
570 Aws::String m_snowballId;
571 bool m_jobIdHasBeenSet = false;
572 bool m_jobStateHasBeenSet = false;
573 bool m_jobTypeHasBeenSet = false;
574 bool m_snowballTypeHasBeenSet = false;
575 bool m_creationDateHasBeenSet = false;
576 bool m_resourcesHasBeenSet = false;
577 bool m_descriptionHasBeenSet = false;
578 bool m_kmsKeyARNHasBeenSet = false;
579 bool m_roleARNHasBeenSet = false;
580 bool m_addressIdHasBeenSet = false;
581 bool m_shippingDetailsHasBeenSet = false;
582 bool m_snowballCapacityPreferenceHasBeenSet = false;
583 bool m_notificationHasBeenSet = false;
584 bool m_dataTransferProgressHasBeenSet = false;
585 bool m_jobLogInfoHasBeenSet = false;
586 bool m_clusterIdHasBeenSet = false;
587 bool m_forwardingAddressIdHasBeenSet = false;
588 bool m_taxDocumentsHasBeenSet = false;
589 bool m_deviceConfigurationHasBeenSet = false;
590 bool m_remoteManagementHasBeenSet = false;
591 bool m_longTermPricingIdHasBeenSet = false;
592 bool m_onDeviceServiceConfigurationHasBeenSet = false;
593 bool m_impactLevelHasBeenSet = false;
594 bool m_pickupDetailsHasBeenSet = false;
595 bool m_snowballIdHasBeenSet = false;
596};
597
598} // namespace Model
599} // namespace Snowball
600} // namespace Aws
const TaxDocuments & GetTaxDocuments() const
const Aws::String & GetSnowballId() const
const JobResource & GetResources() const
void SetOnDeviceServiceConfiguration(OnDeviceServiceConfigurationT &&value)
void SetDataTransferProgress(DataTransferProgressT &&value)
JobMetadata & WithDataTransferProgress(DataTransferProgressT &&value)
void SetSnowballCapacityPreference(SnowballCapacity value)
const DataTransfer & GetDataTransferProgress() const
JobMetadata & WithShippingDetails(ShippingDetailsT &&value)
const Aws::String & GetForwardingAddressId() const
JobMetadata & WithCreationDate(CreationDateT &&value)
JobMetadata & WithImpactLevel(ImpactLevel value)
void SetCreationDate(CreationDateT &&value)
const Aws::String & GetLongTermPricingId() const
void SetRoleARN(RoleARNT &&value)
bool SnowballCapacityPreferenceHasBeenSet() const
JobMetadata & WithJobState(JobState value)
Definition JobMetadata.h:82
JobMetadata & WithSnowballId(SnowballIdT &&value)
JobMetadata & WithRemoteManagement(RemoteManagement value)
void SetImpactLevel(ImpactLevel value)
bool OnDeviceServiceConfigurationHasBeenSet() const
void SetAddressId(AddressIdT &&value)
void SetShippingDetails(ShippingDetailsT &&value)
void SetJobState(JobState value)
Definition JobMetadata.h:78
void SetLongTermPricingId(LongTermPricingIdT &&value)
void SetKmsKeyARN(KmsKeyARNT &&value)
JobMetadata & WithSnowballType(SnowballType value)
RemoteManagement GetRemoteManagement() const
JobMetadata & WithClusterId(ClusterIdT &&value)
void SetClusterId(ClusterIdT &&value)
JobMetadata & WithSnowballCapacityPreference(SnowballCapacity value)
JobMetadata & WithForwardingAddressId(ForwardingAddressIdT &&value)
JobMetadata & WithLongTermPricingId(LongTermPricingIdT &&value)
JobMetadata & WithResources(ResourcesT &&value)
const DeviceConfiguration & GetDeviceConfiguration() const
void SetDeviceConfiguration(DeviceConfigurationT &&value)
AWS_SNOWBALL_API JobMetadata()=default
AWS_SNOWBALL_API Aws::Utils::Json::JsonValue Jsonize() const
const OnDeviceServiceConfiguration & GetOnDeviceServiceConfiguration() const
JobMetadata & WithJobType(JobType value)
Definition JobMetadata.h:98
void SetSnowballId(SnowballIdT &&value)
void SetJobId(JobIdT &&value)
Definition JobMetadata.h:61
void SetPickupDetails(PickupDetailsT &&value)
const Aws::String & GetJobId() const
Definition JobMetadata.h:58
void SetNotification(NotificationT &&value)
JobMetadata & WithJobLogInfo(JobLogInfoT &&value)
void SetJobLogInfo(JobLogInfoT &&value)
JobMetadata & WithTaxDocuments(TaxDocumentsT &&value)
const Aws::String & GetDescription() const
const Notification & GetNotification() const
JobMetadata & WithRoleARN(RoleARNT &&value)
void SetRemoteManagement(RemoteManagement value)
void SetJobType(JobType value)
Definition JobMetadata.h:94
void SetSnowballType(SnowballType value)
void SetForwardingAddressId(ForwardingAddressIdT &&value)
JobMetadata & WithKmsKeyARN(KmsKeyARNT &&value)
JobMetadata & WithNotification(NotificationT &&value)
const Aws::String & GetAddressId() const
JobMetadata & WithDescription(DescriptionT &&value)
ImpactLevel GetImpactLevel() const
const Aws::String & GetKmsKeyARN() const
const Aws::String & GetClusterId() const
JobMetadata & WithDeviceConfiguration(DeviceConfigurationT &&value)
void SetTaxDocuments(TaxDocumentsT &&value)
const ShippingDetails & GetShippingDetails() const
const PickupDetails & GetPickupDetails() const
void SetDescription(DescriptionT &&value)
JobMetadata & WithJobId(JobIdT &&value)
Definition JobMetadata.h:66
AWS_SNOWBALL_API JobMetadata & operator=(Aws::Utils::Json::JsonView jsonValue)
JobMetadata & WithPickupDetails(PickupDetailsT &&value)
SnowballType GetSnowballType() const
SnowballCapacity GetSnowballCapacityPreference() const
void SetResources(ResourcesT &&value)
AWS_SNOWBALL_API JobMetadata(Aws::Utils::Json::JsonView jsonValue)
const Aws::String & GetRoleARN() const
const Aws::Utils::DateTime & GetCreationDate() const
JobMetadata & WithOnDeviceServiceConfiguration(OnDeviceServiceConfigurationT &&value)
JobMetadata & WithAddressId(AddressIdT &&value)
const JobLogs & GetJobLogInfo() const
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Aws::Utils::Json::JsonValue JsonValue