AWS SDK for C++

AWS SDK for C++ Version 1.11.763

Loading...
Searching...
No Matches
DescribedAgreement.h
1
6#pragma once
7#include <aws/awstransfer/Transfer_EXPORTS.h>
8#include <aws/awstransfer/model/AgreementStatusType.h>
9#include <aws/awstransfer/model/CustomDirectoriesType.h>
10#include <aws/awstransfer/model/EnforceMessageSigningType.h>
11#include <aws/awstransfer/model/PreserveFilenameType.h>
12#include <aws/awstransfer/model/Tag.h>
13#include <aws/core/utils/memory/stl/AWSString.h>
14#include <aws/core/utils/memory/stl/AWSVector.h>
15
16#include <utility>
17
18namespace Aws {
19namespace Utils {
20namespace Json {
21class JsonValue;
22class JsonView;
23} // namespace Json
24} // namespace Utils
25namespace Transfer {
26namespace Model {
27
34 public:
35 AWS_TRANSFER_API DescribedAgreement() = default;
38 AWS_TRANSFER_API Aws::Utils::Json::JsonValue Jsonize() const;
39
41
44 inline const Aws::String& GetArn() const { return m_arn; }
45 inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; }
46 template <typename ArnT = Aws::String>
47 void SetArn(ArnT&& value) {
48 m_arnHasBeenSet = true;
49 m_arn = std::forward<ArnT>(value);
50 }
51 template <typename ArnT = Aws::String>
52 DescribedAgreement& WithArn(ArnT&& value) {
53 SetArn(std::forward<ArnT>(value));
54 return *this;
55 }
57
59
63 inline const Aws::String& GetAgreementId() const { return m_agreementId; }
64 inline bool AgreementIdHasBeenSet() const { return m_agreementIdHasBeenSet; }
65 template <typename AgreementIdT = Aws::String>
66 void SetAgreementId(AgreementIdT&& value) {
67 m_agreementIdHasBeenSet = true;
68 m_agreementId = std::forward<AgreementIdT>(value);
69 }
70 template <typename AgreementIdT = Aws::String>
71 DescribedAgreement& WithAgreementId(AgreementIdT&& value) {
72 SetAgreementId(std::forward<AgreementIdT>(value));
73 return *this;
74 }
76
78
81 inline const Aws::String& GetDescription() const { return m_description; }
82 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
83 template <typename DescriptionT = Aws::String>
84 void SetDescription(DescriptionT&& value) {
85 m_descriptionHasBeenSet = true;
86 m_description = std::forward<DescriptionT>(value);
87 }
88 template <typename DescriptionT = Aws::String>
89 DescribedAgreement& WithDescription(DescriptionT&& value) {
90 SetDescription(std::forward<DescriptionT>(value));
91 return *this;
92 }
94
96
100 inline AgreementStatusType GetStatus() const { return m_status; }
101 inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
102 inline void SetStatus(AgreementStatusType value) {
103 m_statusHasBeenSet = true;
104 m_status = value;
105 }
107 SetStatus(value);
108 return *this;
109 }
111
113
117 inline const Aws::String& GetServerId() const { return m_serverId; }
118 inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; }
119 template <typename ServerIdT = Aws::String>
120 void SetServerId(ServerIdT&& value) {
121 m_serverIdHasBeenSet = true;
122 m_serverId = std::forward<ServerIdT>(value);
123 }
124 template <typename ServerIdT = Aws::String>
125 DescribedAgreement& WithServerId(ServerIdT&& value) {
126 SetServerId(std::forward<ServerIdT>(value));
127 return *this;
128 }
130
132
135 inline const Aws::String& GetLocalProfileId() const { return m_localProfileId; }
136 inline bool LocalProfileIdHasBeenSet() const { return m_localProfileIdHasBeenSet; }
137 template <typename LocalProfileIdT = Aws::String>
138 void SetLocalProfileId(LocalProfileIdT&& value) {
139 m_localProfileIdHasBeenSet = true;
140 m_localProfileId = std::forward<LocalProfileIdT>(value);
141 }
142 template <typename LocalProfileIdT = Aws::String>
143 DescribedAgreement& WithLocalProfileId(LocalProfileIdT&& value) {
144 SetLocalProfileId(std::forward<LocalProfileIdT>(value));
145 return *this;
146 }
148
150
153 inline const Aws::String& GetPartnerProfileId() const { return m_partnerProfileId; }
154 inline bool PartnerProfileIdHasBeenSet() const { return m_partnerProfileIdHasBeenSet; }
155 template <typename PartnerProfileIdT = Aws::String>
156 void SetPartnerProfileId(PartnerProfileIdT&& value) {
157 m_partnerProfileIdHasBeenSet = true;
158 m_partnerProfileId = std::forward<PartnerProfileIdT>(value);
159 }
160 template <typename PartnerProfileIdT = Aws::String>
161 DescribedAgreement& WithPartnerProfileId(PartnerProfileIdT&& value) {
162 SetPartnerProfileId(std::forward<PartnerProfileIdT>(value));
163 return *this;
164 }
166
168
172 inline const Aws::String& GetBaseDirectory() const { return m_baseDirectory; }
173 inline bool BaseDirectoryHasBeenSet() const { return m_baseDirectoryHasBeenSet; }
174 template <typename BaseDirectoryT = Aws::String>
175 void SetBaseDirectory(BaseDirectoryT&& value) {
176 m_baseDirectoryHasBeenSet = true;
177 m_baseDirectory = std::forward<BaseDirectoryT>(value);
178 }
179 template <typename BaseDirectoryT = Aws::String>
180 DescribedAgreement& WithBaseDirectory(BaseDirectoryT&& value) {
181 SetBaseDirectory(std::forward<BaseDirectoryT>(value));
182 return *this;
183 }
185
187
213 inline const Aws::String& GetAccessRole() const { return m_accessRole; }
214 inline bool AccessRoleHasBeenSet() const { return m_accessRoleHasBeenSet; }
215 template <typename AccessRoleT = Aws::String>
216 void SetAccessRole(AccessRoleT&& value) {
217 m_accessRoleHasBeenSet = true;
218 m_accessRole = std::forward<AccessRoleT>(value);
219 }
220 template <typename AccessRoleT = Aws::String>
221 DescribedAgreement& WithAccessRole(AccessRoleT&& value) {
222 SetAccessRole(std::forward<AccessRoleT>(value));
223 return *this;
224 }
226
228
231 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
232 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
233 template <typename TagsT = Aws::Vector<Tag>>
234 void SetTags(TagsT&& value) {
235 m_tagsHasBeenSet = true;
236 m_tags = std::forward<TagsT>(value);
237 }
238 template <typename TagsT = Aws::Vector<Tag>>
239 DescribedAgreement& WithTags(TagsT&& value) {
240 SetTags(std::forward<TagsT>(value));
241 return *this;
242 }
243 template <typename TagsT = Tag>
244 DescribedAgreement& AddTags(TagsT&& value) {
245 m_tagsHasBeenSet = true;
246 m_tags.emplace_back(std::forward<TagsT>(value));
247 return *this;
248 }
250
252
262 inline PreserveFilenameType GetPreserveFilename() const { return m_preserveFilename; }
263 inline bool PreserveFilenameHasBeenSet() const { return m_preserveFilenameHasBeenSet; }
265 m_preserveFilenameHasBeenSet = true;
266 m_preserveFilename = value;
267 }
269 SetPreserveFilename(value);
270 return *this;
271 }
273
275
282 inline EnforceMessageSigningType GetEnforceMessageSigning() const { return m_enforceMessageSigning; }
283 inline bool EnforceMessageSigningHasBeenSet() const { return m_enforceMessageSigningHasBeenSet; }
285 m_enforceMessageSigningHasBeenSet = true;
286 m_enforceMessageSigning = value;
287 }
290 return *this;
291 }
293
295
302 inline const CustomDirectoriesType& GetCustomDirectories() const { return m_customDirectories; }
303 inline bool CustomDirectoriesHasBeenSet() const { return m_customDirectoriesHasBeenSet; }
304 template <typename CustomDirectoriesT = CustomDirectoriesType>
305 void SetCustomDirectories(CustomDirectoriesT&& value) {
306 m_customDirectoriesHasBeenSet = true;
307 m_customDirectories = std::forward<CustomDirectoriesT>(value);
308 }
309 template <typename CustomDirectoriesT = CustomDirectoriesType>
310 DescribedAgreement& WithCustomDirectories(CustomDirectoriesT&& value) {
311 SetCustomDirectories(std::forward<CustomDirectoriesT>(value));
312 return *this;
313 }
315 private:
316 Aws::String m_arn;
317
318 Aws::String m_agreementId;
319
320 Aws::String m_description;
321
323
324 Aws::String m_serverId;
325
326 Aws::String m_localProfileId;
327
328 Aws::String m_partnerProfileId;
329
330 Aws::String m_baseDirectory;
331
332 Aws::String m_accessRole;
333
334 Aws::Vector<Tag> m_tags;
335
337
339
340 CustomDirectoriesType m_customDirectories;
341 bool m_arnHasBeenSet = false;
342 bool m_agreementIdHasBeenSet = false;
343 bool m_descriptionHasBeenSet = false;
344 bool m_statusHasBeenSet = false;
345 bool m_serverIdHasBeenSet = false;
346 bool m_localProfileIdHasBeenSet = false;
347 bool m_partnerProfileIdHasBeenSet = false;
348 bool m_baseDirectoryHasBeenSet = false;
349 bool m_accessRoleHasBeenSet = false;
350 bool m_tagsHasBeenSet = false;
351 bool m_preserveFilenameHasBeenSet = false;
352 bool m_enforceMessageSigningHasBeenSet = false;
353 bool m_customDirectoriesHasBeenSet = false;
354};
355
356} // namespace Model
357} // namespace Transfer
358} // namespace Aws
AWS_TRANSFER_API Aws::Utils::Json::JsonValue Jsonize() const
AWS_TRANSFER_API DescribedAgreement & operator=(Aws::Utils::Json::JsonView jsonValue)
AWS_TRANSFER_API DescribedAgreement()=default
DescribedAgreement & WithPreserveFilename(PreserveFilenameType value)
DescribedAgreement & WithCustomDirectories(CustomDirectoriesT &&value)
DescribedAgreement & WithAccessRole(AccessRoleT &&value)
void SetLocalProfileId(LocalProfileIdT &&value)
DescribedAgreement & WithServerId(ServerIdT &&value)
void SetStatus(AgreementStatusType value)
DescribedAgreement & WithAgreementId(AgreementIdT &&value)
PreserveFilenameType GetPreserveFilename() const
DescribedAgreement & WithArn(ArnT &&value)
void SetPartnerProfileId(PartnerProfileIdT &&value)
const Aws::String & GetAgreementId() const
const CustomDirectoriesType & GetCustomDirectories() const
void SetEnforceMessageSigning(EnforceMessageSigningType value)
void SetCustomDirectories(CustomDirectoriesT &&value)
void SetBaseDirectory(BaseDirectoryT &&value)
void SetPreserveFilename(PreserveFilenameType value)
DescribedAgreement & WithEnforceMessageSigning(EnforceMessageSigningType value)
const Aws::String & GetPartnerProfileId() const
EnforceMessageSigningType GetEnforceMessageSigning() const
DescribedAgreement & WithTags(TagsT &&value)
DescribedAgreement & WithPartnerProfileId(PartnerProfileIdT &&value)
AWS_TRANSFER_API DescribedAgreement(Aws::Utils::Json::JsonView jsonValue)
const Aws::String & GetBaseDirectory() const
const Aws::Vector< Tag > & GetTags() const
DescribedAgreement & WithDescription(DescriptionT &&value)
DescribedAgreement & AddTags(TagsT &&value)
DescribedAgreement & WithBaseDirectory(BaseDirectoryT &&value)
const Aws::String & GetDescription() const
const Aws::String & GetLocalProfileId() const
DescribedAgreement & WithStatus(AgreementStatusType value)
DescribedAgreement & WithLocalProfileId(LocalProfileIdT &&value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue