AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
CreateAgreementRequest.h
1
6#pragma once
7#include <aws/awstransfer/Transfer_EXPORTS.h>
8#include <aws/awstransfer/TransferRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/awstransfer/model/AgreementStatusType.h>
11#include <aws/core/utils/memory/stl/AWSVector.h>
12#include <aws/awstransfer/model/PreserveFilenameType.h>
13#include <aws/awstransfer/model/EnforceMessageSigningType.h>
14#include <aws/awstransfer/model/CustomDirectoriesType.h>
15#include <aws/awstransfer/model/Tag.h>
16#include <utility>
17
18namespace Aws
19{
20namespace Transfer
21{
22namespace Model
23{
24
28 {
29 public:
30 AWS_TRANSFER_API CreateAgreementRequest() = default;
31
32 // Service request name is the Operation name which will send this request out,
33 // each operation should has unique request name, so that we can get operation's name from this request.
34 // Note: this is not true for response, multiple operations may have the same response name,
35 // so we can not get operation's name from response.
36 inline virtual const char* GetServiceRequestName() const override { return "CreateAgreement"; }
37
38 AWS_TRANSFER_API Aws::String SerializePayload() const override;
39
41
42
44
47 inline const Aws::String& GetDescription() const { return m_description; }
48 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
49 template<typename DescriptionT = Aws::String>
50 void SetDescription(DescriptionT&& value) { m_descriptionHasBeenSet = true; m_description = std::forward<DescriptionT>(value); }
51 template<typename DescriptionT = Aws::String>
52 CreateAgreementRequest& WithDescription(DescriptionT&& value) { SetDescription(std::forward<DescriptionT>(value)); return *this;}
54
56
60 inline const Aws::String& GetServerId() const { return m_serverId; }
61 inline bool ServerIdHasBeenSet() const { return m_serverIdHasBeenSet; }
62 template<typename ServerIdT = Aws::String>
63 void SetServerId(ServerIdT&& value) { m_serverIdHasBeenSet = true; m_serverId = std::forward<ServerIdT>(value); }
64 template<typename ServerIdT = Aws::String>
65 CreateAgreementRequest& WithServerId(ServerIdT&& value) { SetServerId(std::forward<ServerIdT>(value)); return *this;}
67
69
72 inline const Aws::String& GetLocalProfileId() const { return m_localProfileId; }
73 inline bool LocalProfileIdHasBeenSet() const { return m_localProfileIdHasBeenSet; }
74 template<typename LocalProfileIdT = Aws::String>
75 void SetLocalProfileId(LocalProfileIdT&& value) { m_localProfileIdHasBeenSet = true; m_localProfileId = std::forward<LocalProfileIdT>(value); }
76 template<typename LocalProfileIdT = Aws::String>
77 CreateAgreementRequest& WithLocalProfileId(LocalProfileIdT&& value) { SetLocalProfileId(std::forward<LocalProfileIdT>(value)); return *this;}
79
81
84 inline const Aws::String& GetPartnerProfileId() const { return m_partnerProfileId; }
85 inline bool PartnerProfileIdHasBeenSet() const { return m_partnerProfileIdHasBeenSet; }
86 template<typename PartnerProfileIdT = Aws::String>
87 void SetPartnerProfileId(PartnerProfileIdT&& value) { m_partnerProfileIdHasBeenSet = true; m_partnerProfileId = std::forward<PartnerProfileIdT>(value); }
88 template<typename PartnerProfileIdT = Aws::String>
89 CreateAgreementRequest& WithPartnerProfileId(PartnerProfileIdT&& value) { SetPartnerProfileId(std::forward<PartnerProfileIdT>(value)); return *this;}
91
93
98 inline const Aws::String& GetBaseDirectory() const { return m_baseDirectory; }
99 inline bool BaseDirectoryHasBeenSet() const { return m_baseDirectoryHasBeenSet; }
100 template<typename BaseDirectoryT = Aws::String>
101 void SetBaseDirectory(BaseDirectoryT&& value) { m_baseDirectoryHasBeenSet = true; m_baseDirectory = std::forward<BaseDirectoryT>(value); }
102 template<typename BaseDirectoryT = Aws::String>
103 CreateAgreementRequest& WithBaseDirectory(BaseDirectoryT&& value) { SetBaseDirectory(std::forward<BaseDirectoryT>(value)); return *this;}
105
107
133 inline const Aws::String& GetAccessRole() const { return m_accessRole; }
134 inline bool AccessRoleHasBeenSet() const { return m_accessRoleHasBeenSet; }
135 template<typename AccessRoleT = Aws::String>
136 void SetAccessRole(AccessRoleT&& value) { m_accessRoleHasBeenSet = true; m_accessRole = std::forward<AccessRoleT>(value); }
137 template<typename AccessRoleT = Aws::String>
138 CreateAgreementRequest& WithAccessRole(AccessRoleT&& value) { SetAccessRole(std::forward<AccessRoleT>(value)); return *this;}
140
142
146 inline AgreementStatusType GetStatus() const { return m_status; }
147 inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
148 inline void SetStatus(AgreementStatusType value) { m_statusHasBeenSet = true; m_status = value; }
149 inline CreateAgreementRequest& WithStatus(AgreementStatusType value) { SetStatus(value); return *this;}
151
153
156 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
157 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
158 template<typename TagsT = Aws::Vector<Tag>>
159 void SetTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags = std::forward<TagsT>(value); }
160 template<typename TagsT = Aws::Vector<Tag>>
161 CreateAgreementRequest& WithTags(TagsT&& value) { SetTags(std::forward<TagsT>(value)); return *this;}
162 template<typename TagsT = Tag>
163 CreateAgreementRequest& AddTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags.emplace_back(std::forward<TagsT>(value)); return *this; }
165
167
177 inline PreserveFilenameType GetPreserveFilename() const { return m_preserveFilename; }
178 inline bool PreserveFilenameHasBeenSet() const { return m_preserveFilenameHasBeenSet; }
179 inline void SetPreserveFilename(PreserveFilenameType value) { m_preserveFilenameHasBeenSet = true; m_preserveFilename = value; }
182
184
191 inline EnforceMessageSigningType GetEnforceMessageSigning() const { return m_enforceMessageSigning; }
192 inline bool EnforceMessageSigningHasBeenSet() const { return m_enforceMessageSigningHasBeenSet; }
193 inline void SetEnforceMessageSigning(EnforceMessageSigningType value) { m_enforceMessageSigningHasBeenSet = true; m_enforceMessageSigning = value; }
196
198
205 inline const CustomDirectoriesType& GetCustomDirectories() const { return m_customDirectories; }
206 inline bool CustomDirectoriesHasBeenSet() const { return m_customDirectoriesHasBeenSet; }
207 template<typename CustomDirectoriesT = CustomDirectoriesType>
208 void SetCustomDirectories(CustomDirectoriesT&& value) { m_customDirectoriesHasBeenSet = true; m_customDirectories = std::forward<CustomDirectoriesT>(value); }
209 template<typename CustomDirectoriesT = CustomDirectoriesType>
210 CreateAgreementRequest& WithCustomDirectories(CustomDirectoriesT&& value) { SetCustomDirectories(std::forward<CustomDirectoriesT>(value)); return *this;}
212 private:
213
214 Aws::String m_description;
215 bool m_descriptionHasBeenSet = false;
216
217 Aws::String m_serverId;
218 bool m_serverIdHasBeenSet = false;
219
220 Aws::String m_localProfileId;
221 bool m_localProfileIdHasBeenSet = false;
222
223 Aws::String m_partnerProfileId;
224 bool m_partnerProfileIdHasBeenSet = false;
225
226 Aws::String m_baseDirectory;
227 bool m_baseDirectoryHasBeenSet = false;
228
229 Aws::String m_accessRole;
230 bool m_accessRoleHasBeenSet = false;
231
233 bool m_statusHasBeenSet = false;
234
235 Aws::Vector<Tag> m_tags;
236 bool m_tagsHasBeenSet = false;
237
239 bool m_preserveFilenameHasBeenSet = false;
240
242 bool m_enforceMessageSigningHasBeenSet = false;
243
244 CustomDirectoriesType m_customDirectories;
245 bool m_customDirectoriesHasBeenSet = false;
246 };
247
248} // namespace Model
249} // namespace Transfer
250} // 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