AWS SDK for C++  0.14.3
AWS SDK for C++
GlacierJobDescription.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
21 
22 namespace Aws
23 {
24 namespace Utils
25 {
26 namespace Json
27 {
28  class JsonValue;
29 } // namespace Json
30 } // namespace Utils
31 namespace Glacier
32 {
33 namespace Model
34 {
35 
40  {
41  public:
44  GlacierJobDescription& operator=(const Aws::Utils::Json::JsonValue& jsonValue);
45  Aws::Utils::Json::JsonValue Jsonize() const;
46 
50  inline const Aws::String& GetJobId() const{ return m_jobId; }
51 
55  inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; }
56 
60  inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = value; }
61 
65  inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); }
66 
70  inline GlacierJobDescription& WithJobId(const Aws::String& value) { SetJobId(value); return *this;}
71 
75  inline GlacierJobDescription& WithJobId(Aws::String&& value) { SetJobId(value); return *this;}
76 
80  inline GlacierJobDescription& WithJobId(const char* value) { SetJobId(value); return *this;}
81 
85  inline const Aws::String& GetJobDescription() const{ return m_jobDescription; }
86 
90  inline void SetJobDescription(const Aws::String& value) { m_jobDescriptionHasBeenSet = true; m_jobDescription = value; }
91 
95  inline void SetJobDescription(Aws::String&& value) { m_jobDescriptionHasBeenSet = true; m_jobDescription = value; }
96 
100  inline void SetJobDescription(const char* value) { m_jobDescriptionHasBeenSet = true; m_jobDescription.assign(value); }
101 
105  inline GlacierJobDescription& WithJobDescription(const Aws::String& value) { SetJobDescription(value); return *this;}
106 
110  inline GlacierJobDescription& WithJobDescription(Aws::String&& value) { SetJobDescription(value); return *this;}
111 
115  inline GlacierJobDescription& WithJobDescription(const char* value) { SetJobDescription(value); return *this;}
116 
120  inline const ActionCode& GetAction() const{ return m_action; }
121 
125  inline void SetAction(const ActionCode& value) { m_actionHasBeenSet = true; m_action = value; }
126 
130  inline void SetAction(ActionCode&& value) { m_actionHasBeenSet = true; m_action = value; }
131 
135  inline GlacierJobDescription& WithAction(const ActionCode& value) { SetAction(value); return *this;}
136 
140  inline GlacierJobDescription& WithAction(ActionCode&& value) { SetAction(value); return *this;}
141 
146  inline const Aws::String& GetArchiveId() const{ return m_archiveId; }
147 
152  inline void SetArchiveId(const Aws::String& value) { m_archiveIdHasBeenSet = true; m_archiveId = value; }
153 
158  inline void SetArchiveId(Aws::String&& value) { m_archiveIdHasBeenSet = true; m_archiveId = value; }
159 
164  inline void SetArchiveId(const char* value) { m_archiveIdHasBeenSet = true; m_archiveId.assign(value); }
165 
170  inline GlacierJobDescription& WithArchiveId(const Aws::String& value) { SetArchiveId(value); return *this;}
171 
176  inline GlacierJobDescription& WithArchiveId(Aws::String&& value) { SetArchiveId(value); return *this;}
177 
182  inline GlacierJobDescription& WithArchiveId(const char* value) { SetArchiveId(value); return *this;}
183 
188  inline const Aws::String& GetVaultARN() const{ return m_vaultARN; }
189 
194  inline void SetVaultARN(const Aws::String& value) { m_vaultARNHasBeenSet = true; m_vaultARN = value; }
195 
200  inline void SetVaultARN(Aws::String&& value) { m_vaultARNHasBeenSet = true; m_vaultARN = value; }
201 
206  inline void SetVaultARN(const char* value) { m_vaultARNHasBeenSet = true; m_vaultARN.assign(value); }
207 
212  inline GlacierJobDescription& WithVaultARN(const Aws::String& value) { SetVaultARN(value); return *this;}
213 
218  inline GlacierJobDescription& WithVaultARN(Aws::String&& value) { SetVaultARN(value); return *this;}
219 
224  inline GlacierJobDescription& WithVaultARN(const char* value) { SetVaultARN(value); return *this;}
225 
230  inline const Aws::String& GetCreationDate() const{ return m_creationDate; }
231 
236  inline void SetCreationDate(const Aws::String& value) { m_creationDateHasBeenSet = true; m_creationDate = value; }
237 
242  inline void SetCreationDate(Aws::String&& value) { m_creationDateHasBeenSet = true; m_creationDate = value; }
243 
248  inline void SetCreationDate(const char* value) { m_creationDateHasBeenSet = true; m_creationDate.assign(value); }
249 
254  inline GlacierJobDescription& WithCreationDate(const Aws::String& value) { SetCreationDate(value); return *this;}
255 
260  inline GlacierJobDescription& WithCreationDate(Aws::String&& value) { SetCreationDate(value); return *this;}
261 
266  inline GlacierJobDescription& WithCreationDate(const char* value) { SetCreationDate(value); return *this;}
267 
271  inline bool GetCompleted() const{ return m_completed; }
272 
276  inline void SetCompleted(bool value) { m_completedHasBeenSet = true; m_completed = value; }
277 
281  inline GlacierJobDescription& WithCompleted(bool value) { SetCompleted(value); return *this;}
282 
287  inline const StatusCode& GetStatusCode() const{ return m_statusCode; }
288 
293  inline void SetStatusCode(const StatusCode& value) { m_statusCodeHasBeenSet = true; m_statusCode = value; }
294 
299  inline void SetStatusCode(StatusCode&& value) { m_statusCodeHasBeenSet = true; m_statusCode = value; }
300 
305  inline GlacierJobDescription& WithStatusCode(const StatusCode& value) { SetStatusCode(value); return *this;}
306 
311  inline GlacierJobDescription& WithStatusCode(StatusCode&& value) { SetStatusCode(value); return *this;}
312 
316  inline const Aws::String& GetStatusMessage() const{ return m_statusMessage; }
317 
321  inline void SetStatusMessage(const Aws::String& value) { m_statusMessageHasBeenSet = true; m_statusMessage = value; }
322 
326  inline void SetStatusMessage(Aws::String&& value) { m_statusMessageHasBeenSet = true; m_statusMessage = value; }
327 
331  inline void SetStatusMessage(const char* value) { m_statusMessageHasBeenSet = true; m_statusMessage.assign(value); }
332 
336  inline GlacierJobDescription& WithStatusMessage(const Aws::String& value) { SetStatusMessage(value); return *this;}
337 
341  inline GlacierJobDescription& WithStatusMessage(Aws::String&& value) { SetStatusMessage(value); return *this;}
342 
346  inline GlacierJobDescription& WithStatusMessage(const char* value) { SetStatusMessage(value); return *this;}
347 
352  inline long long GetArchiveSizeInBytes() const{ return m_archiveSizeInBytes; }
353 
358  inline void SetArchiveSizeInBytes(long long value) { m_archiveSizeInBytesHasBeenSet = true; m_archiveSizeInBytes = value; }
359 
364  inline GlacierJobDescription& WithArchiveSizeInBytes(long long value) { SetArchiveSizeInBytes(value); return *this;}
365 
370  inline long long GetInventorySizeInBytes() const{ return m_inventorySizeInBytes; }
371 
376  inline void SetInventorySizeInBytes(long long value) { m_inventorySizeInBytesHasBeenSet = true; m_inventorySizeInBytes = value; }
377 
382  inline GlacierJobDescription& WithInventorySizeInBytes(long long value) { SetInventorySizeInBytes(value); return *this;}
383 
388  inline const Aws::String& GetSNSTopic() const{ return m_sNSTopic; }
389 
394  inline void SetSNSTopic(const Aws::String& value) { m_sNSTopicHasBeenSet = true; m_sNSTopic = value; }
395 
400  inline void SetSNSTopic(Aws::String&& value) { m_sNSTopicHasBeenSet = true; m_sNSTopic = value; }
401 
406  inline void SetSNSTopic(const char* value) { m_sNSTopicHasBeenSet = true; m_sNSTopic.assign(value); }
407 
412  inline GlacierJobDescription& WithSNSTopic(const Aws::String& value) { SetSNSTopic(value); return *this;}
413 
418  inline GlacierJobDescription& WithSNSTopic(Aws::String&& value) { SetSNSTopic(value); return *this;}
419 
424  inline GlacierJobDescription& WithSNSTopic(const char* value) { SetSNSTopic(value); return *this;}
425 
430  inline const Aws::String& GetCompletionDate() const{ return m_completionDate; }
431 
436  inline void SetCompletionDate(const Aws::String& value) { m_completionDateHasBeenSet = true; m_completionDate = value; }
437 
442  inline void SetCompletionDate(Aws::String&& value) { m_completionDateHasBeenSet = true; m_completionDate = value; }
443 
448  inline void SetCompletionDate(const char* value) { m_completionDateHasBeenSet = true; m_completionDate.assign(value); }
449 
454  inline GlacierJobDescription& WithCompletionDate(const Aws::String& value) { SetCompletionDate(value); return *this;}
455 
460  inline GlacierJobDescription& WithCompletionDate(Aws::String&& value) { SetCompletionDate(value); return *this;}
461 
466  inline GlacierJobDescription& WithCompletionDate(const char* value) { SetCompletionDate(value); return *this;}
467 
480  inline const Aws::String& GetSHA256TreeHash() const{ return m_sHA256TreeHash; }
481 
494  inline void SetSHA256TreeHash(const Aws::String& value) { m_sHA256TreeHashHasBeenSet = true; m_sHA256TreeHash = value; }
495 
508  inline void SetSHA256TreeHash(Aws::String&& value) { m_sHA256TreeHashHasBeenSet = true; m_sHA256TreeHash = value; }
509 
522  inline void SetSHA256TreeHash(const char* value) { m_sHA256TreeHashHasBeenSet = true; m_sHA256TreeHash.assign(value); }
523 
536  inline GlacierJobDescription& WithSHA256TreeHash(const Aws::String& value) { SetSHA256TreeHash(value); return *this;}
537 
550  inline GlacierJobDescription& WithSHA256TreeHash(Aws::String&& value) { SetSHA256TreeHash(value); return *this;}
551 
564  inline GlacierJobDescription& WithSHA256TreeHash(const char* value) { SetSHA256TreeHash(value); return *this;}
565 
570  inline const Aws::String& GetArchiveSHA256TreeHash() const{ return m_archiveSHA256TreeHash; }
571 
576  inline void SetArchiveSHA256TreeHash(const Aws::String& value) { m_archiveSHA256TreeHashHasBeenSet = true; m_archiveSHA256TreeHash = value; }
577 
582  inline void SetArchiveSHA256TreeHash(Aws::String&& value) { m_archiveSHA256TreeHashHasBeenSet = true; m_archiveSHA256TreeHash = value; }
583 
588  inline void SetArchiveSHA256TreeHash(const char* value) { m_archiveSHA256TreeHashHasBeenSet = true; m_archiveSHA256TreeHash.assign(value); }
589 
594  inline GlacierJobDescription& WithArchiveSHA256TreeHash(const Aws::String& value) { SetArchiveSHA256TreeHash(value); return *this;}
595 
600  inline GlacierJobDescription& WithArchiveSHA256TreeHash(Aws::String&& value) { SetArchiveSHA256TreeHash(value); return *this;}
601 
606  inline GlacierJobDescription& WithArchiveSHA256TreeHash(const char* value) { SetArchiveSHA256TreeHash(value); return *this;}
607 
615  inline const Aws::String& GetRetrievalByteRange() const{ return m_retrievalByteRange; }
616 
624  inline void SetRetrievalByteRange(const Aws::String& value) { m_retrievalByteRangeHasBeenSet = true; m_retrievalByteRange = value; }
625 
633  inline void SetRetrievalByteRange(Aws::String&& value) { m_retrievalByteRangeHasBeenSet = true; m_retrievalByteRange = value; }
634 
642  inline void SetRetrievalByteRange(const char* value) { m_retrievalByteRangeHasBeenSet = true; m_retrievalByteRange.assign(value); }
643 
651  inline GlacierJobDescription& WithRetrievalByteRange(const Aws::String& value) { SetRetrievalByteRange(value); return *this;}
652 
660  inline GlacierJobDescription& WithRetrievalByteRange(Aws::String&& value) { SetRetrievalByteRange(value); return *this;}
661 
669  inline GlacierJobDescription& WithRetrievalByteRange(const char* value) { SetRetrievalByteRange(value); return *this;}
670 
674  inline const InventoryRetrievalJobDescription& GetInventoryRetrievalParameters() const{ return m_inventoryRetrievalParameters; }
675 
679  inline void SetInventoryRetrievalParameters(const InventoryRetrievalJobDescription& value) { m_inventoryRetrievalParametersHasBeenSet = true; m_inventoryRetrievalParameters = value; }
680 
684  inline void SetInventoryRetrievalParameters(InventoryRetrievalJobDescription&& value) { m_inventoryRetrievalParametersHasBeenSet = true; m_inventoryRetrievalParameters = value; }
685 
689  inline GlacierJobDescription& WithInventoryRetrievalParameters(const InventoryRetrievalJobDescription& value) { SetInventoryRetrievalParameters(value); return *this;}
690 
694  inline GlacierJobDescription& WithInventoryRetrievalParameters(InventoryRetrievalJobDescription&& value) { SetInventoryRetrievalParameters(value); return *this;}
695 
696  private:
697  Aws::String m_jobId;
698  bool m_jobIdHasBeenSet;
699  Aws::String m_jobDescription;
700  bool m_jobDescriptionHasBeenSet;
701  ActionCode m_action;
702  bool m_actionHasBeenSet;
703  Aws::String m_archiveId;
704  bool m_archiveIdHasBeenSet;
705  Aws::String m_vaultARN;
706  bool m_vaultARNHasBeenSet;
707  Aws::String m_creationDate;
708  bool m_creationDateHasBeenSet;
709  bool m_completed;
710  bool m_completedHasBeenSet;
711  StatusCode m_statusCode;
712  bool m_statusCodeHasBeenSet;
713  Aws::String m_statusMessage;
714  bool m_statusMessageHasBeenSet;
715  long long m_archiveSizeInBytes;
716  bool m_archiveSizeInBytesHasBeenSet;
717  long long m_inventorySizeInBytes;
718  bool m_inventorySizeInBytesHasBeenSet;
719  Aws::String m_sNSTopic;
720  bool m_sNSTopicHasBeenSet;
721  Aws::String m_completionDate;
722  bool m_completionDateHasBeenSet;
723  Aws::String m_sHA256TreeHash;
724  bool m_sHA256TreeHashHasBeenSet;
725  Aws::String m_archiveSHA256TreeHash;
726  bool m_archiveSHA256TreeHashHasBeenSet;
727  Aws::String m_retrievalByteRange;
728  bool m_retrievalByteRangeHasBeenSet;
729  InventoryRetrievalJobDescription m_inventoryRetrievalParameters;
730  bool m_inventoryRetrievalParametersHasBeenSet;
731  };
732 
733 } // namespace Model
734 } // namespace Glacier
735 } // namespace Aws
GlacierJobDescription & WithSHA256TreeHash(const Aws::String &value)
GlacierJobDescription & WithJobDescription(const Aws::String &value)
GlacierJobDescription & WithJobId(const char *value)
GlacierJobDescription & WithJobId(Aws::String &&value)
void SetArchiveSHA256TreeHash(const Aws::String &value)
GlacierJobDescription & WithAction(const ActionCode &value)
GlacierJobDescription & WithArchiveSHA256TreeHash(const char *value)
GlacierJobDescription & WithCreationDate(Aws::String &&value)
GlacierJobDescription & WithJobId(const Aws::String &value)
GlacierJobDescription & WithVaultARN(Aws::String &&value)
GlacierJobDescription & WithStatusMessage(const Aws::String &value)
GlacierJobDescription & WithInventoryRetrievalParameters(const InventoryRetrievalJobDescription &value)
GlacierJobDescription & WithSHA256TreeHash(Aws::String &&value)
void SetCompletionDate(const Aws::String &value)
const Aws::String & GetJobDescription() const
GlacierJobDescription & WithInventorySizeInBytes(long long value)
GlacierJobDescription & WithCompleted(bool value)
GlacierJobDescription & WithArchiveId(const char *value)
void SetRetrievalByteRange(const Aws::String &value)
GlacierJobDescription & WithRetrievalByteRange(const Aws::String &value)
GlacierJobDescription & WithVaultARN(const char *value)
GlacierJobDescription & WithArchiveSHA256TreeHash(const Aws::String &value)
GlacierJobDescription & WithSHA256TreeHash(const char *value)
GlacierJobDescription & WithCompletionDate(const char *value)
GlacierJobDescription & WithCreationDate(const char *value)
GlacierJobDescription & WithArchiveSHA256TreeHash(Aws::String &&value)
void SetInventoryRetrievalParameters(InventoryRetrievalJobDescription &&value)
GlacierJobDescription & WithInventoryRetrievalParameters(InventoryRetrievalJobDescription &&value)
GlacierJobDescription & WithStatusMessage(Aws::String &&value)
GlacierJobDescription & WithStatusCode(StatusCode &&value)
GlacierJobDescription & WithArchiveId(const Aws::String &value)
void SetSHA256TreeHash(const Aws::String &value)
GlacierJobDescription & WithStatusMessage(const char *value)
void SetStatusMessage(const Aws::String &value)
GlacierJobDescription & WithRetrievalByteRange(const char *value)
void SetJobDescription(const Aws::String &value)
GlacierJobDescription & WithAction(ActionCode &&value)
const Aws::String & GetArchiveSHA256TreeHash() const
GlacierJobDescription & WithCompletionDate(Aws::String &&value)
void SetCreationDate(const Aws::String &value)
GlacierJobDescription & WithJobDescription(const char *value)
void SetInventoryRetrievalParameters(const InventoryRetrievalJobDescription &value)
GlacierJobDescription & WithVaultARN(const Aws::String &value)
GlacierJobDescription & WithRetrievalByteRange(Aws::String &&value)
GlacierJobDescription & WithSNSTopic(Aws::String &&value)
const InventoryRetrievalJobDescription & GetInventoryRetrievalParameters() const
GlacierJobDescription & WithStatusCode(const StatusCode &value)
#define AWS_GLACIER_API
const Aws::String & GetRetrievalByteRange() const
GlacierJobDescription & WithSNSTopic(const char *value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
GlacierJobDescription & WithArchiveId(Aws::String &&value)
GlacierJobDescription & WithJobDescription(Aws::String &&value)
GlacierJobDescription & WithSNSTopic(const Aws::String &value)
GlacierJobDescription & WithCompletionDate(const Aws::String &value)
GlacierJobDescription & WithCreationDate(const Aws::String &value)
GlacierJobDescription & WithArchiveSizeInBytes(long long value)
JSON (JavaScript Object Notation).