AWS SDK for C++

AWS SDK for C++ Version 1.11.440

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();
44
45
47
50 inline const Aws::String& GetJobId() const{ return m_jobId; }
51 inline void SetJobId(const Aws::String& value) { m_jobId = value; }
52 inline void SetJobId(Aws::String&& value) { m_jobId = std::move(value); }
53 inline void SetJobId(const char* value) { m_jobId.assign(value); }
54 inline DescribeJobResult& WithJobId(const Aws::String& value) { SetJobId(value); return *this;}
55 inline DescribeJobResult& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;}
56 inline DescribeJobResult& WithJobId(const char* value) { SetJobId(value); return *this;}
58
60
63 inline const Aws::String& GetJobDescription() const{ return m_jobDescription; }
64 inline void SetJobDescription(const Aws::String& value) { m_jobDescription = value; }
65 inline void SetJobDescription(Aws::String&& value) { m_jobDescription = std::move(value); }
66 inline void SetJobDescription(const char* value) { m_jobDescription.assign(value); }
67 inline DescribeJobResult& WithJobDescription(const Aws::String& value) { SetJobDescription(value); return *this;}
68 inline DescribeJobResult& WithJobDescription(Aws::String&& value) { SetJobDescription(std::move(value)); return *this;}
69 inline DescribeJobResult& WithJobDescription(const char* value) { SetJobDescription(value); return *this;}
71
73
77 inline const ActionCode& GetAction() const{ return m_action; }
78 inline void SetAction(const ActionCode& value) { m_action = value; }
79 inline void SetAction(ActionCode&& value) { m_action = std::move(value); }
80 inline DescribeJobResult& WithAction(const ActionCode& value) { SetAction(value); return *this;}
81 inline DescribeJobResult& WithAction(ActionCode&& value) { SetAction(std::move(value)); return *this;}
83
85
89 inline const Aws::String& GetArchiveId() const{ return m_archiveId; }
90 inline void SetArchiveId(const Aws::String& value) { m_archiveId = value; }
91 inline void SetArchiveId(Aws::String&& value) { m_archiveId = std::move(value); }
92 inline void SetArchiveId(const char* value) { m_archiveId.assign(value); }
93 inline DescribeJobResult& WithArchiveId(const Aws::String& value) { SetArchiveId(value); return *this;}
94 inline DescribeJobResult& WithArchiveId(Aws::String&& value) { SetArchiveId(std::move(value)); return *this;}
95 inline DescribeJobResult& WithArchiveId(const char* value) { SetArchiveId(value); return *this;}
97
99
103 inline const Aws::String& GetVaultARN() const{ return m_vaultARN; }
104 inline void SetVaultARN(const Aws::String& value) { m_vaultARN = value; }
105 inline void SetVaultARN(Aws::String&& value) { m_vaultARN = std::move(value); }
106 inline void SetVaultARN(const char* value) { m_vaultARN.assign(value); }
107 inline DescribeJobResult& WithVaultARN(const Aws::String& value) { SetVaultARN(value); return *this;}
108 inline DescribeJobResult& WithVaultARN(Aws::String&& value) { SetVaultARN(std::move(value)); return *this;}
109 inline DescribeJobResult& WithVaultARN(const char* value) { SetVaultARN(value); return *this;}
111
113
118 inline const Aws::String& GetCreationDate() const{ return m_creationDate; }
119 inline void SetCreationDate(const Aws::String& value) { m_creationDate = value; }
120 inline void SetCreationDate(Aws::String&& value) { m_creationDate = std::move(value); }
121 inline void SetCreationDate(const char* value) { m_creationDate.assign(value); }
122 inline DescribeJobResult& WithCreationDate(const Aws::String& value) { SetCreationDate(value); return *this;}
123 inline DescribeJobResult& WithCreationDate(Aws::String&& value) { SetCreationDate(std::move(value)); return *this;}
124 inline DescribeJobResult& WithCreationDate(const char* value) { SetCreationDate(value); return *this;}
126
128
132 inline bool GetCompleted() const{ return m_completed; }
133 inline void SetCompleted(bool value) { m_completed = value; }
134 inline DescribeJobResult& WithCompleted(bool value) { SetCompleted(value); return *this;}
136
138
142 inline const StatusCode& GetStatusCode() const{ return m_statusCode; }
143 inline void SetStatusCode(const StatusCode& value) { m_statusCode = value; }
144 inline void SetStatusCode(StatusCode&& value) { m_statusCode = std::move(value); }
145 inline DescribeJobResult& WithStatusCode(const StatusCode& value) { SetStatusCode(value); return *this;}
146 inline DescribeJobResult& WithStatusCode(StatusCode&& value) { SetStatusCode(std::move(value)); return *this;}
148
150
153 inline const Aws::String& GetStatusMessage() const{ return m_statusMessage; }
154 inline void SetStatusMessage(const Aws::String& value) { m_statusMessage = value; }
155 inline void SetStatusMessage(Aws::String&& value) { m_statusMessage = std::move(value); }
156 inline void SetStatusMessage(const char* value) { m_statusMessage.assign(value); }
157 inline DescribeJobResult& WithStatusMessage(const Aws::String& value) { SetStatusMessage(value); return *this;}
158 inline DescribeJobResult& WithStatusMessage(Aws::String&& value) { SetStatusMessage(std::move(value)); return *this;}
159 inline DescribeJobResult& WithStatusMessage(const char* value) { SetStatusMessage(value); return *this;}
161
163
168 inline long long GetArchiveSizeInBytes() const{ return m_archiveSizeInBytes; }
169 inline void SetArchiveSizeInBytes(long long value) { m_archiveSizeInBytes = value; }
170 inline DescribeJobResult& WithArchiveSizeInBytes(long long value) { SetArchiveSizeInBytes(value); return *this;}
172
174
179 inline long long GetInventorySizeInBytes() const{ return m_inventorySizeInBytes; }
180 inline void SetInventorySizeInBytes(long long value) { m_inventorySizeInBytes = value; }
181 inline DescribeJobResult& WithInventorySizeInBytes(long long value) { SetInventorySizeInBytes(value); return *this;}
183
185
188 inline const Aws::String& GetSNSTopic() const{ return m_sNSTopic; }
189 inline void SetSNSTopic(const Aws::String& value) { m_sNSTopic = value; }
190 inline void SetSNSTopic(Aws::String&& value) { m_sNSTopic = std::move(value); }
191 inline void SetSNSTopic(const char* value) { m_sNSTopic.assign(value); }
192 inline DescribeJobResult& WithSNSTopic(const Aws::String& value) { SetSNSTopic(value); return *this;}
193 inline DescribeJobResult& WithSNSTopic(Aws::String&& value) { SetSNSTopic(std::move(value)); return *this;}
194 inline DescribeJobResult& WithSNSTopic(const char* value) { SetSNSTopic(value); return *this;}
196
198
202 inline const Aws::String& GetCompletionDate() const{ return m_completionDate; }
203 inline void SetCompletionDate(const Aws::String& value) { m_completionDate = value; }
204 inline void SetCompletionDate(Aws::String&& value) { m_completionDate = std::move(value); }
205 inline void SetCompletionDate(const char* value) { m_completionDate.assign(value); }
206 inline DescribeJobResult& WithCompletionDate(const Aws::String& value) { SetCompletionDate(value); return *this;}
207 inline DescribeJobResult& WithCompletionDate(Aws::String&& value) { SetCompletionDate(std::move(value)); return *this;}
208 inline DescribeJobResult& WithCompletionDate(const char* value) { SetCompletionDate(value); return *this;}
210
212
225 inline const Aws::String& GetSHA256TreeHash() const{ return m_sHA256TreeHash; }
226 inline void SetSHA256TreeHash(const Aws::String& value) { m_sHA256TreeHash = value; }
227 inline void SetSHA256TreeHash(Aws::String&& value) { m_sHA256TreeHash = std::move(value); }
228 inline void SetSHA256TreeHash(const char* value) { m_sHA256TreeHash.assign(value); }
229 inline DescribeJobResult& WithSHA256TreeHash(const Aws::String& value) { SetSHA256TreeHash(value); return *this;}
230 inline DescribeJobResult& WithSHA256TreeHash(Aws::String&& value) { SetSHA256TreeHash(std::move(value)); return *this;}
231 inline DescribeJobResult& WithSHA256TreeHash(const char* value) { SetSHA256TreeHash(value); return *this;}
233
235
239 inline const Aws::String& GetArchiveSHA256TreeHash() const{ return m_archiveSHA256TreeHash; }
240 inline void SetArchiveSHA256TreeHash(const Aws::String& value) { m_archiveSHA256TreeHash = value; }
241 inline void SetArchiveSHA256TreeHash(Aws::String&& value) { m_archiveSHA256TreeHash = std::move(value); }
242 inline void SetArchiveSHA256TreeHash(const char* value) { m_archiveSHA256TreeHash.assign(value); }
244 inline DescribeJobResult& WithArchiveSHA256TreeHash(Aws::String&& value) { SetArchiveSHA256TreeHash(std::move(value)); return *this;}
245 inline DescribeJobResult& WithArchiveSHA256TreeHash(const char* value) { SetArchiveSHA256TreeHash(value); return *this;}
247
249
257 inline const Aws::String& GetRetrievalByteRange() const{ return m_retrievalByteRange; }
258 inline void SetRetrievalByteRange(const Aws::String& value) { m_retrievalByteRange = value; }
259 inline void SetRetrievalByteRange(Aws::String&& value) { m_retrievalByteRange = std::move(value); }
260 inline void SetRetrievalByteRange(const char* value) { m_retrievalByteRange.assign(value); }
261 inline DescribeJobResult& WithRetrievalByteRange(const Aws::String& value) { SetRetrievalByteRange(value); return *this;}
262 inline DescribeJobResult& WithRetrievalByteRange(Aws::String&& value) { SetRetrievalByteRange(std::move(value)); return *this;}
263 inline DescribeJobResult& WithRetrievalByteRange(const char* value) { SetRetrievalByteRange(value); return *this;}
265
267
272 inline const Aws::String& GetTier() const{ return m_tier; }
273 inline void SetTier(const Aws::String& value) { m_tier = value; }
274 inline void SetTier(Aws::String&& value) { m_tier = std::move(value); }
275 inline void SetTier(const char* value) { m_tier.assign(value); }
276 inline DescribeJobResult& WithTier(const Aws::String& value) { SetTier(value); return *this;}
277 inline DescribeJobResult& WithTier(Aws::String&& value) { SetTier(std::move(value)); return *this;}
278 inline DescribeJobResult& WithTier(const char* value) { SetTier(value); return *this;}
280
282
285 inline const InventoryRetrievalJobDescription& GetInventoryRetrievalParameters() const{ return m_inventoryRetrievalParameters; }
286 inline void SetInventoryRetrievalParameters(const InventoryRetrievalJobDescription& value) { m_inventoryRetrievalParameters = value; }
287 inline void SetInventoryRetrievalParameters(InventoryRetrievalJobDescription&& value) { m_inventoryRetrievalParameters = std::move(value); }
291
293
296 inline const Aws::String& GetJobOutputPath() const{ return m_jobOutputPath; }
297 inline void SetJobOutputPath(const Aws::String& value) { m_jobOutputPath = value; }
298 inline void SetJobOutputPath(Aws::String&& value) { m_jobOutputPath = std::move(value); }
299 inline void SetJobOutputPath(const char* value) { m_jobOutputPath.assign(value); }
300 inline DescribeJobResult& WithJobOutputPath(const Aws::String& value) { SetJobOutputPath(value); return *this;}
301 inline DescribeJobResult& WithJobOutputPath(Aws::String&& value) { SetJobOutputPath(std::move(value)); return *this;}
302 inline DescribeJobResult& WithJobOutputPath(const char* value) { SetJobOutputPath(value); return *this;}
304
306
309 inline const SelectParameters& GetSelectParameters() const{ return m_selectParameters; }
310 inline void SetSelectParameters(const SelectParameters& value) { m_selectParameters = value; }
311 inline void SetSelectParameters(SelectParameters&& value) { m_selectParameters = std::move(value); }
312 inline DescribeJobResult& WithSelectParameters(const SelectParameters& value) { SetSelectParameters(value); return *this;}
313 inline DescribeJobResult& WithSelectParameters(SelectParameters&& value) { SetSelectParameters(std::move(value)); return *this;}
315
317
320 inline const OutputLocation& GetOutputLocation() const{ return m_outputLocation; }
321 inline void SetOutputLocation(const OutputLocation& value) { m_outputLocation = value; }
322 inline void SetOutputLocation(OutputLocation&& value) { m_outputLocation = std::move(value); }
323 inline DescribeJobResult& WithOutputLocation(const OutputLocation& value) { SetOutputLocation(value); return *this;}
324 inline DescribeJobResult& WithOutputLocation(OutputLocation&& value) { SetOutputLocation(std::move(value)); return *this;}
326
328
329 inline const Aws::String& GetRequestId() const{ return m_requestId; }
330 inline void SetRequestId(const Aws::String& value) { m_requestId = value; }
331 inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); }
332 inline void SetRequestId(const char* value) { m_requestId.assign(value); }
333 inline DescribeJobResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;}
334 inline DescribeJobResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;}
335 inline DescribeJobResult& WithRequestId(const char* value) { SetRequestId(value); return *this;}
337 private:
338
339 Aws::String m_jobId;
340
341 Aws::String m_jobDescription;
342
343 ActionCode m_action;
344
345 Aws::String m_archiveId;
346
347 Aws::String m_vaultARN;
348
349 Aws::String m_creationDate;
350
351 bool m_completed;
352
353 StatusCode m_statusCode;
354
355 Aws::String m_statusMessage;
356
357 long long m_archiveSizeInBytes;
358
359 long long m_inventorySizeInBytes;
360
361 Aws::String m_sNSTopic;
362
363 Aws::String m_completionDate;
364
365 Aws::String m_sHA256TreeHash;
366
367 Aws::String m_archiveSHA256TreeHash;
368
369 Aws::String m_retrievalByteRange;
370
371 Aws::String m_tier;
372
373 InventoryRetrievalJobDescription m_inventoryRetrievalParameters;
374
375 Aws::String m_jobOutputPath;
376
377 SelectParameters m_selectParameters;
378
379 OutputLocation m_outputLocation;
380
381 Aws::String m_requestId;
382 };
383
384} // namespace Model
385} // namespace Glacier
386} // namespace Aws
void SetSNSTopic(const Aws::String &value)
DescribeJobResult & WithVaultARN(const Aws::String &value)
DescribeJobResult & WithTier(Aws::String &&value)
DescribeJobResult & WithRetrievalByteRange(const Aws::String &value)
DescribeJobResult & WithArchiveSizeInBytes(long long value)
DescribeJobResult & WithJobDescription(Aws::String &&value)
DescribeJobResult & WithInventoryRetrievalParameters(const InventoryRetrievalJobDescription &value)
DescribeJobResult & WithArchiveId(const char *value)
DescribeJobResult & WithInventorySizeInBytes(long long value)
DescribeJobResult & WithArchiveSHA256TreeHash(Aws::String &&value)
DescribeJobResult & WithArchiveSHA256TreeHash(const Aws::String &value)
const OutputLocation & GetOutputLocation() const
void SetSelectParameters(SelectParameters &&value)
DescribeJobResult & WithJobOutputPath(Aws::String &&value)
DescribeJobResult & WithSelectParameters(const SelectParameters &value)
DescribeJobResult & WithCreationDate(const char *value)
DescribeJobResult & WithJobId(const Aws::String &value)
DescribeJobResult & WithInventoryRetrievalParameters(InventoryRetrievalJobDescription &&value)
void SetJobDescription(Aws::String &&value)
DescribeJobResult & WithSelectParameters(SelectParameters &&value)
AWS_GLACIER_API DescribeJobResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
void SetRetrievalByteRange(const char *value)
DescribeJobResult & WithJobOutputPath(const Aws::String &value)
const Aws::String & GetArchiveSHA256TreeHash() const
DescribeJobResult & WithSNSTopic(const char *value)
DescribeJobResult & WithCompletionDate(const Aws::String &value)
DescribeJobResult & WithCompletionDate(const char *value)
DescribeJobResult & WithCompletionDate(Aws::String &&value)
AWS_GLACIER_API DescribeJobResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
void SetRetrievalByteRange(const Aws::String &value)
const StatusCode & GetStatusCode() const
void SetJobDescription(const Aws::String &value)
const Aws::String & GetSNSTopic() const
const Aws::String & GetJobOutputPath() const
void SetJobId(const Aws::String &value)
void SetCreationDate(Aws::String &&value)
DescribeJobResult & WithStatusMessage(Aws::String &&value)
void SetArchiveSHA256TreeHash(Aws::String &&value)
const Aws::String & GetCreationDate() const
DescribeJobResult & WithTier(const char *value)
DescribeJobResult & WithJobId(const char *value)
void SetStatusMessage(Aws::String &&value)
void SetArchiveSHA256TreeHash(const char *value)
DescribeJobResult & WithArchiveSHA256TreeHash(const char *value)
DescribeJobResult & WithVaultARN(const char *value)
const Aws::String & GetCompletionDate() const
void SetArchiveSHA256TreeHash(const Aws::String &value)
DescribeJobResult & WithStatusMessage(const Aws::String &value)
DescribeJobResult & WithJobDescription(const char *value)
void SetCompletionDate(Aws::String &&value)
DescribeJobResult & WithAction(ActionCode &&value)
const Aws::String & GetRetrievalByteRange() const
DescribeJobResult & WithJobId(Aws::String &&value)
void SetCompletionDate(const Aws::String &value)
DescribeJobResult & WithRequestId(const Aws::String &value)
DescribeJobResult & WithStatusCode(StatusCode &&value)
DescribeJobResult & WithSNSTopic(const Aws::String &value)
const Aws::String & GetArchiveId() const
void SetInventoryRetrievalParameters(InventoryRetrievalJobDescription &&value)
DescribeJobResult & WithSNSTopic(Aws::String &&value)
DescribeJobResult & WithAction(const ActionCode &value)
void SetInventoryRetrievalParameters(const InventoryRetrievalJobDescription &value)
void SetOutputLocation(const OutputLocation &value)
void SetJobOutputPath(const Aws::String &value)
void SetJobOutputPath(Aws::String &&value)
void SetSHA256TreeHash(Aws::String &&value)
void SetAction(const ActionCode &value)
DescribeJobResult & WithRequestId(const char *value)
DescribeJobResult & WithSHA256TreeHash(const Aws::String &value)
DescribeJobResult & WithRetrievalByteRange(const char *value)
const Aws::String & GetStatusMessage() const
DescribeJobResult & WithOutputLocation(const OutputLocation &value)
DescribeJobResult & WithJobDescription(const Aws::String &value)
DescribeJobResult & WithArchiveId(const Aws::String &value)
DescribeJobResult & WithTier(const Aws::String &value)
DescribeJobResult & WithOutputLocation(OutputLocation &&value)
void SetStatusMessage(const Aws::String &value)
const SelectParameters & GetSelectParameters() const
DescribeJobResult & WithStatusCode(const StatusCode &value)
DescribeJobResult & WithCreationDate(const Aws::String &value)
void SetArchiveId(const Aws::String &value)
void SetSHA256TreeHash(const Aws::String &value)
void SetSelectParameters(const SelectParameters &value)
const Aws::String & GetRequestId() const
const Aws::String & GetJobId() const
DescribeJobResult & WithVaultARN(Aws::String &&value)
const Aws::String & GetJobDescription() const
DescribeJobResult & WithRequestId(Aws::String &&value)
DescribeJobResult & WithArchiveId(Aws::String &&value)
DescribeJobResult & WithSHA256TreeHash(const char *value)
void SetTier(const Aws::String &value)
DescribeJobResult & WithRetrievalByteRange(Aws::String &&value)
DescribeJobResult & WithCreationDate(Aws::String &&value)
const Aws::String & GetVaultARN() const
void SetRetrievalByteRange(Aws::String &&value)
const Aws::String & GetSHA256TreeHash() const
void SetOutputLocation(OutputLocation &&value)
DescribeJobResult & WithSHA256TreeHash(Aws::String &&value)
DescribeJobResult & WithCompleted(bool value)
const InventoryRetrievalJobDescription & GetInventoryRetrievalParameters() const
void SetVaultARN(const Aws::String &value)
void SetStatusCode(const StatusCode &value)
void SetRequestId(const Aws::String &value)
DescribeJobResult & WithStatusMessage(const char *value)
DescribeJobResult & WithJobOutputPath(const char *value)
void SetCreationDate(const Aws::String &value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Aws::Utils::Json::JsonValue JsonValue