AWS SDK for C++  1.9.40
AWS SDK for C++
DescribeWorkspacesRequest.h
Go to the documentation of this file.
1 
6 #pragma once
11 #include <utility>
12 
13 namespace Aws
14 {
15 namespace WorkSpaces
16 {
17 namespace Model
18 {
19 
23  {
24  public:
26 
27  // Service request name is the Operation name which will send this request out,
28  // each operation should has unique request name, so that we can get operation's name from this request.
29  // Note: this is not true for response, multiple operations may have the same response name,
30  // so we can not get operation's name from response.
31  inline virtual const char* GetServiceRequestName() const override { return "DescribeWorkspaces"; }
32 
33  Aws::String SerializePayload() const override;
34 
36 
37 
45  inline const Aws::Vector<Aws::String>& GetWorkspaceIds() const{ return m_workspaceIds; }
46 
54  inline bool WorkspaceIdsHasBeenSet() const { return m_workspaceIdsHasBeenSet; }
55 
63  inline void SetWorkspaceIds(const Aws::Vector<Aws::String>& value) { m_workspaceIdsHasBeenSet = true; m_workspaceIds = value; }
64 
72  inline void SetWorkspaceIds(Aws::Vector<Aws::String>&& value) { m_workspaceIdsHasBeenSet = true; m_workspaceIds = std::move(value); }
73 
81  inline DescribeWorkspacesRequest& WithWorkspaceIds(const Aws::Vector<Aws::String>& value) { SetWorkspaceIds(value); return *this;}
82 
90  inline DescribeWorkspacesRequest& WithWorkspaceIds(Aws::Vector<Aws::String>&& value) { SetWorkspaceIds(std::move(value)); return *this;}
91 
99  inline DescribeWorkspacesRequest& AddWorkspaceIds(const Aws::String& value) { m_workspaceIdsHasBeenSet = true; m_workspaceIds.push_back(value); return *this; }
100 
108  inline DescribeWorkspacesRequest& AddWorkspaceIds(Aws::String&& value) { m_workspaceIdsHasBeenSet = true; m_workspaceIds.push_back(std::move(value)); return *this; }
109 
117  inline DescribeWorkspacesRequest& AddWorkspaceIds(const char* value) { m_workspaceIdsHasBeenSet = true; m_workspaceIds.push_back(value); return *this; }
118 
119 
125  inline const Aws::String& GetDirectoryId() const{ return m_directoryId; }
126 
132  inline bool DirectoryIdHasBeenSet() const { return m_directoryIdHasBeenSet; }
133 
139  inline void SetDirectoryId(const Aws::String& value) { m_directoryIdHasBeenSet = true; m_directoryId = value; }
140 
146  inline void SetDirectoryId(Aws::String&& value) { m_directoryIdHasBeenSet = true; m_directoryId = std::move(value); }
147 
153  inline void SetDirectoryId(const char* value) { m_directoryIdHasBeenSet = true; m_directoryId.assign(value); }
154 
160  inline DescribeWorkspacesRequest& WithDirectoryId(const Aws::String& value) { SetDirectoryId(value); return *this;}
161 
167  inline DescribeWorkspacesRequest& WithDirectoryId(Aws::String&& value) { SetDirectoryId(std::move(value)); return *this;}
168 
174  inline DescribeWorkspacesRequest& WithDirectoryId(const char* value) { SetDirectoryId(value); return *this;}
175 
176 
181  inline const Aws::String& GetUserName() const{ return m_userName; }
182 
187  inline bool UserNameHasBeenSet() const { return m_userNameHasBeenSet; }
188 
193  inline void SetUserName(const Aws::String& value) { m_userNameHasBeenSet = true; m_userName = value; }
194 
199  inline void SetUserName(Aws::String&& value) { m_userNameHasBeenSet = true; m_userName = std::move(value); }
200 
205  inline void SetUserName(const char* value) { m_userNameHasBeenSet = true; m_userName.assign(value); }
206 
211  inline DescribeWorkspacesRequest& WithUserName(const Aws::String& value) { SetUserName(value); return *this;}
212 
217  inline DescribeWorkspacesRequest& WithUserName(Aws::String&& value) { SetUserName(std::move(value)); return *this;}
218 
223  inline DescribeWorkspacesRequest& WithUserName(const char* value) { SetUserName(value); return *this;}
224 
225 
231  inline const Aws::String& GetBundleId() const{ return m_bundleId; }
232 
238  inline bool BundleIdHasBeenSet() const { return m_bundleIdHasBeenSet; }
239 
245  inline void SetBundleId(const Aws::String& value) { m_bundleIdHasBeenSet = true; m_bundleId = value; }
246 
252  inline void SetBundleId(Aws::String&& value) { m_bundleIdHasBeenSet = true; m_bundleId = std::move(value); }
253 
259  inline void SetBundleId(const char* value) { m_bundleIdHasBeenSet = true; m_bundleId.assign(value); }
260 
266  inline DescribeWorkspacesRequest& WithBundleId(const Aws::String& value) { SetBundleId(value); return *this;}
267 
273  inline DescribeWorkspacesRequest& WithBundleId(Aws::String&& value) { SetBundleId(std::move(value)); return *this;}
274 
280  inline DescribeWorkspacesRequest& WithBundleId(const char* value) { SetBundleId(value); return *this;}
281 
282 
286  inline int GetLimit() const{ return m_limit; }
287 
291  inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; }
292 
296  inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; }
297 
301  inline DescribeWorkspacesRequest& WithLimit(int value) { SetLimit(value); return *this;}
302 
303 
308  inline const Aws::String& GetNextToken() const{ return m_nextToken; }
309 
314  inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
315 
320  inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
321 
326  inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
327 
332  inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
333 
338  inline DescribeWorkspacesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
339 
344  inline DescribeWorkspacesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
345 
350  inline DescribeWorkspacesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
351 
352  private:
353 
354  Aws::Vector<Aws::String> m_workspaceIds;
355  bool m_workspaceIdsHasBeenSet;
356 
357  Aws::String m_directoryId;
358  bool m_directoryIdHasBeenSet;
359 
360  Aws::String m_userName;
361  bool m_userNameHasBeenSet;
362 
363  Aws::String m_bundleId;
364  bool m_bundleIdHasBeenSet;
365 
366  int m_limit;
367  bool m_limitHasBeenSet;
368 
369  Aws::String m_nextToken;
370  bool m_nextTokenHasBeenSet;
371  };
372 
373 } // namespace Model
374 } // namespace WorkSpaces
375 } // namespace Aws
WorkSpaces_EXPORTS.h
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::AddWorkspaceIds
DescribeWorkspacesRequest & AddWorkspaceIds(const char *value)
Definition: DescribeWorkspacesRequest.h:117
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetUserName
const Aws::String & GetUserName() const
Definition: DescribeWorkspacesRequest.h:181
Aws::WorkSpaces::WorkSpacesRequest
Definition: WorkSpacesRequest.h:17
AWS_WORKSPACES_API
#define AWS_WORKSPACES_API
Definition: WorkSpaces_EXPORTS.h:28
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
WorkSpacesRequest.h
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithWorkspaceIds
DescribeWorkspacesRequest & WithWorkspaceIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeWorkspacesRequest.h:81
Aws::WorkSpaces::Model::DescribeWorkspacesRequest
Definition: DescribeWorkspacesRequest.h:23
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithWorkspaceIds
DescribeWorkspacesRequest & WithWorkspaceIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeWorkspacesRequest.h:90
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithNextToken
DescribeWorkspacesRequest & WithNextToken(const Aws::String &value)
Definition: DescribeWorkspacesRequest.h:338
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: DescribeWorkspacesRequest.h:31
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetUserName
void SetUserName(const Aws::String &value)
Definition: DescribeWorkspacesRequest.h:193
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::DescribeWorkspacesRequest
DescribeWorkspacesRequest()
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithUserName
DescribeWorkspacesRequest & WithUserName(const Aws::String &value)
Definition: DescribeWorkspacesRequest.h:211
AWSVector.h
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithDirectoryId
DescribeWorkspacesRequest & WithDirectoryId(const char *value)
Definition: DescribeWorkspacesRequest.h:174
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::UserNameHasBeenSet
bool UserNameHasBeenSet() const
Definition: DescribeWorkspacesRequest.h:187
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetBundleId
void SetBundleId(const char *value)
Definition: DescribeWorkspacesRequest.h:259
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithBundleId
DescribeWorkspacesRequest & WithBundleId(Aws::String &&value)
Definition: DescribeWorkspacesRequest.h:273
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::AddWorkspaceIds
DescribeWorkspacesRequest & AddWorkspaceIds(Aws::String &&value)
Definition: DescribeWorkspacesRequest.h:108
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithBundleId
DescribeWorkspacesRequest & WithBundleId(const Aws::String &value)
Definition: DescribeWorkspacesRequest.h:266
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetUserName
void SetUserName(Aws::String &&value)
Definition: DescribeWorkspacesRequest.h:199
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithDirectoryId
DescribeWorkspacesRequest & WithDirectoryId(const Aws::String &value)
Definition: DescribeWorkspacesRequest.h:160
AWSString.h
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetDirectoryId
const Aws::String & GetDirectoryId() const
Definition: DescribeWorkspacesRequest.h:125
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetUserName
void SetUserName(const char *value)
Definition: DescribeWorkspacesRequest.h:205
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithDirectoryId
DescribeWorkspacesRequest & WithDirectoryId(Aws::String &&value)
Definition: DescribeWorkspacesRequest.h:167
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetLimit
void SetLimit(int value)
Definition: DescribeWorkspacesRequest.h:296
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithLimit
DescribeWorkspacesRequest & WithLimit(int value)
Definition: DescribeWorkspacesRequest.h:301
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetDirectoryId
void SetDirectoryId(const Aws::String &value)
Definition: DescribeWorkspacesRequest.h:139
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetWorkspaceIds
void SetWorkspaceIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeWorkspacesRequest.h:72
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetNextToken
void SetNextToken(const Aws::String &value)
Definition: DescribeWorkspacesRequest.h:320
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetBundleId
const Aws::String & GetBundleId() const
Definition: DescribeWorkspacesRequest.h:231
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetNextToken
void SetNextToken(Aws::String &&value)
Definition: DescribeWorkspacesRequest.h:326
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetDirectoryId
void SetDirectoryId(const char *value)
Definition: DescribeWorkspacesRequest.h:153
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::NextTokenHasBeenSet
bool NextTokenHasBeenSet() const
Definition: DescribeWorkspacesRequest.h:314
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetBundleId
void SetBundleId(const Aws::String &value)
Definition: DescribeWorkspacesRequest.h:245
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::LimitHasBeenSet
bool LimitHasBeenSet() const
Definition: DescribeWorkspacesRequest.h:291
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithNextToken
DescribeWorkspacesRequest & WithNextToken(const char *value)
Definition: DescribeWorkspacesRequest.h:350
Aws
Definition: AccessManagementClient.h:15
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::DirectoryIdHasBeenSet
bool DirectoryIdHasBeenSet() const
Definition: DescribeWorkspacesRequest.h:132
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::AddWorkspaceIds
DescribeWorkspacesRequest & AddWorkspaceIds(const Aws::String &value)
Definition: DescribeWorkspacesRequest.h:99
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetWorkspaceIds
void SetWorkspaceIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeWorkspacesRequest.h:63
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WorkspaceIdsHasBeenSet
bool WorkspaceIdsHasBeenSet() const
Definition: DescribeWorkspacesRequest.h:54
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetDirectoryId
void SetDirectoryId(Aws::String &&value)
Definition: DescribeWorkspacesRequest.h:146
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetBundleId
void SetBundleId(Aws::String &&value)
Definition: DescribeWorkspacesRequest.h:252
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::BundleIdHasBeenSet
bool BundleIdHasBeenSet() const
Definition: DescribeWorkspacesRequest.h:238
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithUserName
DescribeWorkspacesRequest & WithUserName(const char *value)
Definition: DescribeWorkspacesRequest.h:223
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetLimit
int GetLimit() const
Definition: DescribeWorkspacesRequest.h:286
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithUserName
DescribeWorkspacesRequest & WithUserName(Aws::String &&value)
Definition: DescribeWorkspacesRequest.h:217
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithNextToken
DescribeWorkspacesRequest & WithNextToken(Aws::String &&value)
Definition: DescribeWorkspacesRequest.h:344
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::WithBundleId
DescribeWorkspacesRequest & WithBundleId(const char *value)
Definition: DescribeWorkspacesRequest.h:280
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::SetNextToken
void SetNextToken(const char *value)
Definition: DescribeWorkspacesRequest.h:332
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetNextToken
const Aws::String & GetNextToken() const
Definition: DescribeWorkspacesRequest.h:308
Aws::WorkSpaces::Model::DescribeWorkspacesRequest::GetWorkspaceIds
const Aws::Vector< Aws::String > & GetWorkspaceIds() const
Definition: DescribeWorkspacesRequest.h:45