AWS SDK for C++

AWS SDK for C++ Version 1.11.717

Loading...
Searching...
No Matches
ListJobsRequest.h
1
6#pragma once
7#include <aws/batch/BatchRequest.h>
8#include <aws/batch/Batch_EXPORTS.h>
9#include <aws/batch/model/JobStatus.h>
10#include <aws/batch/model/KeyValuesPair.h>
11#include <aws/core/utils/memory/stl/AWSString.h>
12#include <aws/core/utils/memory/stl/AWSVector.h>
13
14#include <utility>
15
16namespace Aws {
17namespace Batch {
18namespace Model {
19
27 public:
28 AWS_BATCH_API ListJobsRequest() = default;
29
30 // Service request name is the Operation name which will send this request out,
31 // each operation should has unique request name, so that we can get operation's name from this request.
32 // Note: this is not true for response, multiple operations may have the same response name,
33 // so we can not get operation's name from response.
34 inline virtual const char* GetServiceRequestName() const override { return "ListJobs"; }
35
36 AWS_BATCH_API Aws::String SerializePayload() const override;
37
39
43 inline const Aws::String& GetJobQueue() const { return m_jobQueue; }
44 inline bool JobQueueHasBeenSet() const { return m_jobQueueHasBeenSet; }
45 template <typename JobQueueT = Aws::String>
46 void SetJobQueue(JobQueueT&& value) {
47 m_jobQueueHasBeenSet = true;
48 m_jobQueue = std::forward<JobQueueT>(value);
49 }
50 template <typename JobQueueT = Aws::String>
51 ListJobsRequest& WithJobQueue(JobQueueT&& value) {
52 SetJobQueue(std::forward<JobQueueT>(value));
53 return *this;
54 }
56
58
62 inline const Aws::String& GetArrayJobId() const { return m_arrayJobId; }
63 inline bool ArrayJobIdHasBeenSet() const { return m_arrayJobIdHasBeenSet; }
64 template <typename ArrayJobIdT = Aws::String>
65 void SetArrayJobId(ArrayJobIdT&& value) {
66 m_arrayJobIdHasBeenSet = true;
67 m_arrayJobId = std::forward<ArrayJobIdT>(value);
68 }
69 template <typename ArrayJobIdT = Aws::String>
70 ListJobsRequest& WithArrayJobId(ArrayJobIdT&& value) {
71 SetArrayJobId(std::forward<ArrayJobIdT>(value));
72 return *this;
73 }
75
77
82 inline const Aws::String& GetMultiNodeJobId() const { return m_multiNodeJobId; }
83 inline bool MultiNodeJobIdHasBeenSet() const { return m_multiNodeJobIdHasBeenSet; }
84 template <typename MultiNodeJobIdT = Aws::String>
85 void SetMultiNodeJobId(MultiNodeJobIdT&& value) {
86 m_multiNodeJobIdHasBeenSet = true;
87 m_multiNodeJobId = std::forward<MultiNodeJobIdT>(value);
88 }
89 template <typename MultiNodeJobIdT = Aws::String>
90 ListJobsRequest& WithMultiNodeJobId(MultiNodeJobIdT&& value) {
91 SetMultiNodeJobId(std::forward<MultiNodeJobIdT>(value));
92 return *this;
93 }
95
97
103 inline JobStatus GetJobStatus() const { return m_jobStatus; }
104 inline bool JobStatusHasBeenSet() const { return m_jobStatusHasBeenSet; }
105 inline void SetJobStatus(JobStatus value) {
106 m_jobStatusHasBeenSet = true;
107 m_jobStatus = value;
108 }
110 SetJobStatus(value);
111 return *this;
112 }
114
116
130 inline int GetMaxResults() const { return m_maxResults; }
131 inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
132 inline void SetMaxResults(int value) {
133 m_maxResultsHasBeenSet = true;
134 m_maxResults = value;
135 }
136 inline ListJobsRequest& WithMaxResults(int value) {
137 SetMaxResults(value);
138 return *this;
139 }
141
143
152 inline const Aws::String& GetNextToken() const { return m_nextToken; }
153 inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
154 template <typename NextTokenT = Aws::String>
155 void SetNextToken(NextTokenT&& value) {
156 m_nextTokenHasBeenSet = true;
157 m_nextToken = std::forward<NextTokenT>(value);
158 }
159 template <typename NextTokenT = Aws::String>
160 ListJobsRequest& WithNextToken(NextTokenT&& value) {
161 SetNextToken(std::forward<NextTokenT>(value));
162 return *this;
163 }
165
167
202 inline const Aws::Vector<KeyValuesPair>& GetFilters() const { return m_filters; }
203 inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
204 template <typename FiltersT = Aws::Vector<KeyValuesPair>>
205 void SetFilters(FiltersT&& value) {
206 m_filtersHasBeenSet = true;
207 m_filters = std::forward<FiltersT>(value);
208 }
209 template <typename FiltersT = Aws::Vector<KeyValuesPair>>
210 ListJobsRequest& WithFilters(FiltersT&& value) {
211 SetFilters(std::forward<FiltersT>(value));
212 return *this;
213 }
214 template <typename FiltersT = KeyValuesPair>
215 ListJobsRequest& AddFilters(FiltersT&& value) {
216 m_filtersHasBeenSet = true;
217 m_filters.emplace_back(std::forward<FiltersT>(value));
218 return *this;
219 }
221 private:
222 Aws::String m_jobQueue;
223
224 Aws::String m_arrayJobId;
225
226 Aws::String m_multiNodeJobId;
227
228 JobStatus m_jobStatus{JobStatus::NOT_SET};
229
230 int m_maxResults{0};
231
232 Aws::String m_nextToken;
233
235 bool m_jobQueueHasBeenSet = false;
236 bool m_arrayJobIdHasBeenSet = false;
237 bool m_multiNodeJobIdHasBeenSet = false;
238 bool m_jobStatusHasBeenSet = false;
239 bool m_maxResultsHasBeenSet = false;
240 bool m_nextTokenHasBeenSet = false;
241 bool m_filtersHasBeenSet = false;
242};
243
244} // namespace Model
245} // namespace Batch
246} // namespace Aws
ListJobsRequest & WithMaxResults(int value)
ListJobsRequest & WithArrayJobId(ArrayJobIdT &&value)
ListJobsRequest & AddFilters(FiltersT &&value)
const Aws::String & GetJobQueue() const
ListJobsRequest & WithNextToken(NextTokenT &&value)
const Aws::String & GetArrayJobId() const
AWS_BATCH_API Aws::String SerializePayload() const override
const Aws::String & GetNextToken() const
const Aws::Vector< KeyValuesPair > & GetFilters() const
void SetJobQueue(JobQueueT &&value)
ListJobsRequest & WithJobStatus(JobStatus value)
void SetNextToken(NextTokenT &&value)
void SetArrayJobId(ArrayJobIdT &&value)
ListJobsRequest & WithJobQueue(JobQueueT &&value)
void SetMultiNodeJobId(MultiNodeJobIdT &&value)
const Aws::String & GetMultiNodeJobId() const
AWS_BATCH_API ListJobsRequest()=default
ListJobsRequest & WithFilters(FiltersT &&value)
ListJobsRequest & WithMultiNodeJobId(MultiNodeJobIdT &&value)
virtual const char * GetServiceRequestName() const override
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector