AWS SDK for C++

AWS SDK for C++ Version 1.11.935

Loading...
Searching...
No Matches
DescribeUsersRequest.h
1
6#pragma once
7#include <aws/core/utils/memory/stl/AWSString.h>
8#include <aws/workdocs/WorkDocsRequest.h>
9#include <aws/workdocs/WorkDocs_EXPORTS.h>
10#include <aws/workdocs/model/OrderType.h>
11#include <aws/workdocs/model/UserFilterType.h>
12#include <aws/workdocs/model/UserSortType.h>
13
14#include <utility>
15
16namespace Aws {
17namespace Http {
18class URI;
19} // namespace Http
20namespace WorkDocs {
21namespace Model {
22
26 public:
27 AWS_WORKDOCS_API DescribeUsersRequest() = 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 "DescribeUsers"; }
34
35 AWS_WORKDOCS_API Aws::String SerializePayload() const override;
36
37 AWS_WORKDOCS_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
38
40
42
46 inline const Aws::String& GetAuthenticationToken() const { return m_authenticationToken; }
47 inline bool AuthenticationTokenHasBeenSet() const { return m_authenticationTokenHasBeenSet; }
48 template <typename AuthenticationTokenT = Aws::String>
49 void SetAuthenticationToken(AuthenticationTokenT&& value) {
50 m_authenticationTokenHasBeenSet = true;
51 m_authenticationToken = std::forward<AuthenticationTokenT>(value);
52 }
53 template <typename AuthenticationTokenT = Aws::String>
54 DescribeUsersRequest& WithAuthenticationToken(AuthenticationTokenT&& value) {
55 SetAuthenticationToken(std::forward<AuthenticationTokenT>(value));
56 return *this;
57 }
59
61
64 inline const Aws::String& GetOrganizationId() const { return m_organizationId; }
65 inline bool OrganizationIdHasBeenSet() const { return m_organizationIdHasBeenSet; }
66 template <typename OrganizationIdT = Aws::String>
67 void SetOrganizationId(OrganizationIdT&& value) {
68 m_organizationIdHasBeenSet = true;
69 m_organizationId = std::forward<OrganizationIdT>(value);
70 }
71 template <typename OrganizationIdT = Aws::String>
72 DescribeUsersRequest& WithOrganizationId(OrganizationIdT&& value) {
73 SetOrganizationId(std::forward<OrganizationIdT>(value));
74 return *this;
75 }
77
79
82 inline const Aws::String& GetUserIds() const { return m_userIds; }
83 inline bool UserIdsHasBeenSet() const { return m_userIdsHasBeenSet; }
84 template <typename UserIdsT = Aws::String>
85 void SetUserIds(UserIdsT&& value) {
86 m_userIdsHasBeenSet = true;
87 m_userIds = std::forward<UserIdsT>(value);
88 }
89 template <typename UserIdsT = Aws::String>
90 DescribeUsersRequest& WithUserIds(UserIdsT&& value) {
91 SetUserIds(std::forward<UserIdsT>(value));
92 return *this;
93 }
95
97
113 inline const Aws::String& GetQuery() const { return m_query; }
114 inline bool QueryHasBeenSet() const { return m_queryHasBeenSet; }
115 template <typename QueryT = Aws::String>
116 void SetQuery(QueryT&& value) {
117 m_queryHasBeenSet = true;
118 m_query = std::forward<QueryT>(value);
119 }
120 template <typename QueryT = Aws::String>
122 SetQuery(std::forward<QueryT>(value));
123 return *this;
124 }
126
128
131 inline UserFilterType GetInclude() const { return m_include; }
132 inline bool IncludeHasBeenSet() const { return m_includeHasBeenSet; }
133 inline void SetInclude(UserFilterType value) {
134 m_includeHasBeenSet = true;
135 m_include = value;
136 }
138 SetInclude(value);
139 return *this;
140 }
142
144
147 inline OrderType GetOrder() const { return m_order; }
148 inline bool OrderHasBeenSet() const { return m_orderHasBeenSet; }
149 inline void SetOrder(OrderType value) {
150 m_orderHasBeenSet = true;
151 m_order = value;
152 }
154 SetOrder(value);
155 return *this;
156 }
158
160
163 inline UserSortType GetSort() const { return m_sort; }
164 inline bool SortHasBeenSet() const { return m_sortHasBeenSet; }
165 inline void SetSort(UserSortType value) {
166 m_sortHasBeenSet = true;
167 m_sort = value;
168 }
170 SetSort(value);
171 return *this;
172 }
174
176
180 inline const Aws::String& GetMarker() const { return m_marker; }
181 inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; }
182 template <typename MarkerT = Aws::String>
183 void SetMarker(MarkerT&& value) {
184 m_markerHasBeenSet = true;
185 m_marker = std::forward<MarkerT>(value);
186 }
187 template <typename MarkerT = Aws::String>
189 SetMarker(std::forward<MarkerT>(value));
190 return *this;
191 }
193
195
198 inline int GetLimit() const { return m_limit; }
199 inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; }
200 inline void SetLimit(int value) {
201 m_limitHasBeenSet = true;
202 m_limit = value;
203 }
204 inline DescribeUsersRequest& WithLimit(int value) {
205 SetLimit(value);
206 return *this;
207 }
209
211
215 inline const Aws::String& GetFields() const { return m_fields; }
216 inline bool FieldsHasBeenSet() const { return m_fieldsHasBeenSet; }
217 template <typename FieldsT = Aws::String>
218 void SetFields(FieldsT&& value) {
219 m_fieldsHasBeenSet = true;
220 m_fields = std::forward<FieldsT>(value);
221 }
222 template <typename FieldsT = Aws::String>
224 SetFields(std::forward<FieldsT>(value));
225 return *this;
226 }
228 private:
229 Aws::String m_authenticationToken;
230
231 Aws::String m_organizationId;
232
233 Aws::String m_userIds;
234
235 Aws::String m_query;
236
238
240
242
243 Aws::String m_marker;
244
245 int m_limit{0};
246
247 Aws::String m_fields;
248 bool m_authenticationTokenHasBeenSet = false;
249 bool m_organizationIdHasBeenSet = false;
250 bool m_userIdsHasBeenSet = false;
251 bool m_queryHasBeenSet = false;
252 bool m_includeHasBeenSet = false;
253 bool m_orderHasBeenSet = false;
254 bool m_sortHasBeenSet = false;
255 bool m_markerHasBeenSet = false;
256 bool m_limitHasBeenSet = false;
257 bool m_fieldsHasBeenSet = false;
258};
259
260} // namespace Model
261} // namespace WorkDocs
262} // namespace Aws
AWS_WORKDOCS_API DescribeUsersRequest()=default
DescribeUsersRequest & WithOrganizationId(OrganizationIdT &&value)
DescribeUsersRequest & WithUserIds(UserIdsT &&value)
void SetAuthenticationToken(AuthenticationTokenT &&value)
const Aws::String & GetAuthenticationToken() const
AWS_WORKDOCS_API Aws::String SerializePayload() const override
DescribeUsersRequest & WithMarker(MarkerT &&value)
AWS_WORKDOCS_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
DescribeUsersRequest & WithSort(UserSortType value)
DescribeUsersRequest & WithLimit(int value)
void SetOrganizationId(OrganizationIdT &&value)
DescribeUsersRequest & WithInclude(UserFilterType value)
DescribeUsersRequest & WithAuthenticationToken(AuthenticationTokenT &&value)
AWS_WORKDOCS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
virtual const char * GetServiceRequestName() const override
DescribeUsersRequest & WithQuery(QueryT &&value)
DescribeUsersRequest & WithOrder(OrderType value)
DescribeUsersRequest & WithFields(FieldsT &&value)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String