AWS SDK for C++  1.9.107
AWS SDK for C++
ListJobsRequest.h
Go to the documentation of this file.
1 
6 #pragma once
7 #include <aws/iot/IoT_EXPORTS.h>
8 #include <aws/iot/IoTRequest.h>
12 #include <utility>
13 
14 namespace Aws
15 {
16 namespace Http
17 {
18  class URI;
19 } //namespace Http
20 namespace IoT
21 {
22 namespace Model
23 {
24 
28  {
29  public:
31 
32  // Service request name is the Operation name which will send this request out,
33  // each operation should has unique request name, so that we can get operation's name from this request.
34  // Note: this is not true for response, multiple operations may have the same response name,
35  // so we can not get operation's name from response.
36  inline virtual const char* GetServiceRequestName() const override { return "ListJobs"; }
37 
38  Aws::String SerializePayload() const override;
39 
40  void AddQueryStringParameters(Aws::Http::URI& uri) const override;
41 
42 
47  inline const JobStatus& GetStatus() const{ return m_status; }
48 
53  inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
54 
59  inline void SetStatus(const JobStatus& value) { m_statusHasBeenSet = true; m_status = value; }
60 
65  inline void SetStatus(JobStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); }
66 
71  inline ListJobsRequest& WithStatus(const JobStatus& value) { SetStatus(value); return *this;}
72 
77  inline ListJobsRequest& WithStatus(JobStatus&& value) { SetStatus(std::move(value)); return *this;}
78 
79 
88  inline const TargetSelection& GetTargetSelection() const{ return m_targetSelection; }
89 
98  inline bool TargetSelectionHasBeenSet() const { return m_targetSelectionHasBeenSet; }
99 
108  inline void SetTargetSelection(const TargetSelection& value) { m_targetSelectionHasBeenSet = true; m_targetSelection = value; }
109 
118  inline void SetTargetSelection(TargetSelection&& value) { m_targetSelectionHasBeenSet = true; m_targetSelection = std::move(value); }
119 
128  inline ListJobsRequest& WithTargetSelection(const TargetSelection& value) { SetTargetSelection(value); return *this;}
129 
138  inline ListJobsRequest& WithTargetSelection(TargetSelection&& value) { SetTargetSelection(std::move(value)); return *this;}
139 
140 
144  inline int GetMaxResults() const{ return m_maxResults; }
145 
149  inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
150 
154  inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
155 
159  inline ListJobsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
160 
161 
165  inline const Aws::String& GetNextToken() const{ return m_nextToken; }
166 
170  inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
171 
175  inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
176 
180  inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
181 
185  inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
186 
190  inline ListJobsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
191 
195  inline ListJobsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
196 
200  inline ListJobsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
201 
202 
206  inline const Aws::String& GetThingGroupName() const{ return m_thingGroupName; }
207 
211  inline bool ThingGroupNameHasBeenSet() const { return m_thingGroupNameHasBeenSet; }
212 
216  inline void SetThingGroupName(const Aws::String& value) { m_thingGroupNameHasBeenSet = true; m_thingGroupName = value; }
217 
221  inline void SetThingGroupName(Aws::String&& value) { m_thingGroupNameHasBeenSet = true; m_thingGroupName = std::move(value); }
222 
226  inline void SetThingGroupName(const char* value) { m_thingGroupNameHasBeenSet = true; m_thingGroupName.assign(value); }
227 
231  inline ListJobsRequest& WithThingGroupName(const Aws::String& value) { SetThingGroupName(value); return *this;}
232 
236  inline ListJobsRequest& WithThingGroupName(Aws::String&& value) { SetThingGroupName(std::move(value)); return *this;}
237 
241  inline ListJobsRequest& WithThingGroupName(const char* value) { SetThingGroupName(value); return *this;}
242 
243 
247  inline const Aws::String& GetThingGroupId() const{ return m_thingGroupId; }
248 
252  inline bool ThingGroupIdHasBeenSet() const { return m_thingGroupIdHasBeenSet; }
253 
257  inline void SetThingGroupId(const Aws::String& value) { m_thingGroupIdHasBeenSet = true; m_thingGroupId = value; }
258 
262  inline void SetThingGroupId(Aws::String&& value) { m_thingGroupIdHasBeenSet = true; m_thingGroupId = std::move(value); }
263 
267  inline void SetThingGroupId(const char* value) { m_thingGroupIdHasBeenSet = true; m_thingGroupId.assign(value); }
268 
272  inline ListJobsRequest& WithThingGroupId(const Aws::String& value) { SetThingGroupId(value); return *this;}
273 
277  inline ListJobsRequest& WithThingGroupId(Aws::String&& value) { SetThingGroupId(std::move(value)); return *this;}
278 
282  inline ListJobsRequest& WithThingGroupId(const char* value) { SetThingGroupId(value); return *this;}
283 
284 
294  inline const Aws::String& GetNamespaceId() const{ return m_namespaceId; }
295 
305  inline bool NamespaceIdHasBeenSet() const { return m_namespaceIdHasBeenSet; }
306 
316  inline void SetNamespaceId(const Aws::String& value) { m_namespaceIdHasBeenSet = true; m_namespaceId = value; }
317 
327  inline void SetNamespaceId(Aws::String&& value) { m_namespaceIdHasBeenSet = true; m_namespaceId = std::move(value); }
328 
338  inline void SetNamespaceId(const char* value) { m_namespaceIdHasBeenSet = true; m_namespaceId.assign(value); }
339 
349  inline ListJobsRequest& WithNamespaceId(const Aws::String& value) { SetNamespaceId(value); return *this;}
350 
360  inline ListJobsRequest& WithNamespaceId(Aws::String&& value) { SetNamespaceId(std::move(value)); return *this;}
361 
371  inline ListJobsRequest& WithNamespaceId(const char* value) { SetNamespaceId(value); return *this;}
372 
373  private:
374 
375  JobStatus m_status;
376  bool m_statusHasBeenSet;
377 
378  TargetSelection m_targetSelection;
379  bool m_targetSelectionHasBeenSet;
380 
381  int m_maxResults;
382  bool m_maxResultsHasBeenSet;
383 
384  Aws::String m_nextToken;
385  bool m_nextTokenHasBeenSet;
386 
387  Aws::String m_thingGroupName;
388  bool m_thingGroupNameHasBeenSet;
389 
390  Aws::String m_thingGroupId;
391  bool m_thingGroupIdHasBeenSet;
392 
393  Aws::String m_namespaceId;
394  bool m_namespaceIdHasBeenSet;
395  };
396 
397 } // namespace Model
398 } // namespace IoT
399 } // namespace Aws
Aws::IoT::Model::ListJobsRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::IoT::Model::ListJobsRequest::SetThingGroupId
void SetThingGroupId(const char *value)
Definition: ListJobsRequest.h:267
Aws::IoT::Model::ListJobsRequest::ListJobsRequest
ListJobsRequest()
Aws::IoT::Model::ListJobsRequest::WithThingGroupId
ListJobsRequest & WithThingGroupId(const char *value)
Definition: ListJobsRequest.h:282
Aws::Http::URI
Definition: URI.h:32
Aws::IoT::Model::ListJobsRequest::SetTargetSelection
void SetTargetSelection(TargetSelection &&value)
Definition: ListJobsRequest.h:118
Aws::IoT::Model::ListJobsRequest::SetMaxResults
void SetMaxResults(int value)
Definition: ListJobsRequest.h:154
Aws::IoT::Model::ListJobsRequest::SetNamespaceId
void SetNamespaceId(Aws::String &&value)
Definition: ListJobsRequest.h:327
Aws::IoT::Model::ListJobsRequest::WithThingGroupName
ListJobsRequest & WithThingGroupName(Aws::String &&value)
Definition: ListJobsRequest.h:236
Aws::IoT::Model::ListJobsRequest::WithMaxResults
ListJobsRequest & WithMaxResults(int value)
Definition: ListJobsRequest.h:159
Aws::IoT::Model::ListJobsRequest::WithNamespaceId
ListJobsRequest & WithNamespaceId(const Aws::String &value)
Definition: ListJobsRequest.h:349
Aws::IoT::Model::ListJobsRequest::SetNextToken
void SetNextToken(const Aws::String &value)
Definition: ListJobsRequest.h:175
Aws::IoT::Model::ListJobsRequest::GetThingGroupName
const Aws::String & GetThingGroupName() const
Definition: ListJobsRequest.h:206
Aws::IoT::Model::ListJobsRequest::SetNamespaceId
void SetNamespaceId(const Aws::String &value)
Definition: ListJobsRequest.h:316
Aws::IoT::Model::ListJobsRequest::SetTargetSelection
void SetTargetSelection(const TargetSelection &value)
Definition: ListJobsRequest.h:108
Aws::IoT::Model::ListJobsRequest::StatusHasBeenSet
bool StatusHasBeenSet() const
Definition: ListJobsRequest.h:53
Aws::IoT::Model::ListJobsRequest::SetStatus
void SetStatus(JobStatus &&value)
Definition: ListJobsRequest.h:65
Aws::IoT::Model::ListJobsRequest::GetNamespaceId
const Aws::String & GetNamespaceId() const
Definition: ListJobsRequest.h:294
Aws::IoT::Model::ListJobsRequest::WithNextToken
ListJobsRequest & WithNextToken(Aws::String &&value)
Definition: ListJobsRequest.h:195
Aws::IoT::Model::ListJobsRequest::GetStatus
const JobStatus & GetStatus() const
Definition: ListJobsRequest.h:47
Aws::IoT::Model::ListJobsRequest::WithThingGroupName
ListJobsRequest & WithThingGroupName(const char *value)
Definition: ListJobsRequest.h:241
Aws::IoT::Model::ListJobsRequest::SetNextToken
void SetNextToken(Aws::String &&value)
Definition: ListJobsRequest.h:180
Aws::IoT::Model::ListJobsRequest::SetThingGroupName
void SetThingGroupName(Aws::String &&value)
Definition: ListJobsRequest.h:221
Aws::IoT::Model::ListJobsRequest::WithNamespaceId
ListJobsRequest & WithNamespaceId(const char *value)
Definition: ListJobsRequest.h:371
Aws::IoT::Model::ListJobsRequest::NextTokenHasBeenSet
bool NextTokenHasBeenSet() const
Definition: ListJobsRequest.h:170
Aws::IoT::Model::ListJobsRequest::MaxResultsHasBeenSet
bool MaxResultsHasBeenSet() const
Definition: ListJobsRequest.h:149
Aws::IoT::Model::ListJobsRequest::WithThingGroupId
ListJobsRequest & WithThingGroupId(const Aws::String &value)
Definition: ListJobsRequest.h:272
Aws::IoT::Model::ListJobsRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: ListJobsRequest.h:36
Aws::IoT::Model::ListJobsRequest::GetTargetSelection
const TargetSelection & GetTargetSelection() const
Definition: ListJobsRequest.h:88
Aws::IoT::Model::ListJobsRequest::ThingGroupIdHasBeenSet
bool ThingGroupIdHasBeenSet() const
Definition: ListJobsRequest.h:252
Aws::IoT::Model::JobStatus
JobStatus
Definition: JobStatus.h:17
Aws::IoT::Model::ListJobsRequest::SetNextToken
void SetNextToken(const char *value)
Definition: ListJobsRequest.h:185
Aws::IoT::Model::ListJobsRequest::WithNextToken
ListJobsRequest & WithNextToken(const Aws::String &value)
Definition: ListJobsRequest.h:190
Aws::IoT::Model::ListJobsRequest::WithTargetSelection
ListJobsRequest & WithTargetSelection(const TargetSelection &value)
Definition: ListJobsRequest.h:128
Aws::IoT::Model::ListJobsRequest::SetThingGroupName
void SetThingGroupName(const Aws::String &value)
Definition: ListJobsRequest.h:216
Aws::IoT::Model::ListJobsRequest::WithTargetSelection
ListJobsRequest & WithTargetSelection(TargetSelection &&value)
Definition: ListJobsRequest.h:138
TargetSelection.h
Aws::IoT::Model::ListJobsRequest
Definition: ListJobsRequest.h:28
Aws::IoT::Model::ListJobsRequest::WithNextToken
ListJobsRequest & WithNextToken(const char *value)
Definition: ListJobsRequest.h:200
Aws::IoT::Model::ListJobsRequest::ThingGroupNameHasBeenSet
bool ThingGroupNameHasBeenSet() const
Definition: ListJobsRequest.h:211
Aws::IoT::Model::ListJobsRequest::TargetSelectionHasBeenSet
bool TargetSelectionHasBeenSet() const
Definition: ListJobsRequest.h:98
AWSString.h
JobStatus.h
Aws::IoT::IoTRequest
Definition: IoTRequest.h:17
Aws::IoT::Model::ListJobsRequest::SetNamespaceId
void SetNamespaceId(const char *value)
Definition: ListJobsRequest.h:338
Aws::IoT::Model::ListJobsRequest::WithThingGroupId
ListJobsRequest & WithThingGroupId(Aws::String &&value)
Definition: ListJobsRequest.h:277
Aws::IoT::Model::ListJobsRequest::WithStatus
ListJobsRequest & WithStatus(const JobStatus &value)
Definition: ListJobsRequest.h:71
Aws::IoT::Model::ListJobsRequest::AddQueryStringParameters
void AddQueryStringParameters(Aws::Http::URI &uri) const override
Aws::IoT::Model::ListJobsRequest::SetThingGroupId
void SetThingGroupId(const Aws::String &value)
Definition: ListJobsRequest.h:257
Aws::IoT::Model::ListJobsRequest::WithNamespaceId
ListJobsRequest & WithNamespaceId(Aws::String &&value)
Definition: ListJobsRequest.h:360
Aws::IoT::Model::ListJobsRequest::GetNextToken
const Aws::String & GetNextToken() const
Definition: ListJobsRequest.h:165
Aws::IoT::Model::ListJobsRequest::WithThingGroupName
ListJobsRequest & WithThingGroupName(const Aws::String &value)
Definition: ListJobsRequest.h:231
Aws
Definition: AccessManagementClient.h:15
Aws::IoT::Model::ListJobsRequest::NamespaceIdHasBeenSet
bool NamespaceIdHasBeenSet() const
Definition: ListJobsRequest.h:305
AWS_IOT_API
#define AWS_IOT_API
Definition: IoT_EXPORTS.h:28
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::IoT::Model::ListJobsRequest::SetThingGroupId
void SetThingGroupId(Aws::String &&value)
Definition: ListJobsRequest.h:262
Aws::IoT::Model::ListJobsRequest::GetThingGroupId
const Aws::String & GetThingGroupId() const
Definition: ListJobsRequest.h:247
Aws::IoT::Model::ListJobsRequest::SetStatus
void SetStatus(const JobStatus &value)
Definition: ListJobsRequest.h:59
IoTRequest.h
Aws::IoT::Model::ListJobsRequest::GetMaxResults
int GetMaxResults() const
Definition: ListJobsRequest.h:144
Aws::IoT::Model::TargetSelection
TargetSelection
Definition: TargetSelection.h:17
Aws::IoT::Model::ListJobsRequest::WithStatus
ListJobsRequest & WithStatus(JobStatus &&value)
Definition: ListJobsRequest.h:77
IoT_EXPORTS.h
Aws::IoT::Model::ListJobsRequest::SetThingGroupName
void SetThingGroupName(const char *value)
Definition: ListJobsRequest.h:226