AWS SDK for C++

AWS SDK for C++ Version 1.11.760

Loading...
Searching...
No Matches
GlacierJobDescription.h
1
6#pragma once
7#include <aws/core/utils/memory/stl/AWSString.h>
8#include <aws/glacier/Glacier_EXPORTS.h>
9#include <aws/glacier/model/ActionCode.h>
10#include <aws/glacier/model/InventoryRetrievalJobDescription.h>
11#include <aws/glacier/model/OutputLocation.h>
12#include <aws/glacier/model/SelectParameters.h>
13#include <aws/glacier/model/StatusCode.h>
14
15#include <utility>
16
17namespace Aws {
18namespace Utils {
19namespace Json {
20class JsonValue;
21class JsonView;
22} // namespace Json
23} // namespace Utils
24namespace Glacier {
25namespace Model {
26
34 public:
35 AWS_GLACIER_API GlacierJobDescription() = default;
38 AWS_GLACIER_API Aws::Utils::Json::JsonValue Jsonize() const;
39
41
44 inline const Aws::String& GetJobId() const { return m_jobId; }
45 inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; }
46 template <typename JobIdT = Aws::String>
47 void SetJobId(JobIdT&& value) {
48 m_jobIdHasBeenSet = true;
49 m_jobId = std::forward<JobIdT>(value);
50 }
51 template <typename JobIdT = Aws::String>
53 SetJobId(std::forward<JobIdT>(value));
54 return *this;
55 }
57
59
62 inline const Aws::String& GetJobDescription() const { return m_jobDescription; }
63 inline bool JobDescriptionHasBeenSet() const { return m_jobDescriptionHasBeenSet; }
64 template <typename JobDescriptionT = Aws::String>
65 void SetJobDescription(JobDescriptionT&& value) {
66 m_jobDescriptionHasBeenSet = true;
67 m_jobDescription = std::forward<JobDescriptionT>(value);
68 }
69 template <typename JobDescriptionT = Aws::String>
70 GlacierJobDescription& WithJobDescription(JobDescriptionT&& value) {
71 SetJobDescription(std::forward<JobDescriptionT>(value));
72 return *this;
73 }
75
77
81 inline ActionCode GetAction() const { return m_action; }
82 inline bool ActionHasBeenSet() const { return m_actionHasBeenSet; }
83 inline void SetAction(ActionCode value) {
84 m_actionHasBeenSet = true;
85 m_action = value;
86 }
88 SetAction(value);
89 return *this;
90 }
92
94
98 inline const Aws::String& GetArchiveId() const { return m_archiveId; }
99 inline bool ArchiveIdHasBeenSet() const { return m_archiveIdHasBeenSet; }
100 template <typename ArchiveIdT = Aws::String>
101 void SetArchiveId(ArchiveIdT&& value) {
102 m_archiveIdHasBeenSet = true;
103 m_archiveId = std::forward<ArchiveIdT>(value);
104 }
105 template <typename ArchiveIdT = Aws::String>
107 SetArchiveId(std::forward<ArchiveIdT>(value));
108 return *this;
109 }
111
113
117 inline const Aws::String& GetVaultARN() const { return m_vaultARN; }
118 inline bool VaultARNHasBeenSet() const { return m_vaultARNHasBeenSet; }
119 template <typename VaultARNT = Aws::String>
120 void SetVaultARN(VaultARNT&& value) {
121 m_vaultARNHasBeenSet = true;
122 m_vaultARN = std::forward<VaultARNT>(value);
123 }
124 template <typename VaultARNT = Aws::String>
126 SetVaultARN(std::forward<VaultARNT>(value));
127 return *this;
128 }
130
132
137 inline const Aws::String& GetCreationDate() const { return m_creationDate; }
138 inline bool CreationDateHasBeenSet() const { return m_creationDateHasBeenSet; }
139 template <typename CreationDateT = Aws::String>
140 void SetCreationDate(CreationDateT&& value) {
141 m_creationDateHasBeenSet = true;
142 m_creationDate = std::forward<CreationDateT>(value);
143 }
144 template <typename CreationDateT = Aws::String>
145 GlacierJobDescription& WithCreationDate(CreationDateT&& value) {
146 SetCreationDate(std::forward<CreationDateT>(value));
147 return *this;
148 }
150
152
156 inline bool GetCompleted() const { return m_completed; }
157 inline bool CompletedHasBeenSet() const { return m_completedHasBeenSet; }
158 inline void SetCompleted(bool value) {
159 m_completedHasBeenSet = true;
160 m_completed = value;
161 }
163 SetCompleted(value);
164 return *this;
165 }
167
169
173 inline StatusCode GetStatusCode() const { return m_statusCode; }
174 inline bool StatusCodeHasBeenSet() const { return m_statusCodeHasBeenSet; }
175 inline void SetStatusCode(StatusCode value) {
176 m_statusCodeHasBeenSet = true;
177 m_statusCode = value;
178 }
180 SetStatusCode(value);
181 return *this;
182 }
184
186
189 inline const Aws::String& GetStatusMessage() const { return m_statusMessage; }
190 inline bool StatusMessageHasBeenSet() const { return m_statusMessageHasBeenSet; }
191 template <typename StatusMessageT = Aws::String>
192 void SetStatusMessage(StatusMessageT&& value) {
193 m_statusMessageHasBeenSet = true;
194 m_statusMessage = std::forward<StatusMessageT>(value);
195 }
196 template <typename StatusMessageT = Aws::String>
197 GlacierJobDescription& WithStatusMessage(StatusMessageT&& value) {
198 SetStatusMessage(std::forward<StatusMessageT>(value));
199 return *this;
200 }
202
204
209 inline long long GetArchiveSizeInBytes() const { return m_archiveSizeInBytes; }
210 inline bool ArchiveSizeInBytesHasBeenSet() const { return m_archiveSizeInBytesHasBeenSet; }
211 inline void SetArchiveSizeInBytes(long long value) {
212 m_archiveSizeInBytesHasBeenSet = true;
213 m_archiveSizeInBytes = value;
214 }
217 return *this;
218 }
220
222
227 inline long long GetInventorySizeInBytes() const { return m_inventorySizeInBytes; }
228 inline bool InventorySizeInBytesHasBeenSet() const { return m_inventorySizeInBytesHasBeenSet; }
229 inline void SetInventorySizeInBytes(long long value) {
230 m_inventorySizeInBytesHasBeenSet = true;
231 m_inventorySizeInBytes = value;
232 }
235 return *this;
236 }
238
240
243 inline const Aws::String& GetSNSTopic() const { return m_sNSTopic; }
244 inline bool SNSTopicHasBeenSet() const { return m_sNSTopicHasBeenSet; }
245 template <typename SNSTopicT = Aws::String>
246 void SetSNSTopic(SNSTopicT&& value) {
247 m_sNSTopicHasBeenSet = true;
248 m_sNSTopic = std::forward<SNSTopicT>(value);
249 }
250 template <typename SNSTopicT = Aws::String>
252 SetSNSTopic(std::forward<SNSTopicT>(value));
253 return *this;
254 }
256
258
262 inline const Aws::String& GetCompletionDate() const { return m_completionDate; }
263 inline bool CompletionDateHasBeenSet() const { return m_completionDateHasBeenSet; }
264 template <typename CompletionDateT = Aws::String>
265 void SetCompletionDate(CompletionDateT&& value) {
266 m_completionDateHasBeenSet = true;
267 m_completionDate = std::forward<CompletionDateT>(value);
268 }
269 template <typename CompletionDateT = Aws::String>
270 GlacierJobDescription& WithCompletionDate(CompletionDateT&& value) {
271 SetCompletionDate(std::forward<CompletionDateT>(value));
272 return *this;
273 }
275
277
290 inline const Aws::String& GetSHA256TreeHash() const { return m_sHA256TreeHash; }
291 inline bool SHA256TreeHashHasBeenSet() const { return m_sHA256TreeHashHasBeenSet; }
292 template <typename SHA256TreeHashT = Aws::String>
293 void SetSHA256TreeHash(SHA256TreeHashT&& value) {
294 m_sHA256TreeHashHasBeenSet = true;
295 m_sHA256TreeHash = std::forward<SHA256TreeHashT>(value);
296 }
297 template <typename SHA256TreeHashT = Aws::String>
298 GlacierJobDescription& WithSHA256TreeHash(SHA256TreeHashT&& value) {
299 SetSHA256TreeHash(std::forward<SHA256TreeHashT>(value));
300 return *this;
301 }
303
305
309 inline const Aws::String& GetArchiveSHA256TreeHash() const { return m_archiveSHA256TreeHash; }
310 inline bool ArchiveSHA256TreeHashHasBeenSet() const { return m_archiveSHA256TreeHashHasBeenSet; }
311 template <typename ArchiveSHA256TreeHashT = Aws::String>
312 void SetArchiveSHA256TreeHash(ArchiveSHA256TreeHashT&& value) {
313 m_archiveSHA256TreeHashHasBeenSet = true;
314 m_archiveSHA256TreeHash = std::forward<ArchiveSHA256TreeHashT>(value);
315 }
316 template <typename ArchiveSHA256TreeHashT = Aws::String>
317 GlacierJobDescription& WithArchiveSHA256TreeHash(ArchiveSHA256TreeHashT&& value) {
318 SetArchiveSHA256TreeHash(std::forward<ArchiveSHA256TreeHashT>(value));
319 return *this;
320 }
322
324
332 inline const Aws::String& GetRetrievalByteRange() const { return m_retrievalByteRange; }
333 inline bool RetrievalByteRangeHasBeenSet() const { return m_retrievalByteRangeHasBeenSet; }
334 template <typename RetrievalByteRangeT = Aws::String>
335 void SetRetrievalByteRange(RetrievalByteRangeT&& value) {
336 m_retrievalByteRangeHasBeenSet = true;
337 m_retrievalByteRange = std::forward<RetrievalByteRangeT>(value);
338 }
339 template <typename RetrievalByteRangeT = Aws::String>
340 GlacierJobDescription& WithRetrievalByteRange(RetrievalByteRangeT&& value) {
341 SetRetrievalByteRange(std::forward<RetrievalByteRangeT>(value));
342 return *this;
343 }
345
347
352 inline const Aws::String& GetTier() const { return m_tier; }
353 inline bool TierHasBeenSet() const { return m_tierHasBeenSet; }
354 template <typename TierT = Aws::String>
355 void SetTier(TierT&& value) {
356 m_tierHasBeenSet = true;
357 m_tier = std::forward<TierT>(value);
358 }
359 template <typename TierT = Aws::String>
361 SetTier(std::forward<TierT>(value));
362 return *this;
363 }
365
367
370 inline const InventoryRetrievalJobDescription& GetInventoryRetrievalParameters() const { return m_inventoryRetrievalParameters; }
371 inline bool InventoryRetrievalParametersHasBeenSet() const { return m_inventoryRetrievalParametersHasBeenSet; }
372 template <typename InventoryRetrievalParametersT = InventoryRetrievalJobDescription>
373 void SetInventoryRetrievalParameters(InventoryRetrievalParametersT&& value) {
374 m_inventoryRetrievalParametersHasBeenSet = true;
375 m_inventoryRetrievalParameters = std::forward<InventoryRetrievalParametersT>(value);
376 }
377 template <typename InventoryRetrievalParametersT = InventoryRetrievalJobDescription>
378 GlacierJobDescription& WithInventoryRetrievalParameters(InventoryRetrievalParametersT&& value) {
379 SetInventoryRetrievalParameters(std::forward<InventoryRetrievalParametersT>(value));
380 return *this;
381 }
383
385
388 inline const Aws::String& GetJobOutputPath() const { return m_jobOutputPath; }
389 inline bool JobOutputPathHasBeenSet() const { return m_jobOutputPathHasBeenSet; }
390 template <typename JobOutputPathT = Aws::String>
391 void SetJobOutputPath(JobOutputPathT&& value) {
392 m_jobOutputPathHasBeenSet = true;
393 m_jobOutputPath = std::forward<JobOutputPathT>(value);
394 }
395 template <typename JobOutputPathT = Aws::String>
396 GlacierJobDescription& WithJobOutputPath(JobOutputPathT&& value) {
397 SetJobOutputPath(std::forward<JobOutputPathT>(value));
398 return *this;
399 }
401
403
406 inline const SelectParameters& GetSelectParameters() const { return m_selectParameters; }
407 inline bool SelectParametersHasBeenSet() const { return m_selectParametersHasBeenSet; }
408 template <typename SelectParametersT = SelectParameters>
409 void SetSelectParameters(SelectParametersT&& value) {
410 m_selectParametersHasBeenSet = true;
411 m_selectParameters = std::forward<SelectParametersT>(value);
412 }
413 template <typename SelectParametersT = SelectParameters>
414 GlacierJobDescription& WithSelectParameters(SelectParametersT&& value) {
415 SetSelectParameters(std::forward<SelectParametersT>(value));
416 return *this;
417 }
419
421
424 inline const OutputLocation& GetOutputLocation() const { return m_outputLocation; }
425 inline bool OutputLocationHasBeenSet() const { return m_outputLocationHasBeenSet; }
426 template <typename OutputLocationT = OutputLocation>
427 void SetOutputLocation(OutputLocationT&& value) {
428 m_outputLocationHasBeenSet = true;
429 m_outputLocation = std::forward<OutputLocationT>(value);
430 }
431 template <typename OutputLocationT = OutputLocation>
432 GlacierJobDescription& WithOutputLocation(OutputLocationT&& value) {
433 SetOutputLocation(std::forward<OutputLocationT>(value));
434 return *this;
435 }
437
439
440 inline const Aws::String& GetRequestId() const { return m_requestId; }
441 inline bool RequestIdHasBeenSet() const { return m_requestIdHasBeenSet; }
442 template <typename RequestIdT = Aws::String>
443 void SetRequestId(RequestIdT&& value) {
444 m_requestIdHasBeenSet = true;
445 m_requestId = std::forward<RequestIdT>(value);
446 }
447 template <typename RequestIdT = Aws::String>
449 SetRequestId(std::forward<RequestIdT>(value));
450 return *this;
451 }
453 private:
454 Aws::String m_jobId;
455
456 Aws::String m_jobDescription;
457
459
460 Aws::String m_archiveId;
461
462 Aws::String m_vaultARN;
463
464 Aws::String m_creationDate;
465
466 bool m_completed{false};
467
468 StatusCode m_statusCode{StatusCode::NOT_SET};
469
470 Aws::String m_statusMessage;
471
472 long long m_archiveSizeInBytes{0};
473
474 long long m_inventorySizeInBytes{0};
475
476 Aws::String m_sNSTopic;
477
478 Aws::String m_completionDate;
479
480 Aws::String m_sHA256TreeHash;
481
482 Aws::String m_archiveSHA256TreeHash;
483
484 Aws::String m_retrievalByteRange;
485
486 Aws::String m_tier;
487
488 InventoryRetrievalJobDescription m_inventoryRetrievalParameters;
489
490 Aws::String m_jobOutputPath;
491
492 SelectParameters m_selectParameters;
493
494 OutputLocation m_outputLocation;
495
496 Aws::String m_requestId;
497 bool m_jobIdHasBeenSet = false;
498 bool m_jobDescriptionHasBeenSet = false;
499 bool m_actionHasBeenSet = false;
500 bool m_archiveIdHasBeenSet = false;
501 bool m_vaultARNHasBeenSet = false;
502 bool m_creationDateHasBeenSet = false;
503 bool m_completedHasBeenSet = false;
504 bool m_statusCodeHasBeenSet = false;
505 bool m_statusMessageHasBeenSet = false;
506 bool m_archiveSizeInBytesHasBeenSet = false;
507 bool m_inventorySizeInBytesHasBeenSet = false;
508 bool m_sNSTopicHasBeenSet = false;
509 bool m_completionDateHasBeenSet = false;
510 bool m_sHA256TreeHashHasBeenSet = false;
511 bool m_archiveSHA256TreeHashHasBeenSet = false;
512 bool m_retrievalByteRangeHasBeenSet = false;
513 bool m_tierHasBeenSet = false;
514 bool m_inventoryRetrievalParametersHasBeenSet = false;
515 bool m_jobOutputPathHasBeenSet = false;
516 bool m_selectParametersHasBeenSet = false;
517 bool m_outputLocationHasBeenSet = false;
518 bool m_requestIdHasBeenSet = false;
519};
520
521} // namespace Model
522} // namespace Glacier
523} // namespace Aws
GlacierJobDescription & WithJobOutputPath(JobOutputPathT &&value)
GlacierJobDescription & WithRetrievalByteRange(RetrievalByteRangeT &&value)
GlacierJobDescription & WithJobId(JobIdT &&value)
const InventoryRetrievalJobDescription & GetInventoryRetrievalParameters() const
GlacierJobDescription & WithInventorySizeInBytes(long long value)
GlacierJobDescription & WithStatusCode(StatusCode value)
GlacierJobDescription & WithArchiveId(ArchiveIdT &&value)
GlacierJobDescription & WithRequestId(RequestIdT &&value)
GlacierJobDescription & WithSNSTopic(SNSTopicT &&value)
AWS_GLACIER_API GlacierJobDescription()=default
GlacierJobDescription & WithVaultARN(VaultARNT &&value)
GlacierJobDescription & WithArchiveSizeInBytes(long long value)
const OutputLocation & GetOutputLocation() const
GlacierJobDescription & WithSHA256TreeHash(SHA256TreeHashT &&value)
AWS_GLACIER_API GlacierJobDescription(Aws::Utils::Json::JsonView jsonValue)
void SetRetrievalByteRange(RetrievalByteRangeT &&value)
void SetSelectParameters(SelectParametersT &&value)
GlacierJobDescription & WithCreationDate(CreationDateT &&value)
void SetInventoryRetrievalParameters(InventoryRetrievalParametersT &&value)
GlacierJobDescription & WithArchiveSHA256TreeHash(ArchiveSHA256TreeHashT &&value)
GlacierJobDescription & WithInventoryRetrievalParameters(InventoryRetrievalParametersT &&value)
AWS_GLACIER_API Aws::Utils::Json::JsonValue Jsonize() const
GlacierJobDescription & WithSelectParameters(SelectParametersT &&value)
GlacierJobDescription & WithOutputLocation(OutputLocationT &&value)
AWS_GLACIER_API GlacierJobDescription & operator=(Aws::Utils::Json::JsonView jsonValue)
GlacierJobDescription & WithTier(TierT &&value)
GlacierJobDescription & WithAction(ActionCode value)
void SetArchiveSHA256TreeHash(ArchiveSHA256TreeHashT &&value)
GlacierJobDescription & WithStatusMessage(StatusMessageT &&value)
const SelectParameters & GetSelectParameters() const
void SetJobDescription(JobDescriptionT &&value)
GlacierJobDescription & WithCompleted(bool value)
GlacierJobDescription & WithJobDescription(JobDescriptionT &&value)
GlacierJobDescription & WithCompletionDate(CompletionDateT &&value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Aws::Utils::Json::JsonValue JsonValue