AWS SDK for C++

AWS SDK for C++ Version 1.11.607

Loading...
Searching...
No Matches
GlacierJobDescription.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{
18namespace Utils
19{
20namespace Json
21{
22 class JsonValue;
23 class JsonView;
24} // namespace Json
25} // namespace Utils
26namespace Glacier
27{
28namespace Model
29{
30
38 {
39 public:
40 AWS_GLACIER_API GlacierJobDescription() = default;
43 AWS_GLACIER_API Aws::Utils::Json::JsonValue Jsonize() const;
44
45
47
50 inline const Aws::String& GetJobId() const { return m_jobId; }
51 inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; }
52 template<typename JobIdT = Aws::String>
53 void SetJobId(JobIdT&& value) { m_jobIdHasBeenSet = true; m_jobId = std::forward<JobIdT>(value); }
54 template<typename JobIdT = Aws::String>
55 GlacierJobDescription& WithJobId(JobIdT&& value) { SetJobId(std::forward<JobIdT>(value)); return *this;}
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) { m_jobDescriptionHasBeenSet = true; m_jobDescription = std::forward<JobDescriptionT>(value); }
66 template<typename JobDescriptionT = Aws::String>
67 GlacierJobDescription& WithJobDescription(JobDescriptionT&& value) { SetJobDescription(std::forward<JobDescriptionT>(value)); return *this;}
69
71
75 inline ActionCode GetAction() const { return m_action; }
76 inline bool ActionHasBeenSet() const { return m_actionHasBeenSet; }
77 inline void SetAction(ActionCode value) { m_actionHasBeenSet = true; m_action = value; }
78 inline GlacierJobDescription& WithAction(ActionCode value) { SetAction(value); return *this;}
80
82
86 inline const Aws::String& GetArchiveId() const { return m_archiveId; }
87 inline bool ArchiveIdHasBeenSet() const { return m_archiveIdHasBeenSet; }
88 template<typename ArchiveIdT = Aws::String>
89 void SetArchiveId(ArchiveIdT&& value) { m_archiveIdHasBeenSet = true; m_archiveId = std::forward<ArchiveIdT>(value); }
90 template<typename ArchiveIdT = Aws::String>
91 GlacierJobDescription& WithArchiveId(ArchiveIdT&& value) { SetArchiveId(std::forward<ArchiveIdT>(value)); return *this;}
93
95
99 inline const Aws::String& GetVaultARN() const { return m_vaultARN; }
100 inline bool VaultARNHasBeenSet() const { return m_vaultARNHasBeenSet; }
101 template<typename VaultARNT = Aws::String>
102 void SetVaultARN(VaultARNT&& value) { m_vaultARNHasBeenSet = true; m_vaultARN = std::forward<VaultARNT>(value); }
103 template<typename VaultARNT = Aws::String>
104 GlacierJobDescription& WithVaultARN(VaultARNT&& value) { SetVaultARN(std::forward<VaultARNT>(value)); return *this;}
106
108
113 inline const Aws::String& GetCreationDate() const { return m_creationDate; }
114 inline bool CreationDateHasBeenSet() const { return m_creationDateHasBeenSet; }
115 template<typename CreationDateT = Aws::String>
116 void SetCreationDate(CreationDateT&& value) { m_creationDateHasBeenSet = true; m_creationDate = std::forward<CreationDateT>(value); }
117 template<typename CreationDateT = Aws::String>
118 GlacierJobDescription& WithCreationDate(CreationDateT&& value) { SetCreationDate(std::forward<CreationDateT>(value)); return *this;}
120
122
126 inline bool GetCompleted() const { return m_completed; }
127 inline bool CompletedHasBeenSet() const { return m_completedHasBeenSet; }
128 inline void SetCompleted(bool value) { m_completedHasBeenSet = true; m_completed = value; }
129 inline GlacierJobDescription& WithCompleted(bool value) { SetCompleted(value); return *this;}
131
133
137 inline StatusCode GetStatusCode() const { return m_statusCode; }
138 inline bool StatusCodeHasBeenSet() const { return m_statusCodeHasBeenSet; }
139 inline void SetStatusCode(StatusCode value) { m_statusCodeHasBeenSet = true; m_statusCode = value; }
140 inline GlacierJobDescription& WithStatusCode(StatusCode value) { SetStatusCode(value); return *this;}
142
144
147 inline const Aws::String& GetStatusMessage() const { return m_statusMessage; }
148 inline bool StatusMessageHasBeenSet() const { return m_statusMessageHasBeenSet; }
149 template<typename StatusMessageT = Aws::String>
150 void SetStatusMessage(StatusMessageT&& value) { m_statusMessageHasBeenSet = true; m_statusMessage = std::forward<StatusMessageT>(value); }
151 template<typename StatusMessageT = Aws::String>
152 GlacierJobDescription& WithStatusMessage(StatusMessageT&& value) { SetStatusMessage(std::forward<StatusMessageT>(value)); return *this;}
154
156
161 inline long long GetArchiveSizeInBytes() const { return m_archiveSizeInBytes; }
162 inline bool ArchiveSizeInBytesHasBeenSet() const { return m_archiveSizeInBytesHasBeenSet; }
163 inline void SetArchiveSizeInBytes(long long value) { m_archiveSizeInBytesHasBeenSet = true; m_archiveSizeInBytes = value; }
164 inline GlacierJobDescription& WithArchiveSizeInBytes(long long value) { SetArchiveSizeInBytes(value); return *this;}
166
168
173 inline long long GetInventorySizeInBytes() const { return m_inventorySizeInBytes; }
174 inline bool InventorySizeInBytesHasBeenSet() const { return m_inventorySizeInBytesHasBeenSet; }
175 inline void SetInventorySizeInBytes(long long value) { m_inventorySizeInBytesHasBeenSet = true; m_inventorySizeInBytes = value; }
176 inline GlacierJobDescription& WithInventorySizeInBytes(long long value) { SetInventorySizeInBytes(value); return *this;}
178
180
183 inline const Aws::String& GetSNSTopic() const { return m_sNSTopic; }
184 inline bool SNSTopicHasBeenSet() const { return m_sNSTopicHasBeenSet; }
185 template<typename SNSTopicT = Aws::String>
186 void SetSNSTopic(SNSTopicT&& value) { m_sNSTopicHasBeenSet = true; m_sNSTopic = std::forward<SNSTopicT>(value); }
187 template<typename SNSTopicT = Aws::String>
188 GlacierJobDescription& WithSNSTopic(SNSTopicT&& value) { SetSNSTopic(std::forward<SNSTopicT>(value)); return *this;}
190
192
196 inline const Aws::String& GetCompletionDate() const { return m_completionDate; }
197 inline bool CompletionDateHasBeenSet() const { return m_completionDateHasBeenSet; }
198 template<typename CompletionDateT = Aws::String>
199 void SetCompletionDate(CompletionDateT&& value) { m_completionDateHasBeenSet = true; m_completionDate = std::forward<CompletionDateT>(value); }
200 template<typename CompletionDateT = Aws::String>
201 GlacierJobDescription& WithCompletionDate(CompletionDateT&& value) { SetCompletionDate(std::forward<CompletionDateT>(value)); return *this;}
203
205
218 inline const Aws::String& GetSHA256TreeHash() const { return m_sHA256TreeHash; }
219 inline bool SHA256TreeHashHasBeenSet() const { return m_sHA256TreeHashHasBeenSet; }
220 template<typename SHA256TreeHashT = Aws::String>
221 void SetSHA256TreeHash(SHA256TreeHashT&& value) { m_sHA256TreeHashHasBeenSet = true; m_sHA256TreeHash = std::forward<SHA256TreeHashT>(value); }
222 template<typename SHA256TreeHashT = Aws::String>
223 GlacierJobDescription& WithSHA256TreeHash(SHA256TreeHashT&& value) { SetSHA256TreeHash(std::forward<SHA256TreeHashT>(value)); return *this;}
225
227
231 inline const Aws::String& GetArchiveSHA256TreeHash() const { return m_archiveSHA256TreeHash; }
232 inline bool ArchiveSHA256TreeHashHasBeenSet() const { return m_archiveSHA256TreeHashHasBeenSet; }
233 template<typename ArchiveSHA256TreeHashT = Aws::String>
234 void SetArchiveSHA256TreeHash(ArchiveSHA256TreeHashT&& value) { m_archiveSHA256TreeHashHasBeenSet = true; m_archiveSHA256TreeHash = std::forward<ArchiveSHA256TreeHashT>(value); }
235 template<typename ArchiveSHA256TreeHashT = Aws::String>
236 GlacierJobDescription& WithArchiveSHA256TreeHash(ArchiveSHA256TreeHashT&& value) { SetArchiveSHA256TreeHash(std::forward<ArchiveSHA256TreeHashT>(value)); return *this;}
238
240
248 inline const Aws::String& GetRetrievalByteRange() const { return m_retrievalByteRange; }
249 inline bool RetrievalByteRangeHasBeenSet() const { return m_retrievalByteRangeHasBeenSet; }
250 template<typename RetrievalByteRangeT = Aws::String>
251 void SetRetrievalByteRange(RetrievalByteRangeT&& value) { m_retrievalByteRangeHasBeenSet = true; m_retrievalByteRange = std::forward<RetrievalByteRangeT>(value); }
252 template<typename RetrievalByteRangeT = Aws::String>
253 GlacierJobDescription& WithRetrievalByteRange(RetrievalByteRangeT&& value) { SetRetrievalByteRange(std::forward<RetrievalByteRangeT>(value)); return *this;}
255
257
262 inline const Aws::String& GetTier() const { return m_tier; }
263 inline bool TierHasBeenSet() const { return m_tierHasBeenSet; }
264 template<typename TierT = Aws::String>
265 void SetTier(TierT&& value) { m_tierHasBeenSet = true; m_tier = std::forward<TierT>(value); }
266 template<typename TierT = Aws::String>
267 GlacierJobDescription& WithTier(TierT&& value) { SetTier(std::forward<TierT>(value)); return *this;}
269
271
274 inline const InventoryRetrievalJobDescription& GetInventoryRetrievalParameters() const { return m_inventoryRetrievalParameters; }
275 inline bool InventoryRetrievalParametersHasBeenSet() const { return m_inventoryRetrievalParametersHasBeenSet; }
276 template<typename InventoryRetrievalParametersT = InventoryRetrievalJobDescription>
277 void SetInventoryRetrievalParameters(InventoryRetrievalParametersT&& value) { m_inventoryRetrievalParametersHasBeenSet = true; m_inventoryRetrievalParameters = std::forward<InventoryRetrievalParametersT>(value); }
278 template<typename InventoryRetrievalParametersT = InventoryRetrievalJobDescription>
279 GlacierJobDescription& WithInventoryRetrievalParameters(InventoryRetrievalParametersT&& value) { SetInventoryRetrievalParameters(std::forward<InventoryRetrievalParametersT>(value)); return *this;}
281
283
286 inline const Aws::String& GetJobOutputPath() const { return m_jobOutputPath; }
287 inline bool JobOutputPathHasBeenSet() const { return m_jobOutputPathHasBeenSet; }
288 template<typename JobOutputPathT = Aws::String>
289 void SetJobOutputPath(JobOutputPathT&& value) { m_jobOutputPathHasBeenSet = true; m_jobOutputPath = std::forward<JobOutputPathT>(value); }
290 template<typename JobOutputPathT = Aws::String>
291 GlacierJobDescription& WithJobOutputPath(JobOutputPathT&& value) { SetJobOutputPath(std::forward<JobOutputPathT>(value)); return *this;}
293
295
298 inline const SelectParameters& GetSelectParameters() const { return m_selectParameters; }
299 inline bool SelectParametersHasBeenSet() const { return m_selectParametersHasBeenSet; }
300 template<typename SelectParametersT = SelectParameters>
301 void SetSelectParameters(SelectParametersT&& value) { m_selectParametersHasBeenSet = true; m_selectParameters = std::forward<SelectParametersT>(value); }
302 template<typename SelectParametersT = SelectParameters>
303 GlacierJobDescription& WithSelectParameters(SelectParametersT&& value) { SetSelectParameters(std::forward<SelectParametersT>(value)); return *this;}
305
307
310 inline const OutputLocation& GetOutputLocation() const { return m_outputLocation; }
311 inline bool OutputLocationHasBeenSet() const { return m_outputLocationHasBeenSet; }
312 template<typename OutputLocationT = OutputLocation>
313 void SetOutputLocation(OutputLocationT&& value) { m_outputLocationHasBeenSet = true; m_outputLocation = std::forward<OutputLocationT>(value); }
314 template<typename OutputLocationT = OutputLocation>
315 GlacierJobDescription& WithOutputLocation(OutputLocationT&& value) { SetOutputLocation(std::forward<OutputLocationT>(value)); return *this;}
317
319
320 inline const Aws::String& GetRequestId() const { return m_requestId; }
321 inline bool RequestIdHasBeenSet() const { return m_requestIdHasBeenSet; }
322 template<typename RequestIdT = Aws::String>
323 void SetRequestId(RequestIdT&& value) { m_requestIdHasBeenSet = true; m_requestId = std::forward<RequestIdT>(value); }
324 template<typename RequestIdT = Aws::String>
325 GlacierJobDescription& WithRequestId(RequestIdT&& value) { SetRequestId(std::forward<RequestIdT>(value)); return *this;}
327 private:
328
329 Aws::String m_jobId;
330 bool m_jobIdHasBeenSet = false;
331
332 Aws::String m_jobDescription;
333 bool m_jobDescriptionHasBeenSet = false;
334
336 bool m_actionHasBeenSet = false;
337
338 Aws::String m_archiveId;
339 bool m_archiveIdHasBeenSet = false;
340
341 Aws::String m_vaultARN;
342 bool m_vaultARNHasBeenSet = false;
343
344 Aws::String m_creationDate;
345 bool m_creationDateHasBeenSet = false;
346
347 bool m_completed{false};
348 bool m_completedHasBeenSet = false;
349
350 StatusCode m_statusCode{StatusCode::NOT_SET};
351 bool m_statusCodeHasBeenSet = false;
352
353 Aws::String m_statusMessage;
354 bool m_statusMessageHasBeenSet = false;
355
356 long long m_archiveSizeInBytes{0};
357 bool m_archiveSizeInBytesHasBeenSet = false;
358
359 long long m_inventorySizeInBytes{0};
360 bool m_inventorySizeInBytesHasBeenSet = false;
361
362 Aws::String m_sNSTopic;
363 bool m_sNSTopicHasBeenSet = false;
364
365 Aws::String m_completionDate;
366 bool m_completionDateHasBeenSet = false;
367
368 Aws::String m_sHA256TreeHash;
369 bool m_sHA256TreeHashHasBeenSet = false;
370
371 Aws::String m_archiveSHA256TreeHash;
372 bool m_archiveSHA256TreeHashHasBeenSet = false;
373
374 Aws::String m_retrievalByteRange;
375 bool m_retrievalByteRangeHasBeenSet = false;
376
377 Aws::String m_tier;
378 bool m_tierHasBeenSet = false;
379
380 InventoryRetrievalJobDescription m_inventoryRetrievalParameters;
381 bool m_inventoryRetrievalParametersHasBeenSet = false;
382
383 Aws::String m_jobOutputPath;
384 bool m_jobOutputPathHasBeenSet = false;
385
386 SelectParameters m_selectParameters;
387 bool m_selectParametersHasBeenSet = false;
388
389 OutputLocation m_outputLocation;
390 bool m_outputLocationHasBeenSet = false;
391
392 Aws::String m_requestId;
393 bool m_requestIdHasBeenSet = false;
394 };
395
396} // namespace Model
397} // namespace Glacier
398} // 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