AWS SDK for C++

AWS SDK for C++ Version 1.11.440

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();
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 inline void SetAuthenticationToken(const Aws::String& value) { m_authenticationTokenHasBeenSet = true; m_authenticationToken = value; }
54 inline void SetAuthenticationToken(Aws::String&& value) { m_authenticationTokenHasBeenSet = true; m_authenticationToken = std::move(value); }
55 inline void SetAuthenticationToken(const char* value) { m_authenticationTokenHasBeenSet = true; m_authenticationToken.assign(value); }
57 inline DescribeUsersRequest& WithAuthenticationToken(Aws::String&& value) { SetAuthenticationToken(std::move(value)); return *this;}
58 inline DescribeUsersRequest& WithAuthenticationToken(const char* value) { SetAuthenticationToken(value); return *this;}
60
62
65 inline const Aws::String& GetOrganizationId() const{ return m_organizationId; }
66 inline bool OrganizationIdHasBeenSet() const { return m_organizationIdHasBeenSet; }
67 inline void SetOrganizationId(const Aws::String& value) { m_organizationIdHasBeenSet = true; m_organizationId = value; }
68 inline void SetOrganizationId(Aws::String&& value) { m_organizationIdHasBeenSet = true; m_organizationId = std::move(value); }
69 inline void SetOrganizationId(const char* value) { m_organizationIdHasBeenSet = true; m_organizationId.assign(value); }
70 inline DescribeUsersRequest& WithOrganizationId(const Aws::String& value) { SetOrganizationId(value); return *this;}
71 inline DescribeUsersRequest& WithOrganizationId(Aws::String&& value) { SetOrganizationId(std::move(value)); return *this;}
72 inline DescribeUsersRequest& WithOrganizationId(const char* value) { SetOrganizationId(value); return *this;}
74
76
79 inline const Aws::String& GetUserIds() const{ return m_userIds; }
80 inline bool UserIdsHasBeenSet() const { return m_userIdsHasBeenSet; }
81 inline void SetUserIds(const Aws::String& value) { m_userIdsHasBeenSet = true; m_userIds = value; }
82 inline void SetUserIds(Aws::String&& value) { m_userIdsHasBeenSet = true; m_userIds = std::move(value); }
83 inline void SetUserIds(const char* value) { m_userIdsHasBeenSet = true; m_userIds.assign(value); }
84 inline DescribeUsersRequest& WithUserIds(const Aws::String& value) { SetUserIds(value); return *this;}
85 inline DescribeUsersRequest& WithUserIds(Aws::String&& value) { SetUserIds(std::move(value)); return *this;}
86 inline DescribeUsersRequest& WithUserIds(const char* value) { SetUserIds(value); return *this;}
88
90
106 inline const Aws::String& GetQuery() const{ return m_query; }
107 inline bool QueryHasBeenSet() const { return m_queryHasBeenSet; }
108 inline void SetQuery(const Aws::String& value) { m_queryHasBeenSet = true; m_query = value; }
109 inline void SetQuery(Aws::String&& value) { m_queryHasBeenSet = true; m_query = std::move(value); }
110 inline void SetQuery(const char* value) { m_queryHasBeenSet = true; m_query.assign(value); }
111 inline DescribeUsersRequest& WithQuery(const Aws::String& value) { SetQuery(value); return *this;}
112 inline DescribeUsersRequest& WithQuery(Aws::String&& value) { SetQuery(std::move(value)); return *this;}
113 inline DescribeUsersRequest& WithQuery(const char* value) { SetQuery(value); return *this;}
115
117
120 inline const UserFilterType& GetInclude() const{ return m_include; }
121 inline bool IncludeHasBeenSet() const { return m_includeHasBeenSet; }
122 inline void SetInclude(const UserFilterType& value) { m_includeHasBeenSet = true; m_include = value; }
123 inline void SetInclude(UserFilterType&& value) { m_includeHasBeenSet = true; m_include = std::move(value); }
124 inline DescribeUsersRequest& WithInclude(const UserFilterType& value) { SetInclude(value); return *this;}
125 inline DescribeUsersRequest& WithInclude(UserFilterType&& value) { SetInclude(std::move(value)); return *this;}
127
129
132 inline const OrderType& GetOrder() const{ return m_order; }
133 inline bool OrderHasBeenSet() const { return m_orderHasBeenSet; }
134 inline void SetOrder(const OrderType& value) { m_orderHasBeenSet = true; m_order = value; }
135 inline void SetOrder(OrderType&& value) { m_orderHasBeenSet = true; m_order = std::move(value); }
136 inline DescribeUsersRequest& WithOrder(const OrderType& value) { SetOrder(value); return *this;}
137 inline DescribeUsersRequest& WithOrder(OrderType&& value) { SetOrder(std::move(value)); return *this;}
139
141
144 inline const UserSortType& GetSort() const{ return m_sort; }
145 inline bool SortHasBeenSet() const { return m_sortHasBeenSet; }
146 inline void SetSort(const UserSortType& value) { m_sortHasBeenSet = true; m_sort = value; }
147 inline void SetSort(UserSortType&& value) { m_sortHasBeenSet = true; m_sort = std::move(value); }
148 inline DescribeUsersRequest& WithSort(const UserSortType& value) { SetSort(value); return *this;}
149 inline DescribeUsersRequest& WithSort(UserSortType&& value) { SetSort(std::move(value)); return *this;}
151
153
157 inline const Aws::String& GetMarker() const{ return m_marker; }
158 inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; }
159 inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; }
160 inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); }
161 inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); }
162 inline DescribeUsersRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;}
163 inline DescribeUsersRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;}
164 inline DescribeUsersRequest& WithMarker(const char* value) { SetMarker(value); return *this;}
166
168
171 inline int GetLimit() const{ return m_limit; }
172 inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; }
173 inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; }
174 inline DescribeUsersRequest& WithLimit(int value) { SetLimit(value); return *this;}
176
178
182 inline const Aws::String& GetFields() const{ return m_fields; }
183 inline bool FieldsHasBeenSet() const { return m_fieldsHasBeenSet; }
184 inline void SetFields(const Aws::String& value) { m_fieldsHasBeenSet = true; m_fields = value; }
185 inline void SetFields(Aws::String&& value) { m_fieldsHasBeenSet = true; m_fields = std::move(value); }
186 inline void SetFields(const char* value) { m_fieldsHasBeenSet = true; m_fields.assign(value); }
187 inline DescribeUsersRequest& WithFields(const Aws::String& value) { SetFields(value); return *this;}
188 inline DescribeUsersRequest& WithFields(Aws::String&& value) { SetFields(std::move(value)); return *this;}
189 inline DescribeUsersRequest& WithFields(const char* value) { SetFields(value); return *this;}
191 private:
192
193 Aws::String m_authenticationToken;
194 bool m_authenticationTokenHasBeenSet = false;
195
196 Aws::String m_organizationId;
197 bool m_organizationIdHasBeenSet = false;
198
199 Aws::String m_userIds;
200 bool m_userIdsHasBeenSet = false;
201
202 Aws::String m_query;
203 bool m_queryHasBeenSet = false;
204
205 UserFilterType m_include;
206 bool m_includeHasBeenSet = false;
207
208 OrderType m_order;
209 bool m_orderHasBeenSet = false;
210
211 UserSortType m_sort;
212 bool m_sortHasBeenSet = false;
213
214 Aws::String m_marker;
215 bool m_markerHasBeenSet = false;
216
217 int m_limit;
218 bool m_limitHasBeenSet = false;
219
220 Aws::String m_fields;
221 bool m_fieldsHasBeenSet = false;
222 };
223
224} // namespace Model
225} // namespace WorkDocs
226} // namespace Aws
DescribeUsersRequest & WithSort(UserSortType &&value)
DescribeUsersRequest & WithAuthenticationToken(Aws::String &&value)
const Aws::String & GetAuthenticationToken() const
AWS_WORKDOCS_API Aws::String SerializePayload() const override
DescribeUsersRequest & WithOrganizationId(const char *value)
DescribeUsersRequest & WithAuthenticationToken(const Aws::String &value)
DescribeUsersRequest & WithMarker(const char *value)
void SetOrganizationId(const Aws::String &value)
DescribeUsersRequest & WithUserIds(Aws::String &&value)
DescribeUsersRequest & WithUserIds(const char *value)
DescribeUsersRequest & WithQuery(const char *value)
DescribeUsersRequest & WithQuery(Aws::String &&value)
AWS_WORKDOCS_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
void SetInclude(const UserFilterType &value)
DescribeUsersRequest & WithFields(const char *value)
DescribeUsersRequest & WithAuthenticationToken(const char *value)
DescribeUsersRequest & WithLimit(int value)
DescribeUsersRequest & WithUserIds(const Aws::String &value)
DescribeUsersRequest & WithOrder(const OrderType &value)
DescribeUsersRequest & WithOrder(OrderType &&value)
DescribeUsersRequest & WithFields(Aws::String &&value)
DescribeUsersRequest & WithInclude(const UserFilterType &value)
DescribeUsersRequest & WithFields(const Aws::String &value)
DescribeUsersRequest & WithInclude(UserFilterType &&value)
DescribeUsersRequest & WithOrganizationId(const Aws::String &value)
DescribeUsersRequest & WithMarker(const Aws::String &value)
DescribeUsersRequest & WithQuery(const Aws::String &value)
DescribeUsersRequest & WithSort(const UserSortType &value)
AWS_WORKDOCS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
virtual const char * GetServiceRequestName() const override
void SetAuthenticationToken(const Aws::String &value)
DescribeUsersRequest & WithOrganizationId(Aws::String &&value)
DescribeUsersRequest & WithMarker(Aws::String &&value)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String