AWS SDK for C++

AWS SDK for C++ Version 1.11.741

Loading...
Searching...
No Matches
DescribeJobResult.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 {
18template <typename RESULT_TYPE>
19class AmazonWebServiceResult;
20
21namespace Utils {
22namespace Json {
23class JsonValue;
24} // namespace Json
25} // namespace Utils
26namespace Glacier {
27namespace Model {
35 public:
36 AWS_GLACIER_API DescribeJobResult() = default;
39
41
44 inline const Aws::String& GetJobId() const { return m_jobId; }
45 template <typename JobIdT = Aws::String>
46 void SetJobId(JobIdT&& value) {
47 m_jobIdHasBeenSet = true;
48 m_jobId = std::forward<JobIdT>(value);
49 }
50 template <typename JobIdT = Aws::String>
51 DescribeJobResult& WithJobId(JobIdT&& value) {
52 SetJobId(std::forward<JobIdT>(value));
53 return *this;
54 }
56
58
61 inline const Aws::String& GetJobDescription() const { return m_jobDescription; }
62 template <typename JobDescriptionT = Aws::String>
63 void SetJobDescription(JobDescriptionT&& value) {
64 m_jobDescriptionHasBeenSet = true;
65 m_jobDescription = std::forward<JobDescriptionT>(value);
66 }
67 template <typename JobDescriptionT = Aws::String>
68 DescribeJobResult& WithJobDescription(JobDescriptionT&& value) {
69 SetJobDescription(std::forward<JobDescriptionT>(value));
70 return *this;
71 }
73
75
79 inline ActionCode GetAction() const { return m_action; }
80 inline void SetAction(ActionCode value) {
81 m_actionHasBeenSet = true;
82 m_action = value;
83 }
85 SetAction(value);
86 return *this;
87 }
89
91
95 inline const Aws::String& GetArchiveId() const { return m_archiveId; }
96 template <typename ArchiveIdT = Aws::String>
97 void SetArchiveId(ArchiveIdT&& value) {
98 m_archiveIdHasBeenSet = true;
99 m_archiveId = std::forward<ArchiveIdT>(value);
100 }
101 template <typename ArchiveIdT = Aws::String>
102 DescribeJobResult& WithArchiveId(ArchiveIdT&& value) {
103 SetArchiveId(std::forward<ArchiveIdT>(value));
104 return *this;
105 }
107
109
113 inline const Aws::String& GetVaultARN() const { return m_vaultARN; }
114 template <typename VaultARNT = Aws::String>
115 void SetVaultARN(VaultARNT&& value) {
116 m_vaultARNHasBeenSet = true;
117 m_vaultARN = std::forward<VaultARNT>(value);
118 }
119 template <typename VaultARNT = Aws::String>
120 DescribeJobResult& WithVaultARN(VaultARNT&& value) {
121 SetVaultARN(std::forward<VaultARNT>(value));
122 return *this;
123 }
125
127
132 inline const Aws::String& GetCreationDate() const { return m_creationDate; }
133 template <typename CreationDateT = Aws::String>
134 void SetCreationDate(CreationDateT&& value) {
135 m_creationDateHasBeenSet = true;
136 m_creationDate = std::forward<CreationDateT>(value);
137 }
138 template <typename CreationDateT = Aws::String>
139 DescribeJobResult& WithCreationDate(CreationDateT&& value) {
140 SetCreationDate(std::forward<CreationDateT>(value));
141 return *this;
142 }
144
146
150 inline bool GetCompleted() const { return m_completed; }
151 inline void SetCompleted(bool value) {
152 m_completedHasBeenSet = true;
153 m_completed = value;
154 }
155 inline DescribeJobResult& WithCompleted(bool value) {
156 SetCompleted(value);
157 return *this;
158 }
160
162
166 inline StatusCode GetStatusCode() const { return m_statusCode; }
167 inline void SetStatusCode(StatusCode value) {
168 m_statusCodeHasBeenSet = true;
169 m_statusCode = value;
170 }
172 SetStatusCode(value);
173 return *this;
174 }
176
178
181 inline const Aws::String& GetStatusMessage() const { return m_statusMessage; }
182 template <typename StatusMessageT = Aws::String>
183 void SetStatusMessage(StatusMessageT&& value) {
184 m_statusMessageHasBeenSet = true;
185 m_statusMessage = std::forward<StatusMessageT>(value);
186 }
187 template <typename StatusMessageT = Aws::String>
188 DescribeJobResult& WithStatusMessage(StatusMessageT&& value) {
189 SetStatusMessage(std::forward<StatusMessageT>(value));
190 return *this;
191 }
193
195
200 inline long long GetArchiveSizeInBytes() const { return m_archiveSizeInBytes; }
201 inline void SetArchiveSizeInBytes(long long value) {
202 m_archiveSizeInBytesHasBeenSet = true;
203 m_archiveSizeInBytes = value;
204 }
205 inline DescribeJobResult& WithArchiveSizeInBytes(long long value) {
207 return *this;
208 }
210
212
217 inline long long GetInventorySizeInBytes() const { return m_inventorySizeInBytes; }
218 inline void SetInventorySizeInBytes(long long value) {
219 m_inventorySizeInBytesHasBeenSet = true;
220 m_inventorySizeInBytes = value;
221 }
224 return *this;
225 }
227
229
232 inline const Aws::String& GetSNSTopic() const { return m_sNSTopic; }
233 template <typename SNSTopicT = Aws::String>
234 void SetSNSTopic(SNSTopicT&& value) {
235 m_sNSTopicHasBeenSet = true;
236 m_sNSTopic = std::forward<SNSTopicT>(value);
237 }
238 template <typename SNSTopicT = Aws::String>
239 DescribeJobResult& WithSNSTopic(SNSTopicT&& value) {
240 SetSNSTopic(std::forward<SNSTopicT>(value));
241 return *this;
242 }
244
246
250 inline const Aws::String& GetCompletionDate() const { return m_completionDate; }
251 template <typename CompletionDateT = Aws::String>
252 void SetCompletionDate(CompletionDateT&& value) {
253 m_completionDateHasBeenSet = true;
254 m_completionDate = std::forward<CompletionDateT>(value);
255 }
256 template <typename CompletionDateT = Aws::String>
257 DescribeJobResult& WithCompletionDate(CompletionDateT&& value) {
258 SetCompletionDate(std::forward<CompletionDateT>(value));
259 return *this;
260 }
262
264
277 inline const Aws::String& GetSHA256TreeHash() const { return m_sHA256TreeHash; }
278 template <typename SHA256TreeHashT = Aws::String>
279 void SetSHA256TreeHash(SHA256TreeHashT&& value) {
280 m_sHA256TreeHashHasBeenSet = true;
281 m_sHA256TreeHash = std::forward<SHA256TreeHashT>(value);
282 }
283 template <typename SHA256TreeHashT = Aws::String>
284 DescribeJobResult& WithSHA256TreeHash(SHA256TreeHashT&& value) {
285 SetSHA256TreeHash(std::forward<SHA256TreeHashT>(value));
286 return *this;
287 }
289
291
295 inline const Aws::String& GetArchiveSHA256TreeHash() const { return m_archiveSHA256TreeHash; }
296 template <typename ArchiveSHA256TreeHashT = Aws::String>
297 void SetArchiveSHA256TreeHash(ArchiveSHA256TreeHashT&& value) {
298 m_archiveSHA256TreeHashHasBeenSet = true;
299 m_archiveSHA256TreeHash = std::forward<ArchiveSHA256TreeHashT>(value);
300 }
301 template <typename ArchiveSHA256TreeHashT = Aws::String>
302 DescribeJobResult& WithArchiveSHA256TreeHash(ArchiveSHA256TreeHashT&& value) {
303 SetArchiveSHA256TreeHash(std::forward<ArchiveSHA256TreeHashT>(value));
304 return *this;
305 }
307
309
317 inline const Aws::String& GetRetrievalByteRange() const { return m_retrievalByteRange; }
318 template <typename RetrievalByteRangeT = Aws::String>
319 void SetRetrievalByteRange(RetrievalByteRangeT&& value) {
320 m_retrievalByteRangeHasBeenSet = true;
321 m_retrievalByteRange = std::forward<RetrievalByteRangeT>(value);
322 }
323 template <typename RetrievalByteRangeT = Aws::String>
324 DescribeJobResult& WithRetrievalByteRange(RetrievalByteRangeT&& value) {
325 SetRetrievalByteRange(std::forward<RetrievalByteRangeT>(value));
326 return *this;
327 }
329
331
336 inline const Aws::String& GetTier() const { return m_tier; }
337 template <typename TierT = Aws::String>
338 void SetTier(TierT&& value) {
339 m_tierHasBeenSet = true;
340 m_tier = std::forward<TierT>(value);
341 }
342 template <typename TierT = Aws::String>
343 DescribeJobResult& WithTier(TierT&& value) {
344 SetTier(std::forward<TierT>(value));
345 return *this;
346 }
348
350
353 inline const InventoryRetrievalJobDescription& GetInventoryRetrievalParameters() const { return m_inventoryRetrievalParameters; }
354 template <typename InventoryRetrievalParametersT = InventoryRetrievalJobDescription>
355 void SetInventoryRetrievalParameters(InventoryRetrievalParametersT&& value) {
356 m_inventoryRetrievalParametersHasBeenSet = true;
357 m_inventoryRetrievalParameters = std::forward<InventoryRetrievalParametersT>(value);
358 }
359 template <typename InventoryRetrievalParametersT = InventoryRetrievalJobDescription>
360 DescribeJobResult& WithInventoryRetrievalParameters(InventoryRetrievalParametersT&& value) {
361 SetInventoryRetrievalParameters(std::forward<InventoryRetrievalParametersT>(value));
362 return *this;
363 }
365
367
370 inline const Aws::String& GetJobOutputPath() const { return m_jobOutputPath; }
371 template <typename JobOutputPathT = Aws::String>
372 void SetJobOutputPath(JobOutputPathT&& value) {
373 m_jobOutputPathHasBeenSet = true;
374 m_jobOutputPath = std::forward<JobOutputPathT>(value);
375 }
376 template <typename JobOutputPathT = Aws::String>
377 DescribeJobResult& WithJobOutputPath(JobOutputPathT&& value) {
378 SetJobOutputPath(std::forward<JobOutputPathT>(value));
379 return *this;
380 }
382
384
387 inline const SelectParameters& GetSelectParameters() const { return m_selectParameters; }
388 template <typename SelectParametersT = SelectParameters>
389 void SetSelectParameters(SelectParametersT&& value) {
390 m_selectParametersHasBeenSet = true;
391 m_selectParameters = std::forward<SelectParametersT>(value);
392 }
393 template <typename SelectParametersT = SelectParameters>
394 DescribeJobResult& WithSelectParameters(SelectParametersT&& value) {
395 SetSelectParameters(std::forward<SelectParametersT>(value));
396 return *this;
397 }
399
401
404 inline const OutputLocation& GetOutputLocation() const { return m_outputLocation; }
405 template <typename OutputLocationT = OutputLocation>
406 void SetOutputLocation(OutputLocationT&& value) {
407 m_outputLocationHasBeenSet = true;
408 m_outputLocation = std::forward<OutputLocationT>(value);
409 }
410 template <typename OutputLocationT = OutputLocation>
411 DescribeJobResult& WithOutputLocation(OutputLocationT&& value) {
412 SetOutputLocation(std::forward<OutputLocationT>(value));
413 return *this;
414 }
416
418
419 inline const Aws::String& GetRequestId() const { return m_requestId; }
420 template <typename RequestIdT = Aws::String>
421 void SetRequestId(RequestIdT&& value) {
422 m_requestIdHasBeenSet = true;
423 m_requestId = std::forward<RequestIdT>(value);
424 }
425 template <typename RequestIdT = Aws::String>
426 DescribeJobResult& WithRequestId(RequestIdT&& value) {
427 SetRequestId(std::forward<RequestIdT>(value));
428 return *this;
429 }
431 private:
432 Aws::String m_jobId;
433
434 Aws::String m_jobDescription;
435
437
438 Aws::String m_archiveId;
439
440 Aws::String m_vaultARN;
441
442 Aws::String m_creationDate;
443
444 bool m_completed{false};
445
446 StatusCode m_statusCode{StatusCode::NOT_SET};
447
448 Aws::String m_statusMessage;
449
450 long long m_archiveSizeInBytes{0};
451
452 long long m_inventorySizeInBytes{0};
453
454 Aws::String m_sNSTopic;
455
456 Aws::String m_completionDate;
457
458 Aws::String m_sHA256TreeHash;
459
460 Aws::String m_archiveSHA256TreeHash;
461
462 Aws::String m_retrievalByteRange;
463
464 Aws::String m_tier;
465
466 InventoryRetrievalJobDescription m_inventoryRetrievalParameters;
467
468 Aws::String m_jobOutputPath;
469
470 SelectParameters m_selectParameters;
471
472 OutputLocation m_outputLocation;
473
474 Aws::String m_requestId;
475 bool m_jobIdHasBeenSet = false;
476 bool m_jobDescriptionHasBeenSet = false;
477 bool m_actionHasBeenSet = false;
478 bool m_archiveIdHasBeenSet = false;
479 bool m_vaultARNHasBeenSet = false;
480 bool m_creationDateHasBeenSet = false;
481 bool m_completedHasBeenSet = false;
482 bool m_statusCodeHasBeenSet = false;
483 bool m_statusMessageHasBeenSet = false;
484 bool m_archiveSizeInBytesHasBeenSet = false;
485 bool m_inventorySizeInBytesHasBeenSet = false;
486 bool m_sNSTopicHasBeenSet = false;
487 bool m_completionDateHasBeenSet = false;
488 bool m_sHA256TreeHashHasBeenSet = false;
489 bool m_archiveSHA256TreeHashHasBeenSet = false;
490 bool m_retrievalByteRangeHasBeenSet = false;
491 bool m_tierHasBeenSet = false;
492 bool m_inventoryRetrievalParametersHasBeenSet = false;
493 bool m_jobOutputPathHasBeenSet = false;
494 bool m_selectParametersHasBeenSet = false;
495 bool m_outputLocationHasBeenSet = false;
496 bool m_requestIdHasBeenSet = false;
497};
498
499} // namespace Model
500} // namespace Glacier
501} // 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
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