AWS SDK for C++

AWS SDK for C++ Version 1.11.748

Loading...
Searching...
No Matches
UpdateAgreementRequest.h
1
6#pragma once
7#include <aws/awstransfer/TransferRequest.h>
8#include <aws/awstransfer/Transfer_EXPORTS.h>
9#include <aws/awstransfer/model/AgreementStatusType.h>
10#include <aws/awstransfer/model/CustomDirectoriesType.h>
11#include <aws/awstransfer/model/EnforceMessageSigningType.h>
12#include <aws/awstransfer/model/PreserveFilenameType.h>
13#include <aws/core/utils/memory/stl/AWSString.h>
14
15#include <utility>
16
17namespace Aws {
18namespace Transfer {
19namespace Model {
20
24 public:
25 AWS_TRANSFER_API UpdateAgreementRequest() = default;
26
27 // Service request name is the Operation name which will send this request out,
28 // each operation should has unique request name, so that we can get operation's name from this request.
29 // Note: this is not true for response, multiple operations may have the same response name,
30 // so we can not get operation's name from response.
31 inline virtual const char* GetServiceRequestName() const override { return "UpdateAgreement"; }
32
33 AWS_TRANSFER_API Aws::String SerializePayload() const override;
34
36
38
42 inline const Aws::String& GetAgreementId() const { return m_agreementId; }
43 inline bool AgreementIdHasBeenSet() const { return m_agreementIdHasBeenSet; }
44 template <typename AgreementIdT = Aws::String>
45 void SetAgreementId(AgreementIdT&& value) {
46 m_agreementIdHasBeenSet = true;
47 m_agreementId = std::forward<AgreementIdT>(value);
48 }
49 template <typename AgreementIdT = Aws::String>
50 UpdateAgreementRequest& WithAgreementId(AgreementIdT&& value) {
51 SetAgreementId(std::forward<AgreementIdT>(value));
52 return *this;
53 }
55
57
61 inline const Aws::String& GetServerId() const { return m_serverId; }
62 inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; }
63 template <typename ServerIdT = Aws::String>
64 void SetServerId(ServerIdT&& value) {
65 m_serverIdHasBeenSet = true;
66 m_serverId = std::forward<ServerIdT>(value);
67 }
68 template <typename ServerIdT = Aws::String>
70 SetServerId(std::forward<ServerIdT>(value));
71 return *this;
72 }
74
76
80 inline const Aws::String& GetDescription() const { return m_description; }
81 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
82 template <typename DescriptionT = Aws::String>
83 void SetDescription(DescriptionT&& value) {
84 m_descriptionHasBeenSet = true;
85 m_description = std::forward<DescriptionT>(value);
86 }
87 template <typename DescriptionT = Aws::String>
88 UpdateAgreementRequest& WithDescription(DescriptionT&& value) {
89 SetDescription(std::forward<DescriptionT>(value));
90 return *this;
91 }
93
95
99 inline AgreementStatusType GetStatus() const { return m_status; }
100 inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
101 inline void SetStatus(AgreementStatusType value) {
102 m_statusHasBeenSet = true;
103 m_status = value;
104 }
106 SetStatus(value);
107 return *this;
108 }
110
112
116 inline const Aws::String& GetLocalProfileId() const { return m_localProfileId; }
117 inline bool LocalProfileIdHasBeenSet() const { return m_localProfileIdHasBeenSet; }
118 template <typename LocalProfileIdT = Aws::String>
119 void SetLocalProfileId(LocalProfileIdT&& value) {
120 m_localProfileIdHasBeenSet = true;
121 m_localProfileId = std::forward<LocalProfileIdT>(value);
122 }
123 template <typename LocalProfileIdT = Aws::String>
124 UpdateAgreementRequest& WithLocalProfileId(LocalProfileIdT&& value) {
125 SetLocalProfileId(std::forward<LocalProfileIdT>(value));
126 return *this;
127 }
129
131
135 inline const Aws::String& GetPartnerProfileId() const { return m_partnerProfileId; }
136 inline bool PartnerProfileIdHasBeenSet() const { return m_partnerProfileIdHasBeenSet; }
137 template <typename PartnerProfileIdT = Aws::String>
138 void SetPartnerProfileId(PartnerProfileIdT&& value) {
139 m_partnerProfileIdHasBeenSet = true;
140 m_partnerProfileId = std::forward<PartnerProfileIdT>(value);
141 }
142 template <typename PartnerProfileIdT = Aws::String>
143 UpdateAgreementRequest& WithPartnerProfileId(PartnerProfileIdT&& value) {
144 SetPartnerProfileId(std::forward<PartnerProfileIdT>(value));
145 return *this;
146 }
148
150
155 inline const Aws::String& GetBaseDirectory() const { return m_baseDirectory; }
156 inline bool BaseDirectoryHasBeenSet() const { return m_baseDirectoryHasBeenSet; }
157 template <typename BaseDirectoryT = Aws::String>
158 void SetBaseDirectory(BaseDirectoryT&& value) {
159 m_baseDirectoryHasBeenSet = true;
160 m_baseDirectory = std::forward<BaseDirectoryT>(value);
161 }
162 template <typename BaseDirectoryT = Aws::String>
163 UpdateAgreementRequest& WithBaseDirectory(BaseDirectoryT&& value) {
164 SetBaseDirectory(std::forward<BaseDirectoryT>(value));
165 return *this;
166 }
168
170
196 inline const Aws::String& GetAccessRole() const { return m_accessRole; }
197 inline bool AccessRoleHasBeenSet() const { return m_accessRoleHasBeenSet; }
198 template <typename AccessRoleT = Aws::String>
199 void SetAccessRole(AccessRoleT&& value) {
200 m_accessRoleHasBeenSet = true;
201 m_accessRole = std::forward<AccessRoleT>(value);
202 }
203 template <typename AccessRoleT = Aws::String>
205 SetAccessRole(std::forward<AccessRoleT>(value));
206 return *this;
207 }
209
211
221 inline PreserveFilenameType GetPreserveFilename() const { return m_preserveFilename; }
222 inline bool PreserveFilenameHasBeenSet() const { return m_preserveFilenameHasBeenSet; }
224 m_preserveFilenameHasBeenSet = true;
225 m_preserveFilename = value;
226 }
228 SetPreserveFilename(value);
229 return *this;
230 }
232
234
241 inline EnforceMessageSigningType GetEnforceMessageSigning() const { return m_enforceMessageSigning; }
242 inline bool EnforceMessageSigningHasBeenSet() const { return m_enforceMessageSigningHasBeenSet; }
244 m_enforceMessageSigningHasBeenSet = true;
245 m_enforceMessageSigning = value;
246 }
249 return *this;
250 }
252
254
261 inline const CustomDirectoriesType& GetCustomDirectories() const { return m_customDirectories; }
262 inline bool CustomDirectoriesHasBeenSet() const { return m_customDirectoriesHasBeenSet; }
263 template <typename CustomDirectoriesT = CustomDirectoriesType>
264 void SetCustomDirectories(CustomDirectoriesT&& value) {
265 m_customDirectoriesHasBeenSet = true;
266 m_customDirectories = std::forward<CustomDirectoriesT>(value);
267 }
268 template <typename CustomDirectoriesT = CustomDirectoriesType>
269 UpdateAgreementRequest& WithCustomDirectories(CustomDirectoriesT&& value) {
270 SetCustomDirectories(std::forward<CustomDirectoriesT>(value));
271 return *this;
272 }
274 private:
275 Aws::String m_agreementId;
276
277 Aws::String m_serverId;
278
279 Aws::String m_description;
280
282
283 Aws::String m_localProfileId;
284
285 Aws::String m_partnerProfileId;
286
287 Aws::String m_baseDirectory;
288
289 Aws::String m_accessRole;
290
292
294
295 CustomDirectoriesType m_customDirectories;
296 bool m_agreementIdHasBeenSet = false;
297 bool m_serverIdHasBeenSet = false;
298 bool m_descriptionHasBeenSet = false;
299 bool m_statusHasBeenSet = false;
300 bool m_localProfileIdHasBeenSet = false;
301 bool m_partnerProfileIdHasBeenSet = false;
302 bool m_baseDirectoryHasBeenSet = false;
303 bool m_accessRoleHasBeenSet = false;
304 bool m_preserveFilenameHasBeenSet = false;
305 bool m_enforceMessageSigningHasBeenSet = false;
306 bool m_customDirectoriesHasBeenSet = false;
307};
308
309} // namespace Model
310} // namespace Transfer
311} // namespace Aws
UpdateAgreementRequest & WithPreserveFilename(PreserveFilenameType value)
void SetPartnerProfileId(PartnerProfileIdT &&value)
AWS_TRANSFER_API Aws::String SerializePayload() const override
EnforceMessageSigningType GetEnforceMessageSigning() const
UpdateAgreementRequest & WithPartnerProfileId(PartnerProfileIdT &&value)
void SetEnforceMessageSigning(EnforceMessageSigningType value)
UpdateAgreementRequest & WithAgreementId(AgreementIdT &&value)
UpdateAgreementRequest & WithEnforceMessageSigning(EnforceMessageSigningType value)
const CustomDirectoriesType & GetCustomDirectories() const
UpdateAgreementRequest & WithCustomDirectories(CustomDirectoriesT &&value)
void SetPreserveFilename(PreserveFilenameType value)
UpdateAgreementRequest & WithDescription(DescriptionT &&value)
UpdateAgreementRequest & WithServerId(ServerIdT &&value)
AWS_TRANSFER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
UpdateAgreementRequest & WithAccessRole(AccessRoleT &&value)
AWS_TRANSFER_API UpdateAgreementRequest()=default
UpdateAgreementRequest & WithLocalProfileId(LocalProfileIdT &&value)
UpdateAgreementRequest & WithBaseDirectory(BaseDirectoryT &&value)
UpdateAgreementRequest & WithStatus(AgreementStatusType value)
void SetCustomDirectories(CustomDirectoriesT &&value)
virtual const char * GetServiceRequestName() const override
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String