AWS SDK for C++  1.9.104
AWS SDK for C++
JobParameters.h
Go to the documentation of this file.
1 
6 #pragma once
12 #include <utility>
13 
14 namespace Aws
15 {
16 namespace Utils
17 {
18 namespace Json
19 {
20  class JsonValue;
21  class JsonView;
22 } // namespace Json
23 } // namespace Utils
24 namespace Glacier
25 {
26 namespace Model
27 {
28 
35  {
36  public:
41 
42 
49  inline const Aws::String& GetFormat() const{ return m_format; }
50 
57  inline bool FormatHasBeenSet() const { return m_formatHasBeenSet; }
58 
65  inline void SetFormat(const Aws::String& value) { m_formatHasBeenSet = true; m_format = value; }
66 
73  inline void SetFormat(Aws::String&& value) { m_formatHasBeenSet = true; m_format = std::move(value); }
74 
81  inline void SetFormat(const char* value) { m_formatHasBeenSet = true; m_format.assign(value); }
82 
89  inline JobParameters& WithFormat(const Aws::String& value) { SetFormat(value); return *this;}
90 
97  inline JobParameters& WithFormat(Aws::String&& value) { SetFormat(std::move(value)); return *this;}
98 
105  inline JobParameters& WithFormat(const char* value) { SetFormat(value); return *this;}
106 
107 
113  inline const Aws::String& GetType() const{ return m_type; }
114 
120  inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; }
121 
127  inline void SetType(const Aws::String& value) { m_typeHasBeenSet = true; m_type = value; }
128 
134  inline void SetType(Aws::String&& value) { m_typeHasBeenSet = true; m_type = std::move(value); }
135 
141  inline void SetType(const char* value) { m_typeHasBeenSet = true; m_type.assign(value); }
142 
148  inline JobParameters& WithType(const Aws::String& value) { SetType(value); return *this;}
149 
155  inline JobParameters& WithType(Aws::String&& value) { SetType(std::move(value)); return *this;}
156 
162  inline JobParameters& WithType(const char* value) { SetType(value); return *this;}
163 
164 
171  inline const Aws::String& GetArchiveId() const{ return m_archiveId; }
172 
179  inline bool ArchiveIdHasBeenSet() const { return m_archiveIdHasBeenSet; }
180 
187  inline void SetArchiveId(const Aws::String& value) { m_archiveIdHasBeenSet = true; m_archiveId = value; }
188 
195  inline void SetArchiveId(Aws::String&& value) { m_archiveIdHasBeenSet = true; m_archiveId = std::move(value); }
196 
203  inline void SetArchiveId(const char* value) { m_archiveIdHasBeenSet = true; m_archiveId.assign(value); }
204 
211  inline JobParameters& WithArchiveId(const Aws::String& value) { SetArchiveId(value); return *this;}
212 
219  inline JobParameters& WithArchiveId(Aws::String&& value) { SetArchiveId(std::move(value)); return *this;}
220 
227  inline JobParameters& WithArchiveId(const char* value) { SetArchiveId(value); return *this;}
228 
229 
235  inline const Aws::String& GetDescription() const{ return m_description; }
236 
242  inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
243 
249  inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
250 
256  inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
257 
263  inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
264 
270  inline JobParameters& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
271 
277  inline JobParameters& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
278 
284  inline JobParameters& WithDescription(const char* value) { SetDescription(value); return *this;}
285 
286 
293  inline const Aws::String& GetSNSTopic() const{ return m_sNSTopic; }
294 
301  inline bool SNSTopicHasBeenSet() const { return m_sNSTopicHasBeenSet; }
302 
309  inline void SetSNSTopic(const Aws::String& value) { m_sNSTopicHasBeenSet = true; m_sNSTopic = value; }
310 
317  inline void SetSNSTopic(Aws::String&& value) { m_sNSTopicHasBeenSet = true; m_sNSTopic = std::move(value); }
318 
325  inline void SetSNSTopic(const char* value) { m_sNSTopicHasBeenSet = true; m_sNSTopic.assign(value); }
326 
333  inline JobParameters& WithSNSTopic(const Aws::String& value) { SetSNSTopic(value); return *this;}
334 
341  inline JobParameters& WithSNSTopic(Aws::String&& value) { SetSNSTopic(std::move(value)); return *this;}
342 
349  inline JobParameters& WithSNSTopic(const char* value) { SetSNSTopic(value); return *this;}
350 
351 
362  inline const Aws::String& GetRetrievalByteRange() const{ return m_retrievalByteRange; }
363 
374  inline bool RetrievalByteRangeHasBeenSet() const { return m_retrievalByteRangeHasBeenSet; }
375 
386  inline void SetRetrievalByteRange(const Aws::String& value) { m_retrievalByteRangeHasBeenSet = true; m_retrievalByteRange = value; }
387 
398  inline void SetRetrievalByteRange(Aws::String&& value) { m_retrievalByteRangeHasBeenSet = true; m_retrievalByteRange = std::move(value); }
399 
410  inline void SetRetrievalByteRange(const char* value) { m_retrievalByteRangeHasBeenSet = true; m_retrievalByteRange.assign(value); }
411 
422  inline JobParameters& WithRetrievalByteRange(const Aws::String& value) { SetRetrievalByteRange(value); return *this;}
423 
434  inline JobParameters& WithRetrievalByteRange(Aws::String&& value) { SetRetrievalByteRange(std::move(value)); return *this;}
435 
446  inline JobParameters& WithRetrievalByteRange(const char* value) { SetRetrievalByteRange(value); return *this;}
447 
448 
454  inline const Aws::String& GetTier() const{ return m_tier; }
455 
461  inline bool TierHasBeenSet() const { return m_tierHasBeenSet; }
462 
468  inline void SetTier(const Aws::String& value) { m_tierHasBeenSet = true; m_tier = value; }
469 
475  inline void SetTier(Aws::String&& value) { m_tierHasBeenSet = true; m_tier = std::move(value); }
476 
482  inline void SetTier(const char* value) { m_tierHasBeenSet = true; m_tier.assign(value); }
483 
489  inline JobParameters& WithTier(const Aws::String& value) { SetTier(value); return *this;}
490 
496  inline JobParameters& WithTier(Aws::String&& value) { SetTier(std::move(value)); return *this;}
497 
503  inline JobParameters& WithTier(const char* value) { SetTier(value); return *this;}
504 
505 
509  inline const InventoryRetrievalJobInput& GetInventoryRetrievalParameters() const{ return m_inventoryRetrievalParameters; }
510 
514  inline bool InventoryRetrievalParametersHasBeenSet() const { return m_inventoryRetrievalParametersHasBeenSet; }
515 
519  inline void SetInventoryRetrievalParameters(const InventoryRetrievalJobInput& value) { m_inventoryRetrievalParametersHasBeenSet = true; m_inventoryRetrievalParameters = value; }
520 
524  inline void SetInventoryRetrievalParameters(InventoryRetrievalJobInput&& value) { m_inventoryRetrievalParametersHasBeenSet = true; m_inventoryRetrievalParameters = std::move(value); }
525 
529  inline JobParameters& WithInventoryRetrievalParameters(const InventoryRetrievalJobInput& value) { SetInventoryRetrievalParameters(value); return *this;}
530 
534  inline JobParameters& WithInventoryRetrievalParameters(InventoryRetrievalJobInput&& value) { SetInventoryRetrievalParameters(std::move(value)); return *this;}
535 
536 
540  inline const SelectParameters& GetSelectParameters() const{ return m_selectParameters; }
541 
545  inline bool SelectParametersHasBeenSet() const { return m_selectParametersHasBeenSet; }
546 
550  inline void SetSelectParameters(const SelectParameters& value) { m_selectParametersHasBeenSet = true; m_selectParameters = value; }
551 
555  inline void SetSelectParameters(SelectParameters&& value) { m_selectParametersHasBeenSet = true; m_selectParameters = std::move(value); }
556 
560  inline JobParameters& WithSelectParameters(const SelectParameters& value) { SetSelectParameters(value); return *this;}
561 
565  inline JobParameters& WithSelectParameters(SelectParameters&& value) { SetSelectParameters(std::move(value)); return *this;}
566 
567 
572  inline const OutputLocation& GetOutputLocation() const{ return m_outputLocation; }
573 
578  inline bool OutputLocationHasBeenSet() const { return m_outputLocationHasBeenSet; }
579 
584  inline void SetOutputLocation(const OutputLocation& value) { m_outputLocationHasBeenSet = true; m_outputLocation = value; }
585 
590  inline void SetOutputLocation(OutputLocation&& value) { m_outputLocationHasBeenSet = true; m_outputLocation = std::move(value); }
591 
596  inline JobParameters& WithOutputLocation(const OutputLocation& value) { SetOutputLocation(value); return *this;}
597 
602  inline JobParameters& WithOutputLocation(OutputLocation&& value) { SetOutputLocation(std::move(value)); return *this;}
603 
604  private:
605 
606  Aws::String m_format;
607  bool m_formatHasBeenSet;
608 
609  Aws::String m_type;
610  bool m_typeHasBeenSet;
611 
612  Aws::String m_archiveId;
613  bool m_archiveIdHasBeenSet;
614 
615  Aws::String m_description;
616  bool m_descriptionHasBeenSet;
617 
618  Aws::String m_sNSTopic;
619  bool m_sNSTopicHasBeenSet;
620 
621  Aws::String m_retrievalByteRange;
622  bool m_retrievalByteRangeHasBeenSet;
623 
624  Aws::String m_tier;
625  bool m_tierHasBeenSet;
626 
627  InventoryRetrievalJobInput m_inventoryRetrievalParameters;
628  bool m_inventoryRetrievalParametersHasBeenSet;
629 
630  SelectParameters m_selectParameters;
631  bool m_selectParametersHasBeenSet;
632 
633  OutputLocation m_outputLocation;
634  bool m_outputLocationHasBeenSet;
635  };
636 
637 } // namespace Model
638 } // namespace Glacier
639 } // namespace Aws
Aws::Glacier::Model::JobParameters::SetTier
void SetTier(const Aws::String &value)
Definition: JobParameters.h:468
Aws::Glacier::Model::JobParameters::WithTier
JobParameters & WithTier(const char *value)
Definition: JobParameters.h:503
Aws::Glacier::Model::JobParameters::GetType
const Aws::String & GetType() const
Definition: JobParameters.h:113
Aws::Glacier::Model::JobParameters::SetRetrievalByteRange
void SetRetrievalByteRange(const Aws::String &value)
Definition: JobParameters.h:386
Aws::Glacier::Model::JobParameters::JobParameters
JobParameters(Aws::Utils::Json::JsonView jsonValue)
Aws::Glacier::Model::JobParameters::GetSelectParameters
const SelectParameters & GetSelectParameters() const
Definition: JobParameters.h:540
Aws::Glacier::Model::JobParameters::SetInventoryRetrievalParameters
void SetInventoryRetrievalParameters(InventoryRetrievalJobInput &&value)
Definition: JobParameters.h:524
Aws::Glacier::Model::JobParameters::DescriptionHasBeenSet
bool DescriptionHasBeenSet() const
Definition: JobParameters.h:242
Aws::Glacier::Model::JobParameters::TierHasBeenSet
bool TierHasBeenSet() const
Definition: JobParameters.h:461
Aws::Glacier::Model::JobParameters::GetArchiveId
const Aws::String & GetArchiveId() const
Definition: JobParameters.h:171
SelectParameters.h
Aws::Glacier::Model::JobParameters::WithSNSTopic
JobParameters & WithSNSTopic(const char *value)
Definition: JobParameters.h:349
Aws::Glacier::Model::JobParameters::GetInventoryRetrievalParameters
const InventoryRetrievalJobInput & GetInventoryRetrievalParameters() const
Definition: JobParameters.h:509
Aws::Glacier::Model::JobParameters::SetDescription
void SetDescription(const char *value)
Definition: JobParameters.h:263
Aws::Glacier::Model::JobParameters::WithSNSTopic
JobParameters & WithSNSTopic(Aws::String &&value)
Definition: JobParameters.h:341
Aws::Glacier::Model::JobParameters::WithDescription
JobParameters & WithDescription(const Aws::String &value)
Definition: JobParameters.h:270
Aws::Glacier::Model::JobParameters::SetOutputLocation
void SetOutputLocation(const OutputLocation &value)
Definition: JobParameters.h:584
Aws::Glacier::Model::JobParameters::WithSNSTopic
JobParameters & WithSNSTopic(const Aws::String &value)
Definition: JobParameters.h:333
Aws::Glacier::Model::JobParameters::SetRetrievalByteRange
void SetRetrievalByteRange(Aws::String &&value)
Definition: JobParameters.h:398
Aws::Glacier::Model::JobParameters::InventoryRetrievalParametersHasBeenSet
bool InventoryRetrievalParametersHasBeenSet() const
Definition: JobParameters.h:514
Aws::Glacier::Model::JobParameters::GetDescription
const Aws::String & GetDescription() const
Definition: JobParameters.h:235
Aws::Glacier::Model::JobParameters::SetType
void SetType(Aws::String &&value)
Definition: JobParameters.h:134
Aws::Glacier::Model::JobParameters::WithTier
JobParameters & WithTier(const Aws::String &value)
Definition: JobParameters.h:489
Aws::Glacier::Model::JobParameters::SetSNSTopic
void SetSNSTopic(const Aws::String &value)
Definition: JobParameters.h:309
Aws::Glacier::Model::JobParameters::WithType
JobParameters & WithType(Aws::String &&value)
Definition: JobParameters.h:155
Aws::Glacier::Model::JobParameters::WithDescription
JobParameters & WithDescription(Aws::String &&value)
Definition: JobParameters.h:277
Aws::Glacier::Model::JobParameters::WithArchiveId
JobParameters & WithArchiveId(const Aws::String &value)
Definition: JobParameters.h:211
Aws::Glacier::Model::JobParameters::WithArchiveId
JobParameters & WithArchiveId(const char *value)
Definition: JobParameters.h:227
Aws::Glacier::Model::JobParameters::FormatHasBeenSet
bool FormatHasBeenSet() const
Definition: JobParameters.h:57
OutputLocation.h
AWS_GLACIER_API
#define AWS_GLACIER_API
Definition: Glacier_EXPORTS.h:28
Aws::Glacier::Model::JobParameters::JobParameters
JobParameters()
Aws::Glacier::Model::JobParameters::SetSelectParameters
void SetSelectParameters(SelectParameters &&value)
Definition: JobParameters.h:555
Aws::Glacier::Model::JobParameters::WithOutputLocation
JobParameters & WithOutputLocation(OutputLocation &&value)
Definition: JobParameters.h:602
Aws::Glacier::Model::JobParameters::SetSNSTopic
void SetSNSTopic(const char *value)
Definition: JobParameters.h:325
Aws::Glacier::Model::JobParameters::WithFormat
JobParameters & WithFormat(const char *value)
Definition: JobParameters.h:105
Aws::Glacier::Model::JobParameters::WithRetrievalByteRange
JobParameters & WithRetrievalByteRange(const char *value)
Definition: JobParameters.h:446
Aws::Glacier::Model::JobParameters::SetType
void SetType(const Aws::String &value)
Definition: JobParameters.h:127
Aws::Glacier::Model::JobParameters::WithDescription
JobParameters & WithDescription(const char *value)
Definition: JobParameters.h:284
Aws::Glacier::Model::JobParameters::SNSTopicHasBeenSet
bool SNSTopicHasBeenSet() const
Definition: JobParameters.h:301
Aws::Glacier::Model::JobParameters::WithArchiveId
JobParameters & WithArchiveId(Aws::String &&value)
Definition: JobParameters.h:219
Aws::Glacier::Model::JobParameters::SetFormat
void SetFormat(const Aws::String &value)
Definition: JobParameters.h:65
Aws::Glacier::Model::JobParameters::SetOutputLocation
void SetOutputLocation(OutputLocation &&value)
Definition: JobParameters.h:590
Aws::Glacier::Model::JobParameters::SetArchiveId
void SetArchiveId(const char *value)
Definition: JobParameters.h:203
Aws::Glacier::Model::JobParameters::Jsonize
Aws::Utils::Json::JsonValue Jsonize() const
Aws::Glacier::Model::JobParameters::SetDescription
void SetDescription(const Aws::String &value)
Definition: JobParameters.h:249
Aws::Glacier::Model::JobParameters::GetTier
const Aws::String & GetTier() const
Definition: JobParameters.h:454
Aws::Glacier::Model::JobParameters::WithInventoryRetrievalParameters
JobParameters & WithInventoryRetrievalParameters(InventoryRetrievalJobInput &&value)
Definition: JobParameters.h:534
Aws::Glacier::Model::JobParameters::WithInventoryRetrievalParameters
JobParameters & WithInventoryRetrievalParameters(const InventoryRetrievalJobInput &value)
Definition: JobParameters.h:529
Aws::Glacier::Model::JobParameters::GetRetrievalByteRange
const Aws::String & GetRetrievalByteRange() const
Definition: JobParameters.h:362
Aws::Glacier::Model::JobParameters::OutputLocationHasBeenSet
bool OutputLocationHasBeenSet() const
Definition: JobParameters.h:578
Aws::Glacier::Model::JobParameters::WithRetrievalByteRange
JobParameters & WithRetrievalByteRange(Aws::String &&value)
Definition: JobParameters.h:434
Aws::Glacier::Model::JobParameters::WithType
JobParameters & WithType(const Aws::String &value)
Definition: JobParameters.h:148
Aws::Glacier::Model::JobParameters::WithTier
JobParameters & WithTier(Aws::String &&value)
Definition: JobParameters.h:496
Aws::Glacier::Model::JobParameters::SetDescription
void SetDescription(Aws::String &&value)
Definition: JobParameters.h:256
Aws::Glacier::Model::SelectParameters
Definition: SelectParameters.h:36
Aws::Glacier::Model::JobParameters::GetSNSTopic
const Aws::String & GetSNSTopic() const
Definition: JobParameters.h:293
Aws::Utils::Json::JsonView
Definition: JsonSerializer.h:235
Aws::Glacier::Model::JobParameters::SetSNSTopic
void SetSNSTopic(Aws::String &&value)
Definition: JobParameters.h:317
AWSString.h
Aws::Glacier::Model::JobParameters::ArchiveIdHasBeenSet
bool ArchiveIdHasBeenSet() const
Definition: JobParameters.h:179
Aws::Glacier::Model::JobParameters::WithType
JobParameters & WithType(const char *value)
Definition: JobParameters.h:162
Aws::Glacier::Model::JobParameters::operator=
JobParameters & operator=(Aws::Utils::Json::JsonView jsonValue)
Aws::Utils::Json::JsonValue
Definition: JsonSerializer.h:33
Aws::Glacier::Model::JobParameters::WithSelectParameters
JobParameters & WithSelectParameters(SelectParameters &&value)
Definition: JobParameters.h:565
Aws::Glacier::Model::JobParameters::WithFormat
JobParameters & WithFormat(const Aws::String &value)
Definition: JobParameters.h:89
Aws::Glacier::Model::JobParameters::SetRetrievalByteRange
void SetRetrievalByteRange(const char *value)
Definition: JobParameters.h:410
Aws::Glacier::Model::JobParameters::GetFormat
const Aws::String & GetFormat() const
Definition: JobParameters.h:49
Aws::Glacier::Model::JobParameters::SelectParametersHasBeenSet
bool SelectParametersHasBeenSet() const
Definition: JobParameters.h:545
Aws::Glacier::Model::JobParameters::SetInventoryRetrievalParameters
void SetInventoryRetrievalParameters(const InventoryRetrievalJobInput &value)
Definition: JobParameters.h:519
Aws::Glacier::Model::JobParameters::SetTier
void SetTier(const char *value)
Definition: JobParameters.h:482
Aws
Definition: AccessManagementClient.h:15
Aws::Glacier::Model::JobParameters::TypeHasBeenSet
bool TypeHasBeenSet() const
Definition: JobParameters.h:120
Aws::Glacier::Model::JobParameters::SetTier
void SetTier(Aws::String &&value)
Definition: JobParameters.h:475
Aws::Glacier::Model::InventoryRetrievalJobInput
Definition: InventoryRetrievalJobInput.h:33
Aws::Glacier::Model::JobParameters::SetSelectParameters
void SetSelectParameters(const SelectParameters &value)
Definition: JobParameters.h:550
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::Glacier::Model::JobParameters::GetOutputLocation
const OutputLocation & GetOutputLocation() const
Definition: JobParameters.h:572
Aws::Glacier::Model::JobParameters::WithRetrievalByteRange
JobParameters & WithRetrievalByteRange(const Aws::String &value)
Definition: JobParameters.h:422
Aws::Glacier::Model::OutputLocation
Definition: OutputLocation.h:33
Aws::Glacier::Model::JobParameters::WithSelectParameters
JobParameters & WithSelectParameters(const SelectParameters &value)
Definition: JobParameters.h:560
Aws::Glacier::Model::JobParameters::SetFormat
void SetFormat(Aws::String &&value)
Definition: JobParameters.h:73
Aws::Glacier::Model::JobParameters::WithFormat
JobParameters & WithFormat(Aws::String &&value)
Definition: JobParameters.h:97
Aws::Glacier::Model::JobParameters::SetType
void SetType(const char *value)
Definition: JobParameters.h:141
Aws::Glacier::Model::JobParameters::SetArchiveId
void SetArchiveId(const Aws::String &value)
Definition: JobParameters.h:187
Aws::Glacier::Model::JobParameters::RetrievalByteRangeHasBeenSet
bool RetrievalByteRangeHasBeenSet() const
Definition: JobParameters.h:374
Aws::Glacier::Model::JobParameters::SetFormat
void SetFormat(const char *value)
Definition: JobParameters.h:81
Aws::Glacier::Model::JobParameters::SetArchiveId
void SetArchiveId(Aws::String &&value)
Definition: JobParameters.h:195
Aws::Glacier::Model::JobParameters::WithOutputLocation
JobParameters & WithOutputLocation(const OutputLocation &value)
Definition: JobParameters.h:596
Aws::Glacier::Model::JobParameters
Definition: JobParameters.h:35
InventoryRetrievalJobInput.h
Glacier_EXPORTS.h