AWS SDK for C++

AWS SDK for C++ Version 1.11.688

Loading...
Searching...
No Matches
CreateAgreementRequest.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/awstransfer/model/Tag.h>
14#include <aws/core/utils/memory/stl/AWSString.h>
15#include <aws/core/utils/memory/stl/AWSVector.h>
16
17#include <utility>
18
19namespace Aws {
20namespace Transfer {
21namespace Model {
22
26 public:
27 AWS_TRANSFER_API CreateAgreementRequest() = default;
28
29 // Service request name is the Operation name which will send this request out,
30 // each operation should has unique request name, so that we can get operation's name from this request.
31 // Note: this is not true for response, multiple operations may have the same response name,
32 // so we can not get operation's name from response.
33 inline virtual const char* GetServiceRequestName() const override { return "CreateAgreement"; }
34
35 AWS_TRANSFER_API Aws::String SerializePayload() const override;
36
38
40
43 inline const Aws::String& GetDescription() const { return m_description; }
44 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
45 template <typename DescriptionT = Aws::String>
46 void SetDescription(DescriptionT&& value) {
47 m_descriptionHasBeenSet = true;
48 m_description = std::forward<DescriptionT>(value);
49 }
50 template <typename DescriptionT = Aws::String>
51 CreateAgreementRequest& WithDescription(DescriptionT&& value) {
52 SetDescription(std::forward<DescriptionT>(value));
53 return *this;
54 }
56
58
62 inline const Aws::String& GetServerId() const { return m_serverId; }
63 inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; }
64 template <typename ServerIdT = Aws::String>
65 void SetServerId(ServerIdT&& value) {
66 m_serverIdHasBeenSet = true;
67 m_serverId = std::forward<ServerIdT>(value);
68 }
69 template <typename ServerIdT = Aws::String>
71 SetServerId(std::forward<ServerIdT>(value));
72 return *this;
73 }
75
77
80 inline const Aws::String& GetLocalProfileId() const { return m_localProfileId; }
81 inline bool LocalProfileIdHasBeenSet() const { return m_localProfileIdHasBeenSet; }
82 template <typename LocalProfileIdT = Aws::String>
83 void SetLocalProfileId(LocalProfileIdT&& value) {
84 m_localProfileIdHasBeenSet = true;
85 m_localProfileId = std::forward<LocalProfileIdT>(value);
86 }
87 template <typename LocalProfileIdT = Aws::String>
88 CreateAgreementRequest& WithLocalProfileId(LocalProfileIdT&& value) {
89 SetLocalProfileId(std::forward<LocalProfileIdT>(value));
90 return *this;
91 }
93
95
98 inline const Aws::String& GetPartnerProfileId() const { return m_partnerProfileId; }
99 inline bool PartnerProfileIdHasBeenSet() const { return m_partnerProfileIdHasBeenSet; }
100 template <typename PartnerProfileIdT = Aws::String>
101 void SetPartnerProfileId(PartnerProfileIdT&& value) {
102 m_partnerProfileIdHasBeenSet = true;
103 m_partnerProfileId = std::forward<PartnerProfileIdT>(value);
104 }
105 template <typename PartnerProfileIdT = Aws::String>
106 CreateAgreementRequest& WithPartnerProfileId(PartnerProfileIdT&& value) {
107 SetPartnerProfileId(std::forward<PartnerProfileIdT>(value));
108 return *this;
109 }
111
113
118 inline const Aws::String& GetBaseDirectory() const { return m_baseDirectory; }
119 inline bool BaseDirectoryHasBeenSet() const { return m_baseDirectoryHasBeenSet; }
120 template <typename BaseDirectoryT = Aws::String>
121 void SetBaseDirectory(BaseDirectoryT&& value) {
122 m_baseDirectoryHasBeenSet = true;
123 m_baseDirectory = std::forward<BaseDirectoryT>(value);
124 }
125 template <typename BaseDirectoryT = Aws::String>
126 CreateAgreementRequest& WithBaseDirectory(BaseDirectoryT&& value) {
127 SetBaseDirectory(std::forward<BaseDirectoryT>(value));
128 return *this;
129 }
131
133
159 inline const Aws::String& GetAccessRole() const { return m_accessRole; }
160 inline bool AccessRoleHasBeenSet() const { return m_accessRoleHasBeenSet; }
161 template <typename AccessRoleT = Aws::String>
162 void SetAccessRole(AccessRoleT&& value) {
163 m_accessRoleHasBeenSet = true;
164 m_accessRole = std::forward<AccessRoleT>(value);
165 }
166 template <typename AccessRoleT = Aws::String>
168 SetAccessRole(std::forward<AccessRoleT>(value));
169 return *this;
170 }
172
174
178 inline AgreementStatusType GetStatus() const { return m_status; }
179 inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
180 inline void SetStatus(AgreementStatusType value) {
181 m_statusHasBeenSet = true;
182 m_status = value;
183 }
185 SetStatus(value);
186 return *this;
187 }
189
191
194 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
195 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
196 template <typename TagsT = Aws::Vector<Tag>>
197 void SetTags(TagsT&& value) {
198 m_tagsHasBeenSet = true;
199 m_tags = std::forward<TagsT>(value);
200 }
201 template <typename TagsT = Aws::Vector<Tag>>
203 SetTags(std::forward<TagsT>(value));
204 return *this;
205 }
206 template <typename TagsT = Tag>
208 m_tagsHasBeenSet = true;
209 m_tags.emplace_back(std::forward<TagsT>(value));
210 return *this;
211 }
213
215
225 inline PreserveFilenameType GetPreserveFilename() const { return m_preserveFilename; }
226 inline bool PreserveFilenameHasBeenSet() const { return m_preserveFilenameHasBeenSet; }
228 m_preserveFilenameHasBeenSet = true;
229 m_preserveFilename = value;
230 }
232 SetPreserveFilename(value);
233 return *this;
234 }
236
238
245 inline EnforceMessageSigningType GetEnforceMessageSigning() const { return m_enforceMessageSigning; }
246 inline bool EnforceMessageSigningHasBeenSet() const { return m_enforceMessageSigningHasBeenSet; }
248 m_enforceMessageSigningHasBeenSet = true;
249 m_enforceMessageSigning = value;
250 }
253 return *this;
254 }
256
258
265 inline const CustomDirectoriesType& GetCustomDirectories() const { return m_customDirectories; }
266 inline bool CustomDirectoriesHasBeenSet() const { return m_customDirectoriesHasBeenSet; }
267 template <typename CustomDirectoriesT = CustomDirectoriesType>
268 void SetCustomDirectories(CustomDirectoriesT&& value) {
269 m_customDirectoriesHasBeenSet = true;
270 m_customDirectories = std::forward<CustomDirectoriesT>(value);
271 }
272 template <typename CustomDirectoriesT = CustomDirectoriesType>
273 CreateAgreementRequest& WithCustomDirectories(CustomDirectoriesT&& value) {
274 SetCustomDirectories(std::forward<CustomDirectoriesT>(value));
275 return *this;
276 }
278 private:
279 Aws::String m_description;
280 bool m_descriptionHasBeenSet = false;
281
282 Aws::String m_serverId;
283 bool m_serverIdHasBeenSet = false;
284
285 Aws::String m_localProfileId;
286 bool m_localProfileIdHasBeenSet = false;
287
288 Aws::String m_partnerProfileId;
289 bool m_partnerProfileIdHasBeenSet = false;
290
291 Aws::String m_baseDirectory;
292 bool m_baseDirectoryHasBeenSet = false;
293
294 Aws::String m_accessRole;
295 bool m_accessRoleHasBeenSet = false;
296
298 bool m_statusHasBeenSet = false;
299
300 Aws::Vector<Tag> m_tags;
301 bool m_tagsHasBeenSet = false;
302
304 bool m_preserveFilenameHasBeenSet = false;
305
307 bool m_enforceMessageSigningHasBeenSet = false;
308
309 CustomDirectoriesType m_customDirectories;
310 bool m_customDirectoriesHasBeenSet = false;
311};
312
313} // namespace Model
314} // namespace Transfer
315} // namespace Aws
CreateAgreementRequest & WithDescription(DescriptionT &&value)
AWS_TRANSFER_API Aws::String SerializePayload() const override
CreateAgreementRequest & WithTags(TagsT &&value)
const CustomDirectoriesType & GetCustomDirectories() const
CreateAgreementRequest & AddTags(TagsT &&value)
AWS_TRANSFER_API CreateAgreementRequest()=default
CreateAgreementRequest & WithServerId(ServerIdT &&value)
CreateAgreementRequest & WithEnforceMessageSigning(EnforceMessageSigningType value)
void SetPreserveFilename(PreserveFilenameType value)
CreateAgreementRequest & WithCustomDirectories(CustomDirectoriesT &&value)
CreateAgreementRequest & WithPreserveFilename(PreserveFilenameType value)
AWS_TRANSFER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
CreateAgreementRequest & WithStatus(AgreementStatusType value)
CreateAgreementRequest & WithPartnerProfileId(PartnerProfileIdT &&value)
EnforceMessageSigningType GetEnforceMessageSigning() const
CreateAgreementRequest & WithAccessRole(AccessRoleT &&value)
virtual const char * GetServiceRequestName() const override
void SetEnforceMessageSigning(EnforceMessageSigningType value)
CreateAgreementRequest & WithBaseDirectory(BaseDirectoryT &&value)
void SetCustomDirectories(CustomDirectoriesT &&value)
void SetPartnerProfileId(PartnerProfileIdT &&value)
CreateAgreementRequest & WithLocalProfileId(LocalProfileIdT &&value)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector