AWS SDK for C++  1.9.124
AWS SDK for C++
DescribeUsersRequest.h
Go to the documentation of this file.
1 
6 #pragma once
13 #include <utility>
14 
15 namespace Aws
16 {
17 namespace Http
18 {
19  class URI;
20 } //namespace Http
21 namespace WorkDocs
22 {
23 namespace Model
24 {
25 
29  {
30  public:
32 
33  // Service request name is the Operation name which will send this request out,
34  // each operation should has unique request name, so that we can get operation's name from this request.
35  // Note: this is not true for response, multiple operations may have the same response name,
36  // so we can not get operation's name from response.
37  inline virtual const char* GetServiceRequestName() const override { return "DescribeUsers"; }
38 
39  Aws::String SerializePayload() const override;
40 
41  void AddQueryStringParameters(Aws::Http::URI& uri) const override;
42 
44 
45 
50  inline const Aws::String& GetAuthenticationToken() const{ return m_authenticationToken; }
51 
56  inline bool AuthenticationTokenHasBeenSet() const { return m_authenticationTokenHasBeenSet; }
57 
62  inline void SetAuthenticationToken(const Aws::String& value) { m_authenticationTokenHasBeenSet = true; m_authenticationToken = value; }
63 
68  inline void SetAuthenticationToken(Aws::String&& value) { m_authenticationTokenHasBeenSet = true; m_authenticationToken = std::move(value); }
69 
74  inline void SetAuthenticationToken(const char* value) { m_authenticationTokenHasBeenSet = true; m_authenticationToken.assign(value); }
75 
80  inline DescribeUsersRequest& WithAuthenticationToken(const Aws::String& value) { SetAuthenticationToken(value); return *this;}
81 
86  inline DescribeUsersRequest& WithAuthenticationToken(Aws::String&& value) { SetAuthenticationToken(std::move(value)); return *this;}
87 
92  inline DescribeUsersRequest& WithAuthenticationToken(const char* value) { SetAuthenticationToken(value); return *this;}
93 
94 
98  inline const Aws::String& GetOrganizationId() const{ return m_organizationId; }
99 
103  inline bool OrganizationIdHasBeenSet() const { return m_organizationIdHasBeenSet; }
104 
108  inline void SetOrganizationId(const Aws::String& value) { m_organizationIdHasBeenSet = true; m_organizationId = value; }
109 
113  inline void SetOrganizationId(Aws::String&& value) { m_organizationIdHasBeenSet = true; m_organizationId = std::move(value); }
114 
118  inline void SetOrganizationId(const char* value) { m_organizationIdHasBeenSet = true; m_organizationId.assign(value); }
119 
123  inline DescribeUsersRequest& WithOrganizationId(const Aws::String& value) { SetOrganizationId(value); return *this;}
124 
128  inline DescribeUsersRequest& WithOrganizationId(Aws::String&& value) { SetOrganizationId(std::move(value)); return *this;}
129 
133  inline DescribeUsersRequest& WithOrganizationId(const char* value) { SetOrganizationId(value); return *this;}
134 
135 
139  inline const Aws::String& GetUserIds() const{ return m_userIds; }
140 
144  inline bool UserIdsHasBeenSet() const { return m_userIdsHasBeenSet; }
145 
149  inline void SetUserIds(const Aws::String& value) { m_userIdsHasBeenSet = true; m_userIds = value; }
150 
154  inline void SetUserIds(Aws::String&& value) { m_userIdsHasBeenSet = true; m_userIds = std::move(value); }
155 
159  inline void SetUserIds(const char* value) { m_userIdsHasBeenSet = true; m_userIds.assign(value); }
160 
164  inline DescribeUsersRequest& WithUserIds(const Aws::String& value) { SetUserIds(value); return *this;}
165 
169  inline DescribeUsersRequest& WithUserIds(Aws::String&& value) { SetUserIds(std::move(value)); return *this;}
170 
174  inline DescribeUsersRequest& WithUserIds(const char* value) { SetUserIds(value); return *this;}
175 
176 
180  inline const Aws::String& GetQuery() const{ return m_query; }
181 
185  inline bool QueryHasBeenSet() const { return m_queryHasBeenSet; }
186 
190  inline void SetQuery(const Aws::String& value) { m_queryHasBeenSet = true; m_query = value; }
191 
195  inline void SetQuery(Aws::String&& value) { m_queryHasBeenSet = true; m_query = std::move(value); }
196 
200  inline void SetQuery(const char* value) { m_queryHasBeenSet = true; m_query.assign(value); }
201 
205  inline DescribeUsersRequest& WithQuery(const Aws::String& value) { SetQuery(value); return *this;}
206 
210  inline DescribeUsersRequest& WithQuery(Aws::String&& value) { SetQuery(std::move(value)); return *this;}
211 
215  inline DescribeUsersRequest& WithQuery(const char* value) { SetQuery(value); return *this;}
216 
217 
221  inline const UserFilterType& GetInclude() const{ return m_include; }
222 
226  inline bool IncludeHasBeenSet() const { return m_includeHasBeenSet; }
227 
231  inline void SetInclude(const UserFilterType& value) { m_includeHasBeenSet = true; m_include = value; }
232 
236  inline void SetInclude(UserFilterType&& value) { m_includeHasBeenSet = true; m_include = std::move(value); }
237 
241  inline DescribeUsersRequest& WithInclude(const UserFilterType& value) { SetInclude(value); return *this;}
242 
246  inline DescribeUsersRequest& WithInclude(UserFilterType&& value) { SetInclude(std::move(value)); return *this;}
247 
248 
252  inline const OrderType& GetOrder() const{ return m_order; }
253 
257  inline bool OrderHasBeenSet() const { return m_orderHasBeenSet; }
258 
262  inline void SetOrder(const OrderType& value) { m_orderHasBeenSet = true; m_order = value; }
263 
267  inline void SetOrder(OrderType&& value) { m_orderHasBeenSet = true; m_order = std::move(value); }
268 
272  inline DescribeUsersRequest& WithOrder(const OrderType& value) { SetOrder(value); return *this;}
273 
277  inline DescribeUsersRequest& WithOrder(OrderType&& value) { SetOrder(std::move(value)); return *this;}
278 
279 
283  inline const UserSortType& GetSort() const{ return m_sort; }
284 
288  inline bool SortHasBeenSet() const { return m_sortHasBeenSet; }
289 
293  inline void SetSort(const UserSortType& value) { m_sortHasBeenSet = true; m_sort = value; }
294 
298  inline void SetSort(UserSortType&& value) { m_sortHasBeenSet = true; m_sort = std::move(value); }
299 
303  inline DescribeUsersRequest& WithSort(const UserSortType& value) { SetSort(value); return *this;}
304 
308  inline DescribeUsersRequest& WithSort(UserSortType&& value) { SetSort(std::move(value)); return *this;}
309 
310 
315  inline const Aws::String& GetMarker() const{ return m_marker; }
316 
321  inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; }
322 
327  inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; }
328 
333  inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); }
334 
339  inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); }
340 
345  inline DescribeUsersRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;}
346 
351  inline DescribeUsersRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;}
352 
357  inline DescribeUsersRequest& WithMarker(const char* value) { SetMarker(value); return *this;}
358 
359 
363  inline int GetLimit() const{ return m_limit; }
364 
368  inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; }
369 
373  inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; }
374 
378  inline DescribeUsersRequest& WithLimit(int value) { SetLimit(value); return *this;}
379 
380 
385  inline const Aws::String& GetFields() const{ return m_fields; }
386 
391  inline bool FieldsHasBeenSet() const { return m_fieldsHasBeenSet; }
392 
397  inline void SetFields(const Aws::String& value) { m_fieldsHasBeenSet = true; m_fields = value; }
398 
403  inline void SetFields(Aws::String&& value) { m_fieldsHasBeenSet = true; m_fields = std::move(value); }
404 
409  inline void SetFields(const char* value) { m_fieldsHasBeenSet = true; m_fields.assign(value); }
410 
415  inline DescribeUsersRequest& WithFields(const Aws::String& value) { SetFields(value); return *this;}
416 
421  inline DescribeUsersRequest& WithFields(Aws::String&& value) { SetFields(std::move(value)); return *this;}
422 
427  inline DescribeUsersRequest& WithFields(const char* value) { SetFields(value); return *this;}
428 
429  private:
430 
431  Aws::String m_authenticationToken;
432  bool m_authenticationTokenHasBeenSet;
433 
434  Aws::String m_organizationId;
435  bool m_organizationIdHasBeenSet;
436 
437  Aws::String m_userIds;
438  bool m_userIdsHasBeenSet;
439 
440  Aws::String m_query;
441  bool m_queryHasBeenSet;
442 
443  UserFilterType m_include;
444  bool m_includeHasBeenSet;
445 
446  OrderType m_order;
447  bool m_orderHasBeenSet;
448 
449  UserSortType m_sort;
450  bool m_sortHasBeenSet;
451 
452  Aws::String m_marker;
453  bool m_markerHasBeenSet;
454 
455  int m_limit;
456  bool m_limitHasBeenSet;
457 
458  Aws::String m_fields;
459  bool m_fieldsHasBeenSet;
460  };
461 
462 } // namespace Model
463 } // namespace WorkDocs
464 } // namespace Aws
Aws::WorkDocs::Model::DescribeUsersRequest::SetLimit
void SetLimit(int value)
Definition: DescribeUsersRequest.h:373
Aws::WorkDocs::Model::DescribeUsersRequest::GetSort
const UserSortType & GetSort() const
Definition: DescribeUsersRequest.h:283
Aws::WorkDocs::Model::DescribeUsersRequest::QueryHasBeenSet
bool QueryHasBeenSet() const
Definition: DescribeUsersRequest.h:185
Aws::WorkDocs::Model::DescribeUsersRequest::SetQuery
void SetQuery(const char *value)
Definition: DescribeUsersRequest.h:200
Aws::WorkDocs::Model::DescribeUsersRequest::WithInclude
DescribeUsersRequest & WithInclude(UserFilterType &&value)
Definition: DescribeUsersRequest.h:246
Aws::WorkDocs::Model::DescribeUsersRequest::SetMarker
void SetMarker(Aws::String &&value)
Definition: DescribeUsersRequest.h:333
Aws::Http::URI
Definition: URI.h:32
Aws::WorkDocs::Model::DescribeUsersRequest::WithMarker
DescribeUsersRequest & WithMarker(Aws::String &&value)
Definition: DescribeUsersRequest.h:351
Aws::WorkDocs::Model::DescribeUsersRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::WorkDocs::Model::DescribeUsersRequest::SetInclude
void SetInclude(UserFilterType &&value)
Definition: DescribeUsersRequest.h:236
Aws::WorkDocs::Model::DescribeUsersRequest::SetAuthenticationToken
void SetAuthenticationToken(Aws::String &&value)
Definition: DescribeUsersRequest.h:68
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::WorkDocs::Model::DescribeUsersRequest::GetLimit
int GetLimit() const
Definition: DescribeUsersRequest.h:363
Aws::WorkDocs::Model::DescribeUsersRequest::GetOrganizationId
const Aws::String & GetOrganizationId() const
Definition: DescribeUsersRequest.h:98
Aws::WorkDocs::Model::DescribeUsersRequest::SetOrder
void SetOrder(const OrderType &value)
Definition: DescribeUsersRequest.h:262
Aws::WorkDocs::Model::DescribeUsersRequest::OrganizationIdHasBeenSet
bool OrganizationIdHasBeenSet() const
Definition: DescribeUsersRequest.h:103
Aws::WorkDocs::Model::DescribeUsersRequest::WithUserIds
DescribeUsersRequest & WithUserIds(Aws::String &&value)
Definition: DescribeUsersRequest.h:169
Aws::WorkDocs::WorkDocsRequest
Definition: WorkDocsRequest.h:17
Aws::WorkDocs::Model::DescribeUsersRequest::SetUserIds
void SetUserIds(const Aws::String &value)
Definition: DescribeUsersRequest.h:149
Aws::WorkDocs::Model::DescribeUsersRequest::MarkerHasBeenSet
bool MarkerHasBeenSet() const
Definition: DescribeUsersRequest.h:321
Aws::WorkDocs::Model::DescribeUsersRequest::SetAuthenticationToken
void SetAuthenticationToken(const char *value)
Definition: DescribeUsersRequest.h:74
Aws::WorkDocs::Model::DescribeUsersRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: DescribeUsersRequest.h:37
Aws::WorkDocs::Model::DescribeUsersRequest::SetFields
void SetFields(const Aws::String &value)
Definition: DescribeUsersRequest.h:397
Aws::WorkDocs::Model::DescribeUsersRequest::WithInclude
DescribeUsersRequest & WithInclude(const UserFilterType &value)
Definition: DescribeUsersRequest.h:241
Aws::WorkDocs::Model::DescribeUsersRequest::WithAuthenticationToken
DescribeUsersRequest & WithAuthenticationToken(const char *value)
Definition: DescribeUsersRequest.h:92
Aws::WorkDocs::Model::DescribeUsersRequest::WithOrganizationId
DescribeUsersRequest & WithOrganizationId(const char *value)
Definition: DescribeUsersRequest.h:133
Aws::WorkDocs::Model::DescribeUsersRequest::SetUserIds
void SetUserIds(const char *value)
Definition: DescribeUsersRequest.h:159
Aws::WorkDocs::Model::DescribeUsersRequest::GetFields
const Aws::String & GetFields() const
Definition: DescribeUsersRequest.h:385
Aws::WorkDocs::Model::DescribeUsersRequest::WithAuthenticationToken
DescribeUsersRequest & WithAuthenticationToken(const Aws::String &value)
Definition: DescribeUsersRequest.h:80
Aws::WorkDocs::Model::DescribeUsersRequest::GetInclude
const UserFilterType & GetInclude() const
Definition: DescribeUsersRequest.h:221
Aws::WorkDocs::Model::DescribeUsersRequest::WithUserIds
DescribeUsersRequest & WithUserIds(const char *value)
Definition: DescribeUsersRequest.h:174
Aws::WorkDocs::Model::DescribeUsersRequest::AddQueryStringParameters
void AddQueryStringParameters(Aws::Http::URI &uri) const override
Aws::WorkDocs::Model::DescribeUsersRequest::SetOrganizationId
void SetOrganizationId(const Aws::String &value)
Definition: DescribeUsersRequest.h:108
Aws::WorkDocs::Model::OrderType
OrderType
Definition: OrderType.h:17
Aws::WorkDocs::Model::DescribeUsersRequest::WithOrganizationId
DescribeUsersRequest & WithOrganizationId(Aws::String &&value)
Definition: DescribeUsersRequest.h:128
Aws::WorkDocs::Model::DescribeUsersRequest::SortHasBeenSet
bool SortHasBeenSet() const
Definition: DescribeUsersRequest.h:288
Aws::WorkDocs::Model::DescribeUsersRequest::GetMarker
const Aws::String & GetMarker() const
Definition: DescribeUsersRequest.h:315
UserFilterType.h
Aws::WorkDocs::Model::DescribeUsersRequest::SetMarker
void SetMarker(const Aws::String &value)
Definition: DescribeUsersRequest.h:327
Aws::WorkDocs::Model::DescribeUsersRequest::WithOrder
DescribeUsersRequest & WithOrder(const OrderType &value)
Definition: DescribeUsersRequest.h:272
Aws::WorkDocs::Model::DescribeUsersRequest::WithUserIds
DescribeUsersRequest & WithUserIds(const Aws::String &value)
Definition: DescribeUsersRequest.h:164
Aws::WorkDocs::Model::DescribeUsersRequest::SetSort
void SetSort(const UserSortType &value)
Definition: DescribeUsersRequest.h:293
OrderType.h
Aws::WorkDocs::Model::DescribeUsersRequest::SetQuery
void SetQuery(const Aws::String &value)
Definition: DescribeUsersRequest.h:190
Aws::WorkDocs::Model::DescribeUsersRequest::GetQuery
const Aws::String & GetQuery() const
Definition: DescribeUsersRequest.h:180
Aws::WorkDocs::Model::DescribeUsersRequest::SetOrder
void SetOrder(OrderType &&value)
Definition: DescribeUsersRequest.h:267
Aws::WorkDocs::Model::DescribeUsersRequest::SetMarker
void SetMarker(const char *value)
Definition: DescribeUsersRequest.h:339
Aws::WorkDocs::Model::DescribeUsersRequest::GetAuthenticationToken
const Aws::String & GetAuthenticationToken() const
Definition: DescribeUsersRequest.h:50
WorkDocs_EXPORTS.h
Aws::WorkDocs::Model::DescribeUsersRequest::OrderHasBeenSet
bool OrderHasBeenSet() const
Definition: DescribeUsersRequest.h:257
Aws::WorkDocs::Model::DescribeUsersRequest::WithLimit
DescribeUsersRequest & WithLimit(int value)
Definition: DescribeUsersRequest.h:378
Aws::WorkDocs::Model::DescribeUsersRequest::SetOrganizationId
void SetOrganizationId(const char *value)
Definition: DescribeUsersRequest.h:118
Aws::WorkDocs::Model::DescribeUsersRequest::WithOrder
DescribeUsersRequest & WithOrder(OrderType &&value)
Definition: DescribeUsersRequest.h:277
AWSString.h
Aws::WorkDocs::Model::DescribeUsersRequest::IncludeHasBeenSet
bool IncludeHasBeenSet() const
Definition: DescribeUsersRequest.h:226
Aws::WorkDocs::Model::DescribeUsersRequest::UserIdsHasBeenSet
bool UserIdsHasBeenSet() const
Definition: DescribeUsersRequest.h:144
Aws::WorkDocs::Model::DescribeUsersRequest::AuthenticationTokenHasBeenSet
bool AuthenticationTokenHasBeenSet() const
Definition: DescribeUsersRequest.h:56
Aws::WorkDocs::Model::DescribeUsersRequest::SetSort
void SetSort(UserSortType &&value)
Definition: DescribeUsersRequest.h:298
Aws::WorkDocs::Model::DescribeUsersRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::WorkDocs::Model::DescribeUsersRequest::WithOrganizationId
DescribeUsersRequest & WithOrganizationId(const Aws::String &value)
Definition: DescribeUsersRequest.h:123
Aws::WorkDocs::Model::DescribeUsersRequest::SetOrganizationId
void SetOrganizationId(Aws::String &&value)
Definition: DescribeUsersRequest.h:113
Aws::WorkDocs::Model::DescribeUsersRequest::WithFields
DescribeUsersRequest & WithFields(const char *value)
Definition: DescribeUsersRequest.h:427
Aws::WorkDocs::Model::DescribeUsersRequest::WithQuery
DescribeUsersRequest & WithQuery(const Aws::String &value)
Definition: DescribeUsersRequest.h:205
Aws::WorkDocs::Model::DescribeUsersRequest::GetUserIds
const Aws::String & GetUserIds() const
Definition: DescribeUsersRequest.h:139
Aws::WorkDocs::Model::DescribeUsersRequest::WithAuthenticationToken
DescribeUsersRequest & WithAuthenticationToken(Aws::String &&value)
Definition: DescribeUsersRequest.h:86
AWS_WORKDOCS_API
#define AWS_WORKDOCS_API
Definition: WorkDocs_EXPORTS.h:28
Aws::WorkDocs::Model::DescribeUsersRequest::WithSort
DescribeUsersRequest & WithSort(UserSortType &&value)
Definition: DescribeUsersRequest.h:308
Aws::WorkDocs::Model::DescribeUsersRequest::DescribeUsersRequest
DescribeUsersRequest()
Aws::WorkDocs::Model::DescribeUsersRequest::WithQuery
DescribeUsersRequest & WithQuery(const char *value)
Definition: DescribeUsersRequest.h:215
Aws::WorkDocs::Model::DescribeUsersRequest::WithMarker
DescribeUsersRequest & WithMarker(const char *value)
Definition: DescribeUsersRequest.h:357
Aws
Definition: AccessManagementClient.h:15
UserSortType.h
Aws::WorkDocs::Model::DescribeUsersRequest::WithFields
DescribeUsersRequest & WithFields(Aws::String &&value)
Definition: DescribeUsersRequest.h:421
Aws::WorkDocs::Model::DescribeUsersRequest::WithQuery
DescribeUsersRequest & WithQuery(Aws::String &&value)
Definition: DescribeUsersRequest.h:210
WorkDocsRequest.h
Aws::WorkDocs::Model::DescribeUsersRequest::SetInclude
void SetInclude(const UserFilterType &value)
Definition: DescribeUsersRequest.h:231
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::WorkDocs::Model::DescribeUsersRequest::WithMarker
DescribeUsersRequest & WithMarker(const Aws::String &value)
Definition: DescribeUsersRequest.h:345
Aws::WorkDocs::Model::DescribeUsersRequest::SetQuery
void SetQuery(Aws::String &&value)
Definition: DescribeUsersRequest.h:195
Aws::WorkDocs::Model::DescribeUsersRequest::LimitHasBeenSet
bool LimitHasBeenSet() const
Definition: DescribeUsersRequest.h:368
Aws::WorkDocs::Model::UserFilterType
UserFilterType
Definition: UserFilterType.h:17
Aws::WorkDocs::Model::DescribeUsersRequest::WithSort
DescribeUsersRequest & WithSort(const UserSortType &value)
Definition: DescribeUsersRequest.h:303
Aws::WorkDocs::Model::UserSortType
UserSortType
Definition: UserSortType.h:17
Aws::WorkDocs::Model::DescribeUsersRequest::SetFields
void SetFields(const char *value)
Definition: DescribeUsersRequest.h:409
Aws::WorkDocs::Model::DescribeUsersRequest::SetAuthenticationToken
void SetAuthenticationToken(const Aws::String &value)
Definition: DescribeUsersRequest.h:62
Aws::WorkDocs::Model::DescribeUsersRequest::GetOrder
const OrderType & GetOrder() const
Definition: DescribeUsersRequest.h:252
Aws::WorkDocs::Model::DescribeUsersRequest
Definition: DescribeUsersRequest.h:29
Aws::WorkDocs::Model::DescribeUsersRequest::WithFields
DescribeUsersRequest & WithFields(const Aws::String &value)
Definition: DescribeUsersRequest.h:415
Aws::WorkDocs::Model::DescribeUsersRequest::SetFields
void SetFields(Aws::String &&value)
Definition: DescribeUsersRequest.h:403
Aws::WorkDocs::Model::DescribeUsersRequest::FieldsHasBeenSet
bool FieldsHasBeenSet() const
Definition: DescribeUsersRequest.h:391
Aws::WorkDocs::Model::DescribeUsersRequest::SetUserIds
void SetUserIds(Aws::String &&value)
Definition: DescribeUsersRequest.h:154