AWS SDK for C++  0.14.3
AWS SDK for C++
JobMetadata.h
Go to the documentation of this file.
1 /*
2 * Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License").
5 * You may not use this file except in compliance with the License.
6 * A copy of the License is located at
7 *
8 * http://aws.amazon.com/apache2.0
9 *
10 * or in the "license" file accompanying this file. This file is distributed
11 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12 * express or implied. See the License for the specific language governing
13 * permissions and limitations under the License.
14 */
15 #pragma once
27 
28 namespace Aws
29 {
30 namespace Utils
31 {
32 namespace Json
33 {
34  class JsonValue;
35 } // namespace Json
36 } // namespace Utils
37 namespace Snowball
38 {
39 namespace Model
40 {
41 
48  {
49  public:
50  JobMetadata();
51  JobMetadata(const Aws::Utils::Json::JsonValue& jsonValue);
52  JobMetadata& operator=(const Aws::Utils::Json::JsonValue& jsonValue);
53  Aws::Utils::Json::JsonValue Jsonize() const;
54 
59  inline const Aws::String& GetJobId() const{ return m_jobId; }
60 
65  inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; }
66 
71  inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = value; }
72 
77  inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); }
78 
83  inline JobMetadata& WithJobId(const Aws::String& value) { SetJobId(value); return *this;}
84 
89  inline JobMetadata& WithJobId(Aws::String&& value) { SetJobId(value); return *this;}
90 
95  inline JobMetadata& WithJobId(const char* value) { SetJobId(value); return *this;}
96 
100  inline const JobState& GetJobState() const{ return m_jobState; }
101 
105  inline void SetJobState(const JobState& value) { m_jobStateHasBeenSet = true; m_jobState = value; }
106 
110  inline void SetJobState(JobState&& value) { m_jobStateHasBeenSet = true; m_jobState = value; }
111 
115  inline JobMetadata& WithJobState(const JobState& value) { SetJobState(value); return *this;}
116 
120  inline JobMetadata& WithJobState(JobState&& value) { SetJobState(value); return *this;}
121 
125  inline const JobType& GetJobType() const{ return m_jobType; }
126 
130  inline void SetJobType(const JobType& value) { m_jobTypeHasBeenSet = true; m_jobType = value; }
131 
135  inline void SetJobType(JobType&& value) { m_jobTypeHasBeenSet = true; m_jobType = value; }
136 
140  inline JobMetadata& WithJobType(const JobType& value) { SetJobType(value); return *this;}
141 
145  inline JobMetadata& WithJobType(JobType&& value) { SetJobType(value); return *this;}
146 
150  inline const Aws::Utils::DateTime& GetCreationDate() const{ return m_creationDate; }
151 
155  inline void SetCreationDate(const Aws::Utils::DateTime& value) { m_creationDateHasBeenSet = true; m_creationDate = value; }
156 
160  inline void SetCreationDate(Aws::Utils::DateTime&& value) { m_creationDateHasBeenSet = true; m_creationDate = value; }
161 
165  inline JobMetadata& WithCreationDate(const Aws::Utils::DateTime& value) { SetCreationDate(value); return *this;}
166 
170  inline JobMetadata& WithCreationDate(Aws::Utils::DateTime&& value) { SetCreationDate(value); return *this;}
171 
177  inline const JobResource& GetResources() const{ return m_resources; }
178 
184  inline void SetResources(const JobResource& value) { m_resourcesHasBeenSet = true; m_resources = value; }
185 
191  inline void SetResources(JobResource&& value) { m_resourcesHasBeenSet = true; m_resources = value; }
192 
198  inline JobMetadata& WithResources(const JobResource& value) { SetResources(value); return *this;}
199 
205  inline JobMetadata& WithResources(JobResource&& value) { SetResources(value); return *this;}
206 
210  inline const Aws::String& GetDescription() const{ return m_description; }
211 
215  inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
216 
220  inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = value; }
221 
225  inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
226 
230  inline JobMetadata& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
231 
235  inline JobMetadata& WithDescription(Aws::String&& value) { SetDescription(value); return *this;}
236 
240  inline JobMetadata& WithDescription(const char* value) { SetDescription(value); return *this;}
241 
247  inline const Aws::String& GetKmsKeyARN() const{ return m_kmsKeyARN; }
248 
254  inline void SetKmsKeyARN(const Aws::String& value) { m_kmsKeyARNHasBeenSet = true; m_kmsKeyARN = value; }
255 
261  inline void SetKmsKeyARN(Aws::String&& value) { m_kmsKeyARNHasBeenSet = true; m_kmsKeyARN = value; }
262 
268  inline void SetKmsKeyARN(const char* value) { m_kmsKeyARNHasBeenSet = true; m_kmsKeyARN.assign(value); }
269 
275  inline JobMetadata& WithKmsKeyARN(const Aws::String& value) { SetKmsKeyARN(value); return *this;}
276 
282  inline JobMetadata& WithKmsKeyARN(Aws::String&& value) { SetKmsKeyARN(value); return *this;}
283 
289  inline JobMetadata& WithKmsKeyARN(const char* value) { SetKmsKeyARN(value); return *this;}
290 
296  inline const Aws::String& GetRoleARN() const{ return m_roleARN; }
297 
303  inline void SetRoleARN(const Aws::String& value) { m_roleARNHasBeenSet = true; m_roleARN = value; }
304 
310  inline void SetRoleARN(Aws::String&& value) { m_roleARNHasBeenSet = true; m_roleARN = value; }
311 
317  inline void SetRoleARN(const char* value) { m_roleARNHasBeenSet = true; m_roleARN.assign(value); }
318 
324  inline JobMetadata& WithRoleARN(const Aws::String& value) { SetRoleARN(value); return *this;}
325 
331  inline JobMetadata& WithRoleARN(Aws::String&& value) { SetRoleARN(value); return *this;}
332 
338  inline JobMetadata& WithRoleARN(const char* value) { SetRoleARN(value); return *this;}
339 
343  inline const Aws::String& GetAddressId() const{ return m_addressId; }
344 
348  inline void SetAddressId(const Aws::String& value) { m_addressIdHasBeenSet = true; m_addressId = value; }
349 
353  inline void SetAddressId(Aws::String&& value) { m_addressIdHasBeenSet = true; m_addressId = value; }
354 
358  inline void SetAddressId(const char* value) { m_addressIdHasBeenSet = true; m_addressId.assign(value); }
359 
363  inline JobMetadata& WithAddressId(const Aws::String& value) { SetAddressId(value); return *this;}
364 
368  inline JobMetadata& WithAddressId(Aws::String&& value) { SetAddressId(value); return *this;}
369 
373  inline JobMetadata& WithAddressId(const char* value) { SetAddressId(value); return *this;}
374 
379  inline const ShippingDetails& GetShippingDetails() const{ return m_shippingDetails; }
380 
385  inline void SetShippingDetails(const ShippingDetails& value) { m_shippingDetailsHasBeenSet = true; m_shippingDetails = value; }
386 
391  inline void SetShippingDetails(ShippingDetails&& value) { m_shippingDetailsHasBeenSet = true; m_shippingDetails = value; }
392 
397  inline JobMetadata& WithShippingDetails(const ShippingDetails& value) { SetShippingDetails(value); return *this;}
398 
403  inline JobMetadata& WithShippingDetails(ShippingDetails&& value) { SetShippingDetails(value); return *this;}
404 
410  inline const SnowballCapacity& GetSnowballCapacityPreference() const{ return m_snowballCapacityPreference; }
411 
417  inline void SetSnowballCapacityPreference(const SnowballCapacity& value) { m_snowballCapacityPreferenceHasBeenSet = true; m_snowballCapacityPreference = value; }
418 
424  inline void SetSnowballCapacityPreference(SnowballCapacity&& value) { m_snowballCapacityPreferenceHasBeenSet = true; m_snowballCapacityPreference = value; }
425 
431  inline JobMetadata& WithSnowballCapacityPreference(const SnowballCapacity& value) { SetSnowballCapacityPreference(value); return *this;}
432 
438  inline JobMetadata& WithSnowballCapacityPreference(SnowballCapacity&& value) { SetSnowballCapacityPreference(value); return *this;}
439 
446  inline const Notification& GetNotification() const{ return m_notification; }
447 
454  inline void SetNotification(const Notification& value) { m_notificationHasBeenSet = true; m_notification = value; }
455 
462  inline void SetNotification(Notification&& value) { m_notificationHasBeenSet = true; m_notification = value; }
463 
470  inline JobMetadata& WithNotification(const Notification& value) { SetNotification(value); return *this;}
471 
478  inline JobMetadata& WithNotification(Notification&& value) { SetNotification(value); return *this;}
479 
486  inline const DataTransfer& GetDataTransferProgress() const{ return m_dataTransferProgress; }
487 
494  inline void SetDataTransferProgress(const DataTransfer& value) { m_dataTransferProgressHasBeenSet = true; m_dataTransferProgress = value; }
495 
502  inline void SetDataTransferProgress(DataTransfer&& value) { m_dataTransferProgressHasBeenSet = true; m_dataTransferProgress = value; }
503 
510  inline JobMetadata& WithDataTransferProgress(const DataTransfer& value) { SetDataTransferProgress(value); return *this;}
511 
518  inline JobMetadata& WithDataTransferProgress(DataTransfer&& value) { SetDataTransferProgress(value); return *this;}
519 
526  inline const JobLogs& GetJobLogInfo() const{ return m_jobLogInfo; }
527 
534  inline void SetJobLogInfo(const JobLogs& value) { m_jobLogInfoHasBeenSet = true; m_jobLogInfo = value; }
535 
542  inline void SetJobLogInfo(JobLogs&& value) { m_jobLogInfoHasBeenSet = true; m_jobLogInfo = value; }
543 
550  inline JobMetadata& WithJobLogInfo(const JobLogs& value) { SetJobLogInfo(value); return *this;}
551 
558  inline JobMetadata& WithJobLogInfo(JobLogs&& value) { SetJobLogInfo(value); return *this;}
559 
560  private:
561  Aws::String m_jobId;
562  bool m_jobIdHasBeenSet;
563  JobState m_jobState;
564  bool m_jobStateHasBeenSet;
565  JobType m_jobType;
566  bool m_jobTypeHasBeenSet;
567  Aws::Utils::DateTime m_creationDate;
568  bool m_creationDateHasBeenSet;
569  JobResource m_resources;
570  bool m_resourcesHasBeenSet;
571  Aws::String m_description;
572  bool m_descriptionHasBeenSet;
573  Aws::String m_kmsKeyARN;
574  bool m_kmsKeyARNHasBeenSet;
575  Aws::String m_roleARN;
576  bool m_roleARNHasBeenSet;
577  Aws::String m_addressId;
578  bool m_addressIdHasBeenSet;
579  ShippingDetails m_shippingDetails;
580  bool m_shippingDetailsHasBeenSet;
581  SnowballCapacity m_snowballCapacityPreference;
582  bool m_snowballCapacityPreferenceHasBeenSet;
583  Notification m_notification;
584  bool m_notificationHasBeenSet;
585  DataTransfer m_dataTransferProgress;
586  bool m_dataTransferProgressHasBeenSet;
587  JobLogs m_jobLogInfo;
588  bool m_jobLogInfoHasBeenSet;
589  };
590 
591 } // namespace Model
592 } // namespace Snowball
593 } // namespace Aws
JobMetadata & WithDescription(Aws::String &&value)
Definition: JobMetadata.h:235
void SetResources(JobResource &&value)
Definition: JobMetadata.h:191
JobMetadata & WithJobId(const Aws::String &value)
Definition: JobMetadata.h:83
const JobLogs & GetJobLogInfo() const
Definition: JobMetadata.h:526
JobMetadata & WithJobType(const JobType &value)
Definition: JobMetadata.h:140
const DataTransfer & GetDataTransferProgress() const
Definition: JobMetadata.h:486
void SetDataTransferProgress(const DataTransfer &value)
Definition: JobMetadata.h:494
void SetResources(const JobResource &value)
Definition: JobMetadata.h:184
JobMetadata & WithSnowballCapacityPreference(SnowballCapacity &&value)
Definition: JobMetadata.h:438
JobMetadata & WithKmsKeyARN(Aws::String &&value)
Definition: JobMetadata.h:282
void SetJobType(const JobType &value)
Definition: JobMetadata.h:130
void SetRoleARN(Aws::String &&value)
Definition: JobMetadata.h:310
JobMetadata & WithRoleARN(Aws::String &&value)
Definition: JobMetadata.h:331
JobMetadata & WithCreationDate(Aws::Utils::DateTime &&value)
Definition: JobMetadata.h:170
void SetJobLogInfo(JobLogs &&value)
Definition: JobMetadata.h:542
void SetSnowballCapacityPreference(const SnowballCapacity &value)
Definition: JobMetadata.h:417
JobMetadata & WithDataTransferProgress(const DataTransfer &value)
Definition: JobMetadata.h:510
JobMetadata & WithKmsKeyARN(const Aws::String &value)
Definition: JobMetadata.h:275
const Aws::String & GetRoleARN() const
Definition: JobMetadata.h:296
JobMetadata & WithAddressId(const Aws::String &value)
Definition: JobMetadata.h:363
const JobResource & GetResources() const
Definition: JobMetadata.h:177
const Aws::String & GetKmsKeyARN() const
Definition: JobMetadata.h:247
JobMetadata & WithAddressId(const char *value)
Definition: JobMetadata.h:373
const Aws::String & GetJobId() const
Definition: JobMetadata.h:59
void SetCreationDate(Aws::Utils::DateTime &&value)
Definition: JobMetadata.h:160
void SetSnowballCapacityPreference(SnowballCapacity &&value)
Definition: JobMetadata.h:424
void SetJobState(JobState &&value)
Definition: JobMetadata.h:110
JobMetadata & WithNotification(const Notification &value)
Definition: JobMetadata.h:470
void SetJobId(const char *value)
Definition: JobMetadata.h:77
void SetNotification(const Notification &value)
Definition: JobMetadata.h:454
JobMetadata & WithJobLogInfo(const JobLogs &value)
Definition: JobMetadata.h:550
void SetDescription(Aws::String &&value)
Definition: JobMetadata.h:220
void SetAddressId(const char *value)
Definition: JobMetadata.h:358
const JobState & GetJobState() const
Definition: JobMetadata.h:100
void SetJobId(Aws::String &&value)
Definition: JobMetadata.h:71
const JobType & GetJobType() const
Definition: JobMetadata.h:125
void SetJobId(const Aws::String &value)
Definition: JobMetadata.h:65
void SetJobState(const JobState &value)
Definition: JobMetadata.h:105
JobMetadata & WithAddressId(Aws::String &&value)
Definition: JobMetadata.h:368
void SetShippingDetails(ShippingDetails &&value)
Definition: JobMetadata.h:391
JobMetadata & WithRoleARN(const char *value)
Definition: JobMetadata.h:338
JobMetadata & WithShippingDetails(const ShippingDetails &value)
Definition: JobMetadata.h:397
const Notification & GetNotification() const
Definition: JobMetadata.h:446
void SetCreationDate(const Aws::Utils::DateTime &value)
Definition: JobMetadata.h:155
void SetJobType(JobType &&value)
Definition: JobMetadata.h:135
JobMetadata & WithSnowballCapacityPreference(const SnowballCapacity &value)
Definition: JobMetadata.h:431
JobMetadata & WithNotification(Notification &&value)
Definition: JobMetadata.h:478
JobMetadata & WithJobType(JobType &&value)
Definition: JobMetadata.h:145
void SetKmsKeyARN(Aws::String &&value)
Definition: JobMetadata.h:261
#define AWS_SNOWBALL_API
JobMetadata & WithDataTransferProgress(DataTransfer &&value)
Definition: JobMetadata.h:518
JobMetadata & WithCreationDate(const Aws::Utils::DateTime &value)
Definition: JobMetadata.h:165
void SetShippingDetails(const ShippingDetails &value)
Definition: JobMetadata.h:385
JobMetadata & WithJobId(const char *value)
Definition: JobMetadata.h:95
JobMetadata & WithJobState(const JobState &value)
Definition: JobMetadata.h:115
JobMetadata & WithJobLogInfo(JobLogs &&value)
Definition: JobMetadata.h:558
JobMetadata & WithJobId(Aws::String &&value)
Definition: JobMetadata.h:89
void SetJobLogInfo(const JobLogs &value)
Definition: JobMetadata.h:534
JobMetadata & WithResources(const JobResource &value)
Definition: JobMetadata.h:198
JobMetadata & WithShippingDetails(ShippingDetails &&value)
Definition: JobMetadata.h:403
void SetKmsKeyARN(const char *value)
Definition: JobMetadata.h:268
const Aws::String & GetDescription() const
Definition: JobMetadata.h:210
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
void SetDataTransferProgress(DataTransfer &&value)
Definition: JobMetadata.h:502
void SetDescription(const char *value)
Definition: JobMetadata.h:225
JobMetadata & WithDescription(const Aws::String &value)
Definition: JobMetadata.h:230
void SetAddressId(const Aws::String &value)
Definition: JobMetadata.h:348
void SetRoleARN(const char *value)
Definition: JobMetadata.h:317
void SetRoleARN(const Aws::String &value)
Definition: JobMetadata.h:303
JobMetadata & WithJobState(JobState &&value)
Definition: JobMetadata.h:120
JobMetadata & WithKmsKeyARN(const char *value)
Definition: JobMetadata.h:289
const Aws::Utils::DateTime & GetCreationDate() const
Definition: JobMetadata.h:150
JobMetadata & WithRoleARN(const Aws::String &value)
Definition: JobMetadata.h:324
void SetAddressId(Aws::String &&value)
Definition: JobMetadata.h:353
JobMetadata & WithDescription(const char *value)
Definition: JobMetadata.h:240
const ShippingDetails & GetShippingDetails() const
Definition: JobMetadata.h:379
JobMetadata & WithResources(JobResource &&value)
Definition: JobMetadata.h:205
void SetKmsKeyARN(const Aws::String &value)
Definition: JobMetadata.h:254
void SetNotification(Notification &&value)
Definition: JobMetadata.h:462
void SetDescription(const Aws::String &value)
Definition: JobMetadata.h:215
const SnowballCapacity & GetSnowballCapacityPreference() const
Definition: JobMetadata.h:410
JSON (JavaScript Object Notation).
const Aws::String & GetAddressId() const
Definition: JobMetadata.h:343