AWS SDK for C++

AWS SDK for C++ Version 1.11.607

Loading...
Searching...
No Matches
DescribeUsersRequest.h
1
6#pragma once
7#include <aws/workdocs/WorkDocs_EXPORTS.h>
8#include <aws/workdocs/WorkDocsRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/workdocs/model/UserFilterType.h>
11#include <aws/workdocs/model/OrderType.h>
12#include <aws/workdocs/model/UserSortType.h>
13#include <utility>
14
15namespace Aws
16{
17namespace Http
18{
19 class URI;
20} //namespace Http
21namespace WorkDocs
22{
23namespace Model
24{
25
29 {
30 public:
31 AWS_WORKDOCS_API DescribeUsersRequest() = default;
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_WORKDOCS_API Aws::String SerializePayload() const override;
40
41 AWS_WORKDOCS_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
42
44
45
47
51 inline const Aws::String& GetAuthenticationToken() const { return m_authenticationToken; }
52 inline bool AuthenticationTokenHasBeenSet() const { return m_authenticationTokenHasBeenSet; }
53 template<typename AuthenticationTokenT = Aws::String>
54 void SetAuthenticationToken(AuthenticationTokenT&& value) { m_authenticationTokenHasBeenSet = true; m_authenticationToken = std::forward<AuthenticationTokenT>(value); }
55 template<typename AuthenticationTokenT = Aws::String>
56 DescribeUsersRequest& WithAuthenticationToken(AuthenticationTokenT&& value) { SetAuthenticationToken(std::forward<AuthenticationTokenT>(value)); return *this;}
58
60
63 inline const Aws::String& GetOrganizationId() const { return m_organizationId; }
64 inline bool OrganizationIdHasBeenSet() const { return m_organizationIdHasBeenSet; }
65 template<typename OrganizationIdT = Aws::String>
66 void SetOrganizationId(OrganizationIdT&& value) { m_organizationIdHasBeenSet = true; m_organizationId = std::forward<OrganizationIdT>(value); }
67 template<typename OrganizationIdT = Aws::String>
68 DescribeUsersRequest& WithOrganizationId(OrganizationIdT&& value) { SetOrganizationId(std::forward<OrganizationIdT>(value)); return *this;}
70
72
75 inline const Aws::String& GetUserIds() const { return m_userIds; }
76 inline bool UserIdsHasBeenSet() const { return m_userIdsHasBeenSet; }
77 template<typename UserIdsT = Aws::String>
78 void SetUserIds(UserIdsT&& value) { m_userIdsHasBeenSet = true; m_userIds = std::forward<UserIdsT>(value); }
79 template<typename UserIdsT = Aws::String>
80 DescribeUsersRequest& WithUserIds(UserIdsT&& value) { SetUserIds(std::forward<UserIdsT>(value)); return *this;}
82
84
100 inline const Aws::String& GetQuery() const { return m_query; }
101 inline bool QueryHasBeenSet() const { return m_queryHasBeenSet; }
102 template<typename QueryT = Aws::String>
103 void SetQuery(QueryT&& value) { m_queryHasBeenSet = true; m_query = std::forward<QueryT>(value); }
104 template<typename QueryT = Aws::String>
105 DescribeUsersRequest& WithQuery(QueryT&& value) { SetQuery(std::forward<QueryT>(value)); return *this;}
107
109
112 inline UserFilterType GetInclude() const { return m_include; }
113 inline bool IncludeHasBeenSet() const { return m_includeHasBeenSet; }
114 inline void SetInclude(UserFilterType value) { m_includeHasBeenSet = true; m_include = value; }
115 inline DescribeUsersRequest& WithInclude(UserFilterType value) { SetInclude(value); return *this;}
117
119
122 inline OrderType GetOrder() const { return m_order; }
123 inline bool OrderHasBeenSet() const { return m_orderHasBeenSet; }
124 inline void SetOrder(OrderType value) { m_orderHasBeenSet = true; m_order = value; }
125 inline DescribeUsersRequest& WithOrder(OrderType value) { SetOrder(value); return *this;}
127
129
132 inline UserSortType GetSort() const { return m_sort; }
133 inline bool SortHasBeenSet() const { return m_sortHasBeenSet; }
134 inline void SetSort(UserSortType value) { m_sortHasBeenSet = true; m_sort = value; }
135 inline DescribeUsersRequest& WithSort(UserSortType value) { SetSort(value); return *this;}
137
139
143 inline const Aws::String& GetMarker() const { return m_marker; }
144 inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; }
145 template<typename MarkerT = Aws::String>
146 void SetMarker(MarkerT&& value) { m_markerHasBeenSet = true; m_marker = std::forward<MarkerT>(value); }
147 template<typename MarkerT = Aws::String>
148 DescribeUsersRequest& WithMarker(MarkerT&& value) { SetMarker(std::forward<MarkerT>(value)); return *this;}
150
152
155 inline int GetLimit() const { return m_limit; }
156 inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; }
157 inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; }
158 inline DescribeUsersRequest& WithLimit(int value) { SetLimit(value); return *this;}
160
162
166 inline const Aws::String& GetFields() const { return m_fields; }
167 inline bool FieldsHasBeenSet() const { return m_fieldsHasBeenSet; }
168 template<typename FieldsT = Aws::String>
169 void SetFields(FieldsT&& value) { m_fieldsHasBeenSet = true; m_fields = std::forward<FieldsT>(value); }
170 template<typename FieldsT = Aws::String>
171 DescribeUsersRequest& WithFields(FieldsT&& value) { SetFields(std::forward<FieldsT>(value)); return *this;}
173 private:
174
175 Aws::String m_authenticationToken;
176 bool m_authenticationTokenHasBeenSet = false;
177
178 Aws::String m_organizationId;
179 bool m_organizationIdHasBeenSet = false;
180
181 Aws::String m_userIds;
182 bool m_userIdsHasBeenSet = false;
183
184 Aws::String m_query;
185 bool m_queryHasBeenSet = false;
186
188 bool m_includeHasBeenSet = false;
189
191 bool m_orderHasBeenSet = false;
192
194 bool m_sortHasBeenSet = false;
195
196 Aws::String m_marker;
197 bool m_markerHasBeenSet = false;
198
199 int m_limit{0};
200 bool m_limitHasBeenSet = false;
201
202 Aws::String m_fields;
203 bool m_fieldsHasBeenSet = false;
204 };
205
206} // namespace Model
207} // namespace WorkDocs
208} // 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