AWS SDK for C++

AWS SDK for C++ Version 1.11.607

Loading...
Searching...
No Matches
DescribeJobResult.h
1
6#pragma once
7#include <aws/glacier/Glacier_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/glacier/model/ActionCode.h>
10#include <aws/glacier/model/StatusCode.h>
11#include <aws/glacier/model/InventoryRetrievalJobDescription.h>
12#include <aws/glacier/model/SelectParameters.h>
13#include <aws/glacier/model/OutputLocation.h>
14#include <utility>
15
16namespace Aws
17{
18template<typename RESULT_TYPE>
19class AmazonWebServiceResult;
20
21namespace Utils
22{
23namespace Json
24{
25 class JsonValue;
26} // namespace Json
27} // namespace Utils
28namespace Glacier
29{
30namespace Model
31{
39 {
40 public:
41 AWS_GLACIER_API DescribeJobResult() = default;
44
45
47
50 inline const Aws::String& GetJobId() const { return m_jobId; }
51 template<typename JobIdT = Aws::String>
52 void SetJobId(JobIdT&& value) { m_jobIdHasBeenSet = true; m_jobId = std::forward<JobIdT>(value); }
53 template<typename JobIdT = Aws::String>
54 DescribeJobResult& WithJobId(JobIdT&& value) { SetJobId(std::forward<JobIdT>(value)); return *this;}
56
58
61 inline const Aws::String& GetJobDescription() const { return m_jobDescription; }
62 template<typename JobDescriptionT = Aws::String>
63 void SetJobDescription(JobDescriptionT&& value) { m_jobDescriptionHasBeenSet = true; m_jobDescription = std::forward<JobDescriptionT>(value); }
64 template<typename JobDescriptionT = Aws::String>
65 DescribeJobResult& WithJobDescription(JobDescriptionT&& value) { SetJobDescription(std::forward<JobDescriptionT>(value)); return *this;}
67
69
73 inline ActionCode GetAction() const { return m_action; }
74 inline void SetAction(ActionCode value) { m_actionHasBeenSet = true; m_action = value; }
75 inline DescribeJobResult& WithAction(ActionCode value) { SetAction(value); return *this;}
77
79
83 inline const Aws::String& GetArchiveId() const { return m_archiveId; }
84 template<typename ArchiveIdT = Aws::String>
85 void SetArchiveId(ArchiveIdT&& value) { m_archiveIdHasBeenSet = true; m_archiveId = std::forward<ArchiveIdT>(value); }
86 template<typename ArchiveIdT = Aws::String>
87 DescribeJobResult& WithArchiveId(ArchiveIdT&& value) { SetArchiveId(std::forward<ArchiveIdT>(value)); return *this;}
89
91
95 inline const Aws::String& GetVaultARN() const { return m_vaultARN; }
96 template<typename VaultARNT = Aws::String>
97 void SetVaultARN(VaultARNT&& value) { m_vaultARNHasBeenSet = true; m_vaultARN = std::forward<VaultARNT>(value); }
98 template<typename VaultARNT = Aws::String>
99 DescribeJobResult& WithVaultARN(VaultARNT&& value) { SetVaultARN(std::forward<VaultARNT>(value)); return *this;}
101
103
108 inline const Aws::String& GetCreationDate() const { return m_creationDate; }
109 template<typename CreationDateT = Aws::String>
110 void SetCreationDate(CreationDateT&& value) { m_creationDateHasBeenSet = true; m_creationDate = std::forward<CreationDateT>(value); }
111 template<typename CreationDateT = Aws::String>
112 DescribeJobResult& WithCreationDate(CreationDateT&& value) { SetCreationDate(std::forward<CreationDateT>(value)); return *this;}
114
116
120 inline bool GetCompleted() const { return m_completed; }
121 inline void SetCompleted(bool value) { m_completedHasBeenSet = true; m_completed = value; }
122 inline DescribeJobResult& WithCompleted(bool value) { SetCompleted(value); return *this;}
124
126
130 inline StatusCode GetStatusCode() const { return m_statusCode; }
131 inline void SetStatusCode(StatusCode value) { m_statusCodeHasBeenSet = true; m_statusCode = value; }
132 inline DescribeJobResult& WithStatusCode(StatusCode value) { SetStatusCode(value); return *this;}
134
136
139 inline const Aws::String& GetStatusMessage() const { return m_statusMessage; }
140 template<typename StatusMessageT = Aws::String>
141 void SetStatusMessage(StatusMessageT&& value) { m_statusMessageHasBeenSet = true; m_statusMessage = std::forward<StatusMessageT>(value); }
142 template<typename StatusMessageT = Aws::String>
143 DescribeJobResult& WithStatusMessage(StatusMessageT&& value) { SetStatusMessage(std::forward<StatusMessageT>(value)); return *this;}
145
147
152 inline long long GetArchiveSizeInBytes() const { return m_archiveSizeInBytes; }
153 inline void SetArchiveSizeInBytes(long long value) { m_archiveSizeInBytesHasBeenSet = true; m_archiveSizeInBytes = value; }
154 inline DescribeJobResult& WithArchiveSizeInBytes(long long value) { SetArchiveSizeInBytes(value); return *this;}
156
158
163 inline long long GetInventorySizeInBytes() const { return m_inventorySizeInBytes; }
164 inline void SetInventorySizeInBytes(long long value) { m_inventorySizeInBytesHasBeenSet = true; m_inventorySizeInBytes = value; }
165 inline DescribeJobResult& WithInventorySizeInBytes(long long value) { SetInventorySizeInBytes(value); return *this;}
167
169
172 inline const Aws::String& GetSNSTopic() const { return m_sNSTopic; }
173 template<typename SNSTopicT = Aws::String>
174 void SetSNSTopic(SNSTopicT&& value) { m_sNSTopicHasBeenSet = true; m_sNSTopic = std::forward<SNSTopicT>(value); }
175 template<typename SNSTopicT = Aws::String>
176 DescribeJobResult& WithSNSTopic(SNSTopicT&& value) { SetSNSTopic(std::forward<SNSTopicT>(value)); return *this;}
178
180
184 inline const Aws::String& GetCompletionDate() const { return m_completionDate; }
185 template<typename CompletionDateT = Aws::String>
186 void SetCompletionDate(CompletionDateT&& value) { m_completionDateHasBeenSet = true; m_completionDate = std::forward<CompletionDateT>(value); }
187 template<typename CompletionDateT = Aws::String>
188 DescribeJobResult& WithCompletionDate(CompletionDateT&& value) { SetCompletionDate(std::forward<CompletionDateT>(value)); return *this;}
190
192
205 inline const Aws::String& GetSHA256TreeHash() const { return m_sHA256TreeHash; }
206 template<typename SHA256TreeHashT = Aws::String>
207 void SetSHA256TreeHash(SHA256TreeHashT&& value) { m_sHA256TreeHashHasBeenSet = true; m_sHA256TreeHash = std::forward<SHA256TreeHashT>(value); }
208 template<typename SHA256TreeHashT = Aws::String>
209 DescribeJobResult& WithSHA256TreeHash(SHA256TreeHashT&& value) { SetSHA256TreeHash(std::forward<SHA256TreeHashT>(value)); return *this;}
211
213
217 inline const Aws::String& GetArchiveSHA256TreeHash() const { return m_archiveSHA256TreeHash; }
218 template<typename ArchiveSHA256TreeHashT = Aws::String>
219 void SetArchiveSHA256TreeHash(ArchiveSHA256TreeHashT&& value) { m_archiveSHA256TreeHashHasBeenSet = true; m_archiveSHA256TreeHash = std::forward<ArchiveSHA256TreeHashT>(value); }
220 template<typename ArchiveSHA256TreeHashT = Aws::String>
221 DescribeJobResult& WithArchiveSHA256TreeHash(ArchiveSHA256TreeHashT&& value) { SetArchiveSHA256TreeHash(std::forward<ArchiveSHA256TreeHashT>(value)); return *this;}
223
225
233 inline const Aws::String& GetRetrievalByteRange() const { return m_retrievalByteRange; }
234 template<typename RetrievalByteRangeT = Aws::String>
235 void SetRetrievalByteRange(RetrievalByteRangeT&& value) { m_retrievalByteRangeHasBeenSet = true; m_retrievalByteRange = std::forward<RetrievalByteRangeT>(value); }
236 template<typename RetrievalByteRangeT = Aws::String>
237 DescribeJobResult& WithRetrievalByteRange(RetrievalByteRangeT&& value) { SetRetrievalByteRange(std::forward<RetrievalByteRangeT>(value)); return *this;}
239
241
246 inline const Aws::String& GetTier() const { return m_tier; }
247 template<typename TierT = Aws::String>
248 void SetTier(TierT&& value) { m_tierHasBeenSet = true; m_tier = std::forward<TierT>(value); }
249 template<typename TierT = Aws::String>
250 DescribeJobResult& WithTier(TierT&& value) { SetTier(std::forward<TierT>(value)); return *this;}
252
254
257 inline const InventoryRetrievalJobDescription& GetInventoryRetrievalParameters() const { return m_inventoryRetrievalParameters; }
258 template<typename InventoryRetrievalParametersT = InventoryRetrievalJobDescription>
259 void SetInventoryRetrievalParameters(InventoryRetrievalParametersT&& value) { m_inventoryRetrievalParametersHasBeenSet = true; m_inventoryRetrievalParameters = std::forward<InventoryRetrievalParametersT>(value); }
260 template<typename InventoryRetrievalParametersT = InventoryRetrievalJobDescription>
261 DescribeJobResult& WithInventoryRetrievalParameters(InventoryRetrievalParametersT&& value) { SetInventoryRetrievalParameters(std::forward<InventoryRetrievalParametersT>(value)); return *this;}
263
265
268 inline const Aws::String& GetJobOutputPath() const { return m_jobOutputPath; }
269 template<typename JobOutputPathT = Aws::String>
270 void SetJobOutputPath(JobOutputPathT&& value) { m_jobOutputPathHasBeenSet = true; m_jobOutputPath = std::forward<JobOutputPathT>(value); }
271 template<typename JobOutputPathT = Aws::String>
272 DescribeJobResult& WithJobOutputPath(JobOutputPathT&& value) { SetJobOutputPath(std::forward<JobOutputPathT>(value)); return *this;}
274
276
279 inline const SelectParameters& GetSelectParameters() const { return m_selectParameters; }
280 template<typename SelectParametersT = SelectParameters>
281 void SetSelectParameters(SelectParametersT&& value) { m_selectParametersHasBeenSet = true; m_selectParameters = std::forward<SelectParametersT>(value); }
282 template<typename SelectParametersT = SelectParameters>
283 DescribeJobResult& WithSelectParameters(SelectParametersT&& value) { SetSelectParameters(std::forward<SelectParametersT>(value)); return *this;}
285
287
290 inline const OutputLocation& GetOutputLocation() const { return m_outputLocation; }
291 template<typename OutputLocationT = OutputLocation>
292 void SetOutputLocation(OutputLocationT&& value) { m_outputLocationHasBeenSet = true; m_outputLocation = std::forward<OutputLocationT>(value); }
293 template<typename OutputLocationT = OutputLocation>
294 DescribeJobResult& WithOutputLocation(OutputLocationT&& value) { SetOutputLocation(std::forward<OutputLocationT>(value)); return *this;}
296
298
299 inline const Aws::String& GetRequestId() const { return m_requestId; }
300 template<typename RequestIdT = Aws::String>
301 void SetRequestId(RequestIdT&& value) { m_requestIdHasBeenSet = true; m_requestId = std::forward<RequestIdT>(value); }
302 template<typename RequestIdT = Aws::String>
303 DescribeJobResult& WithRequestId(RequestIdT&& value) { SetRequestId(std::forward<RequestIdT>(value)); return *this;}
305 private:
306
307 Aws::String m_jobId;
308 bool m_jobIdHasBeenSet = false;
309
310 Aws::String m_jobDescription;
311 bool m_jobDescriptionHasBeenSet = false;
312
314 bool m_actionHasBeenSet = false;
315
316 Aws::String m_archiveId;
317 bool m_archiveIdHasBeenSet = false;
318
319 Aws::String m_vaultARN;
320 bool m_vaultARNHasBeenSet = false;
321
322 Aws::String m_creationDate;
323 bool m_creationDateHasBeenSet = false;
324
325 bool m_completed{false};
326 bool m_completedHasBeenSet = false;
327
328 StatusCode m_statusCode{StatusCode::NOT_SET};
329 bool m_statusCodeHasBeenSet = false;
330
331 Aws::String m_statusMessage;
332 bool m_statusMessageHasBeenSet = false;
333
334 long long m_archiveSizeInBytes{0};
335 bool m_archiveSizeInBytesHasBeenSet = false;
336
337 long long m_inventorySizeInBytes{0};
338 bool m_inventorySizeInBytesHasBeenSet = false;
339
340 Aws::String m_sNSTopic;
341 bool m_sNSTopicHasBeenSet = false;
342
343 Aws::String m_completionDate;
344 bool m_completionDateHasBeenSet = false;
345
346 Aws::String m_sHA256TreeHash;
347 bool m_sHA256TreeHashHasBeenSet = false;
348
349 Aws::String m_archiveSHA256TreeHash;
350 bool m_archiveSHA256TreeHashHasBeenSet = false;
351
352 Aws::String m_retrievalByteRange;
353 bool m_retrievalByteRangeHasBeenSet = false;
354
355 Aws::String m_tier;
356 bool m_tierHasBeenSet = false;
357
358 InventoryRetrievalJobDescription m_inventoryRetrievalParameters;
359 bool m_inventoryRetrievalParametersHasBeenSet = false;
360
361 Aws::String m_jobOutputPath;
362 bool m_jobOutputPathHasBeenSet = false;
363
364 SelectParameters m_selectParameters;
365 bool m_selectParametersHasBeenSet = false;
366
367 OutputLocation m_outputLocation;
368 bool m_outputLocationHasBeenSet = false;
369
370 Aws::String m_requestId;
371 bool m_requestIdHasBeenSet = false;
372 };
373
374} // namespace Model
375} // namespace Glacier
376} // 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