AWS SDK for C++

AWS SDK for C++ Version 1.11.763

Loading...
Searching...
No Matches
DescribeJobResult.h
1
6#pragma once
7#include <aws/core/http/HttpResponse.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/glacier/Glacier_EXPORTS.h>
10#include <aws/glacier/model/ActionCode.h>
11#include <aws/glacier/model/InventoryRetrievalJobDescription.h>
12#include <aws/glacier/model/OutputLocation.h>
13#include <aws/glacier/model/SelectParameters.h>
14#include <aws/glacier/model/StatusCode.h>
15
16#include <utility>
17
18namespace Aws {
19template <typename RESULT_TYPE>
20class AmazonWebServiceResult;
21
22namespace Utils {
23namespace Json {
24class JsonValue;
25} // namespace Json
26} // namespace Utils
27namespace Glacier {
28namespace Model {
36 public:
37 AWS_GLACIER_API DescribeJobResult() = default;
40
42
45 inline const Aws::String& GetJobId() const { return m_jobId; }
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>
52 DescribeJobResult& WithJobId(JobIdT&& value) {
53 SetJobId(std::forward<JobIdT>(value));
54 return *this;
55 }
57
59
62 inline const Aws::String& GetJobDescription() const { return m_jobDescription; }
63 template <typename JobDescriptionT = Aws::String>
64 void SetJobDescription(JobDescriptionT&& value) {
65 m_jobDescriptionHasBeenSet = true;
66 m_jobDescription = std::forward<JobDescriptionT>(value);
67 }
68 template <typename JobDescriptionT = Aws::String>
69 DescribeJobResult& WithJobDescription(JobDescriptionT&& value) {
70 SetJobDescription(std::forward<JobDescriptionT>(value));
71 return *this;
72 }
74
76
80 inline ActionCode GetAction() const { return m_action; }
81 inline void SetAction(ActionCode value) {
82 m_actionHasBeenSet = true;
83 m_action = value;
84 }
86 SetAction(value);
87 return *this;
88 }
90
92
96 inline const Aws::String& GetArchiveId() const { return m_archiveId; }
97 template <typename ArchiveIdT = Aws::String>
98 void SetArchiveId(ArchiveIdT&& value) {
99 m_archiveIdHasBeenSet = true;
100 m_archiveId = std::forward<ArchiveIdT>(value);
101 }
102 template <typename ArchiveIdT = Aws::String>
103 DescribeJobResult& WithArchiveId(ArchiveIdT&& value) {
104 SetArchiveId(std::forward<ArchiveIdT>(value));
105 return *this;
106 }
108
110
114 inline const Aws::String& GetVaultARN() const { return m_vaultARN; }
115 template <typename VaultARNT = Aws::String>
116 void SetVaultARN(VaultARNT&& value) {
117 m_vaultARNHasBeenSet = true;
118 m_vaultARN = std::forward<VaultARNT>(value);
119 }
120 template <typename VaultARNT = Aws::String>
121 DescribeJobResult& WithVaultARN(VaultARNT&& value) {
122 SetVaultARN(std::forward<VaultARNT>(value));
123 return *this;
124 }
126
128
133 inline const Aws::String& GetCreationDate() const { return m_creationDate; }
134 template <typename CreationDateT = Aws::String>
135 void SetCreationDate(CreationDateT&& value) {
136 m_creationDateHasBeenSet = true;
137 m_creationDate = std::forward<CreationDateT>(value);
138 }
139 template <typename CreationDateT = Aws::String>
140 DescribeJobResult& WithCreationDate(CreationDateT&& value) {
141 SetCreationDate(std::forward<CreationDateT>(value));
142 return *this;
143 }
145
147
151 inline bool GetCompleted() const { return m_completed; }
152 inline void SetCompleted(bool value) {
153 m_completedHasBeenSet = true;
154 m_completed = value;
155 }
156 inline DescribeJobResult& WithCompleted(bool value) {
157 SetCompleted(value);
158 return *this;
159 }
161
163
167 inline StatusCode GetStatusCode() const { return m_statusCode; }
168 inline void SetStatusCode(StatusCode value) {
169 m_statusCodeHasBeenSet = true;
170 m_statusCode = value;
171 }
173 SetStatusCode(value);
174 return *this;
175 }
177
179
182 inline const Aws::String& GetStatusMessage() const { return m_statusMessage; }
183 template <typename StatusMessageT = Aws::String>
184 void SetStatusMessage(StatusMessageT&& value) {
185 m_statusMessageHasBeenSet = true;
186 m_statusMessage = std::forward<StatusMessageT>(value);
187 }
188 template <typename StatusMessageT = Aws::String>
189 DescribeJobResult& WithStatusMessage(StatusMessageT&& value) {
190 SetStatusMessage(std::forward<StatusMessageT>(value));
191 return *this;
192 }
194
196
201 inline long long GetArchiveSizeInBytes() const { return m_archiveSizeInBytes; }
202 inline void SetArchiveSizeInBytes(long long value) {
203 m_archiveSizeInBytesHasBeenSet = true;
204 m_archiveSizeInBytes = value;
205 }
206 inline DescribeJobResult& WithArchiveSizeInBytes(long long value) {
208 return *this;
209 }
211
213
218 inline long long GetInventorySizeInBytes() const { return m_inventorySizeInBytes; }
219 inline void SetInventorySizeInBytes(long long value) {
220 m_inventorySizeInBytesHasBeenSet = true;
221 m_inventorySizeInBytes = value;
222 }
225 return *this;
226 }
228
230
233 inline const Aws::String& GetSNSTopic() const { return m_sNSTopic; }
234 template <typename SNSTopicT = Aws::String>
235 void SetSNSTopic(SNSTopicT&& value) {
236 m_sNSTopicHasBeenSet = true;
237 m_sNSTopic = std::forward<SNSTopicT>(value);
238 }
239 template <typename SNSTopicT = Aws::String>
240 DescribeJobResult& WithSNSTopic(SNSTopicT&& value) {
241 SetSNSTopic(std::forward<SNSTopicT>(value));
242 return *this;
243 }
245
247
251 inline const Aws::String& GetCompletionDate() const { return m_completionDate; }
252 template <typename CompletionDateT = Aws::String>
253 void SetCompletionDate(CompletionDateT&& value) {
254 m_completionDateHasBeenSet = true;
255 m_completionDate = std::forward<CompletionDateT>(value);
256 }
257 template <typename CompletionDateT = Aws::String>
258 DescribeJobResult& WithCompletionDate(CompletionDateT&& value) {
259 SetCompletionDate(std::forward<CompletionDateT>(value));
260 return *this;
261 }
263
265
278 inline const Aws::String& GetSHA256TreeHash() const { return m_sHA256TreeHash; }
279 template <typename SHA256TreeHashT = Aws::String>
280 void SetSHA256TreeHash(SHA256TreeHashT&& value) {
281 m_sHA256TreeHashHasBeenSet = true;
282 m_sHA256TreeHash = std::forward<SHA256TreeHashT>(value);
283 }
284 template <typename SHA256TreeHashT = Aws::String>
285 DescribeJobResult& WithSHA256TreeHash(SHA256TreeHashT&& value) {
286 SetSHA256TreeHash(std::forward<SHA256TreeHashT>(value));
287 return *this;
288 }
290
292
296 inline const Aws::String& GetArchiveSHA256TreeHash() const { return m_archiveSHA256TreeHash; }
297 template <typename ArchiveSHA256TreeHashT = Aws::String>
298 void SetArchiveSHA256TreeHash(ArchiveSHA256TreeHashT&& value) {
299 m_archiveSHA256TreeHashHasBeenSet = true;
300 m_archiveSHA256TreeHash = std::forward<ArchiveSHA256TreeHashT>(value);
301 }
302 template <typename ArchiveSHA256TreeHashT = Aws::String>
303 DescribeJobResult& WithArchiveSHA256TreeHash(ArchiveSHA256TreeHashT&& value) {
304 SetArchiveSHA256TreeHash(std::forward<ArchiveSHA256TreeHashT>(value));
305 return *this;
306 }
308
310
318 inline const Aws::String& GetRetrievalByteRange() const { return m_retrievalByteRange; }
319 template <typename RetrievalByteRangeT = Aws::String>
320 void SetRetrievalByteRange(RetrievalByteRangeT&& value) {
321 m_retrievalByteRangeHasBeenSet = true;
322 m_retrievalByteRange = std::forward<RetrievalByteRangeT>(value);
323 }
324 template <typename RetrievalByteRangeT = Aws::String>
325 DescribeJobResult& WithRetrievalByteRange(RetrievalByteRangeT&& value) {
326 SetRetrievalByteRange(std::forward<RetrievalByteRangeT>(value));
327 return *this;
328 }
330
332
337 inline const Aws::String& GetTier() const { return m_tier; }
338 template <typename TierT = Aws::String>
339 void SetTier(TierT&& value) {
340 m_tierHasBeenSet = true;
341 m_tier = std::forward<TierT>(value);
342 }
343 template <typename TierT = Aws::String>
344 DescribeJobResult& WithTier(TierT&& value) {
345 SetTier(std::forward<TierT>(value));
346 return *this;
347 }
349
351
354 inline const InventoryRetrievalJobDescription& GetInventoryRetrievalParameters() const { return m_inventoryRetrievalParameters; }
355 template <typename InventoryRetrievalParametersT = InventoryRetrievalJobDescription>
356 void SetInventoryRetrievalParameters(InventoryRetrievalParametersT&& value) {
357 m_inventoryRetrievalParametersHasBeenSet = true;
358 m_inventoryRetrievalParameters = std::forward<InventoryRetrievalParametersT>(value);
359 }
360 template <typename InventoryRetrievalParametersT = InventoryRetrievalJobDescription>
361 DescribeJobResult& WithInventoryRetrievalParameters(InventoryRetrievalParametersT&& value) {
362 SetInventoryRetrievalParameters(std::forward<InventoryRetrievalParametersT>(value));
363 return *this;
364 }
366
368
371 inline const Aws::String& GetJobOutputPath() const { return m_jobOutputPath; }
372 template <typename JobOutputPathT = Aws::String>
373 void SetJobOutputPath(JobOutputPathT&& value) {
374 m_jobOutputPathHasBeenSet = true;
375 m_jobOutputPath = std::forward<JobOutputPathT>(value);
376 }
377 template <typename JobOutputPathT = Aws::String>
378 DescribeJobResult& WithJobOutputPath(JobOutputPathT&& value) {
379 SetJobOutputPath(std::forward<JobOutputPathT>(value));
380 return *this;
381 }
383
385
388 inline const SelectParameters& GetSelectParameters() const { return m_selectParameters; }
389 template <typename SelectParametersT = SelectParameters>
390 void SetSelectParameters(SelectParametersT&& value) {
391 m_selectParametersHasBeenSet = true;
392 m_selectParameters = std::forward<SelectParametersT>(value);
393 }
394 template <typename SelectParametersT = SelectParameters>
395 DescribeJobResult& WithSelectParameters(SelectParametersT&& value) {
396 SetSelectParameters(std::forward<SelectParametersT>(value));
397 return *this;
398 }
400
402
405 inline const OutputLocation& GetOutputLocation() const { return m_outputLocation; }
406 template <typename OutputLocationT = OutputLocation>
407 void SetOutputLocation(OutputLocationT&& value) {
408 m_outputLocationHasBeenSet = true;
409 m_outputLocation = std::forward<OutputLocationT>(value);
410 }
411 template <typename OutputLocationT = OutputLocation>
412 DescribeJobResult& WithOutputLocation(OutputLocationT&& value) {
413 SetOutputLocation(std::forward<OutputLocationT>(value));
414 return *this;
415 }
417
419
420 inline const Aws::String& GetRequestId() const { return m_requestId; }
421 template <typename RequestIdT = Aws::String>
422 void SetRequestId(RequestIdT&& value) {
423 m_requestIdHasBeenSet = true;
424 m_requestId = std::forward<RequestIdT>(value);
425 }
426 template <typename RequestIdT = Aws::String>
427 DescribeJobResult& WithRequestId(RequestIdT&& value) {
428 SetRequestId(std::forward<RequestIdT>(value));
429 return *this;
430 }
432 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
433
434 private:
435 Aws::String m_jobId;
436
437 Aws::String m_jobDescription;
438
440
441 Aws::String m_archiveId;
442
443 Aws::String m_vaultARN;
444
445 Aws::String m_creationDate;
446
447 bool m_completed{false};
448
449 StatusCode m_statusCode{StatusCode::NOT_SET};
450
451 Aws::String m_statusMessage;
452
453 long long m_archiveSizeInBytes{0};
454
455 long long m_inventorySizeInBytes{0};
456
457 Aws::String m_sNSTopic;
458
459 Aws::String m_completionDate;
460
461 Aws::String m_sHA256TreeHash;
462
463 Aws::String m_archiveSHA256TreeHash;
464
465 Aws::String m_retrievalByteRange;
466
467 Aws::String m_tier;
468
469 InventoryRetrievalJobDescription m_inventoryRetrievalParameters;
470
471 Aws::String m_jobOutputPath;
472
473 SelectParameters m_selectParameters;
474
475 OutputLocation m_outputLocation;
476
477 Aws::String m_requestId;
478 Aws::Http::HttpResponseCode m_HttpResponseCode;
479 bool m_jobIdHasBeenSet = false;
480 bool m_jobDescriptionHasBeenSet = false;
481 bool m_actionHasBeenSet = false;
482 bool m_archiveIdHasBeenSet = false;
483 bool m_vaultARNHasBeenSet = false;
484 bool m_creationDateHasBeenSet = false;
485 bool m_completedHasBeenSet = false;
486 bool m_statusCodeHasBeenSet = false;
487 bool m_statusMessageHasBeenSet = false;
488 bool m_archiveSizeInBytesHasBeenSet = false;
489 bool m_inventorySizeInBytesHasBeenSet = false;
490 bool m_sNSTopicHasBeenSet = false;
491 bool m_completionDateHasBeenSet = false;
492 bool m_sHA256TreeHashHasBeenSet = false;
493 bool m_archiveSHA256TreeHashHasBeenSet = false;
494 bool m_retrievalByteRangeHasBeenSet = false;
495 bool m_tierHasBeenSet = false;
496 bool m_inventoryRetrievalParametersHasBeenSet = false;
497 bool m_jobOutputPathHasBeenSet = false;
498 bool m_selectParametersHasBeenSet = false;
499 bool m_outputLocationHasBeenSet = false;
500 bool m_requestIdHasBeenSet = false;
501};
502
503} // namespace Model
504} // namespace Glacier
505} // namespace Aws
AWS_GLACIER_API DescribeJobResult()=default
DescribeJobResult & WithInventoryRetrievalParameters(InventoryRetrievalParametersT &&value)
DescribeJobResult & WithSelectParameters(SelectParametersT &&value)
void SetCompletionDate(CompletionDateT &&value)
DescribeJobResult & WithArchiveSizeInBytes(long long value)
DescribeJobResult & WithInventorySizeInBytes(long long value)
const OutputLocation & GetOutputLocation() const
void SetJobDescription(JobDescriptionT &&value)
AWS_GLACIER_API DescribeJobResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeJobResult & WithStatusMessage(StatusMessageT &&value)
void SetArchiveSHA256TreeHash(ArchiveSHA256TreeHashT &&value)
const Aws::String & GetArchiveSHA256TreeHash() const
DescribeJobResult & WithArchiveId(ArchiveIdT &&value)
DescribeJobResult & WithRetrievalByteRange(RetrievalByteRangeT &&value)
AWS_GLACIER_API DescribeJobResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeJobResult & WithAction(ActionCode value)
const Aws::String & GetSNSTopic() const
const Aws::String & GetJobOutputPath() const
DescribeJobResult & WithTier(TierT &&value)
void SetOutputLocation(OutputLocationT &&value)
const Aws::String & GetCreationDate() const
DescribeJobResult & WithStatusCode(StatusCode value)
void SetCreationDate(CreationDateT &&value)
void SetSelectParameters(SelectParametersT &&value)
DescribeJobResult & WithCompletionDate(CompletionDateT &&value)
const Aws::String & GetCompletionDate() const
DescribeJobResult & WithJobId(JobIdT &&value)
DescribeJobResult & WithRequestId(RequestIdT &&value)
const Aws::String & GetRetrievalByteRange() const
const Aws::String & GetArchiveId() const
void SetStatusMessage(StatusMessageT &&value)
DescribeJobResult & WithArchiveSHA256TreeHash(ArchiveSHA256TreeHashT &&value)
void SetRetrievalByteRange(RetrievalByteRangeT &&value)
DescribeJobResult & WithJobDescription(JobDescriptionT &&value)
const Aws::String & GetStatusMessage() const
const SelectParameters & GetSelectParameters() const
DescribeJobResult & WithOutputLocation(OutputLocationT &&value)
DescribeJobResult & WithCreationDate(CreationDateT &&value)
DescribeJobResult & WithJobOutputPath(JobOutputPathT &&value)
const Aws::String & GetRequestId() const
const Aws::String & GetJobId() const
const Aws::String & GetJobDescription() const
Aws::Http::HttpResponseCode GetHttpResponseCode() const
DescribeJobResult & WithVaultARN(VaultARNT &&value)
void SetInventoryRetrievalParameters(InventoryRetrievalParametersT &&value)
void SetSHA256TreeHash(SHA256TreeHashT &&value)
const Aws::String & GetVaultARN() const
DescribeJobResult & WithSHA256TreeHash(SHA256TreeHashT &&value)
const Aws::String & GetSHA256TreeHash() const
void SetJobOutputPath(JobOutputPathT &&value)
DescribeJobResult & WithSNSTopic(SNSTopicT &&value)
DescribeJobResult & WithCompleted(bool value)
const InventoryRetrievalJobDescription & GetInventoryRetrievalParameters() const
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Aws::Utils::Json::JsonValue JsonValue