1 /** 2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 * SPDX-License-Identifier: Apache-2.0. 4 */ 5 6 #pragma once 7 #include <aws/batch/Batch_EXPORTS.h> 8 #include <aws/batch/BatchRequest.h> 9 #include <aws/core/utils/memory/stl/AWSVector.h> 10 #include <aws/core/utils/memory/stl/AWSString.h> 11 #include <utility> 12 13 namespace Aws 14 { 15 namespace Batch 16 { 17 namespace Model 18 { 19 20 /** 21 * <p>Contains the parameters for <code>DescribeJobQueues</code>.</p><p><h3>See 22 * Also:</h3> <a 23 * href="http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/DescribeJobQueuesRequest">AWS 24 * API Reference</a></p> 25 */ 26 class AWS_BATCH_API DescribeJobQueuesRequest : public BatchRequest 27 { 28 public: 29 DescribeJobQueuesRequest(); 30 31 // Service request name is the Operation name which will send this request out, 32 // each operation should has unique request name, so that we can get operation's name from this request. 33 // Note: this is not true for response, multiple operations may have the same response name, 34 // so we can not get operation's name from response. GetServiceRequestName()35 inline virtual const char* GetServiceRequestName() const override { return "DescribeJobQueues"; } 36 37 Aws::String SerializePayload() const override; 38 39 40 /** 41 * <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) 42 * entries.</p> 43 */ GetJobQueues()44 inline const Aws::Vector<Aws::String>& GetJobQueues() const{ return m_jobQueues; } 45 46 /** 47 * <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) 48 * entries.</p> 49 */ JobQueuesHasBeenSet()50 inline bool JobQueuesHasBeenSet() const { return m_jobQueuesHasBeenSet; } 51 52 /** 53 * <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) 54 * entries.</p> 55 */ SetJobQueues(const Aws::Vector<Aws::String> & value)56 inline void SetJobQueues(const Aws::Vector<Aws::String>& value) { m_jobQueuesHasBeenSet = true; m_jobQueues = value; } 57 58 /** 59 * <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) 60 * entries.</p> 61 */ SetJobQueues(Aws::Vector<Aws::String> && value)62 inline void SetJobQueues(Aws::Vector<Aws::String>&& value) { m_jobQueuesHasBeenSet = true; m_jobQueues = std::move(value); } 63 64 /** 65 * <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) 66 * entries.</p> 67 */ WithJobQueues(const Aws::Vector<Aws::String> & value)68 inline DescribeJobQueuesRequest& WithJobQueues(const Aws::Vector<Aws::String>& value) { SetJobQueues(value); return *this;} 69 70 /** 71 * <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) 72 * entries.</p> 73 */ WithJobQueues(Aws::Vector<Aws::String> && value)74 inline DescribeJobQueuesRequest& WithJobQueues(Aws::Vector<Aws::String>&& value) { SetJobQueues(std::move(value)); return *this;} 75 76 /** 77 * <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) 78 * entries.</p> 79 */ AddJobQueues(const Aws::String & value)80 inline DescribeJobQueuesRequest& AddJobQueues(const Aws::String& value) { m_jobQueuesHasBeenSet = true; m_jobQueues.push_back(value); return *this; } 81 82 /** 83 * <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) 84 * entries.</p> 85 */ AddJobQueues(Aws::String && value)86 inline DescribeJobQueuesRequest& AddJobQueues(Aws::String&& value) { m_jobQueuesHasBeenSet = true; m_jobQueues.push_back(std::move(value)); return *this; } 87 88 /** 89 * <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) 90 * entries.</p> 91 */ AddJobQueues(const char * value)92 inline DescribeJobQueuesRequest& AddJobQueues(const char* value) { m_jobQueuesHasBeenSet = true; m_jobQueues.push_back(value); return *this; } 93 94 95 /** 96 * <p>The maximum number of results returned by <code>DescribeJobQueues</code> in 97 * paginated output. When this parameter is used, <code>DescribeJobQueues</code> 98 * only returns <code>maxResults</code> results in a single page and a 99 * <code>nextToken</code> response element. The remaining results of the initial 100 * request can be seen by sending another <code>DescribeJobQueues</code> request 101 * with the returned <code>nextToken</code> value. This value can be between 1 and 102 * 100. If this parameter isn't used, then <code>DescribeJobQueues</code> returns 103 * up to 100 results and a <code>nextToken</code> value if applicable.</p> 104 */ GetMaxResults()105 inline int GetMaxResults() const{ return m_maxResults; } 106 107 /** 108 * <p>The maximum number of results returned by <code>DescribeJobQueues</code> in 109 * paginated output. When this parameter is used, <code>DescribeJobQueues</code> 110 * only returns <code>maxResults</code> results in a single page and a 111 * <code>nextToken</code> response element. The remaining results of the initial 112 * request can be seen by sending another <code>DescribeJobQueues</code> request 113 * with the returned <code>nextToken</code> value. This value can be between 1 and 114 * 100. If this parameter isn't used, then <code>DescribeJobQueues</code> returns 115 * up to 100 results and a <code>nextToken</code> value if applicable.</p> 116 */ MaxResultsHasBeenSet()117 inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } 118 119 /** 120 * <p>The maximum number of results returned by <code>DescribeJobQueues</code> in 121 * paginated output. When this parameter is used, <code>DescribeJobQueues</code> 122 * only returns <code>maxResults</code> results in a single page and a 123 * <code>nextToken</code> response element. The remaining results of the initial 124 * request can be seen by sending another <code>DescribeJobQueues</code> request 125 * with the returned <code>nextToken</code> value. This value can be between 1 and 126 * 100. If this parameter isn't used, then <code>DescribeJobQueues</code> returns 127 * up to 100 results and a <code>nextToken</code> value if applicable.</p> 128 */ SetMaxResults(int value)129 inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } 130 131 /** 132 * <p>The maximum number of results returned by <code>DescribeJobQueues</code> in 133 * paginated output. When this parameter is used, <code>DescribeJobQueues</code> 134 * only returns <code>maxResults</code> results in a single page and a 135 * <code>nextToken</code> response element. The remaining results of the initial 136 * request can be seen by sending another <code>DescribeJobQueues</code> request 137 * with the returned <code>nextToken</code> value. This value can be between 1 and 138 * 100. If this parameter isn't used, then <code>DescribeJobQueues</code> returns 139 * up to 100 results and a <code>nextToken</code> value if applicable.</p> 140 */ WithMaxResults(int value)141 inline DescribeJobQueuesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} 142 143 144 /** 145 * <p>The <code>nextToken</code> value returned from a previous paginated 146 * <code>DescribeJobQueues</code> request where <code>maxResults</code> was used 147 * and the results exceeded the value of that parameter. Pagination continues from 148 * the end of the previous results that returned the <code>nextToken</code> value. 149 * This value is <code>null</code> when there are no more results to return.</p> 150 * <p>This token should be treated as an opaque identifier that's only used 151 * to retrieve the next items in a list and not for other programmatic 152 * purposes.</p> 153 */ GetNextToken()154 inline const Aws::String& GetNextToken() const{ return m_nextToken; } 155 156 /** 157 * <p>The <code>nextToken</code> value returned from a previous paginated 158 * <code>DescribeJobQueues</code> request where <code>maxResults</code> was used 159 * and the results exceeded the value of that parameter. Pagination continues from 160 * the end of the previous results that returned the <code>nextToken</code> value. 161 * This value is <code>null</code> when there are no more results to return.</p> 162 * <p>This token should be treated as an opaque identifier that's only used 163 * to retrieve the next items in a list and not for other programmatic 164 * purposes.</p> 165 */ NextTokenHasBeenSet()166 inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } 167 168 /** 169 * <p>The <code>nextToken</code> value returned from a previous paginated 170 * <code>DescribeJobQueues</code> request where <code>maxResults</code> was used 171 * and the results exceeded the value of that parameter. Pagination continues from 172 * the end of the previous results that returned the <code>nextToken</code> value. 173 * This value is <code>null</code> when there are no more results to return.</p> 174 * <p>This token should be treated as an opaque identifier that's only used 175 * to retrieve the next items in a list and not for other programmatic 176 * purposes.</p> 177 */ SetNextToken(const Aws::String & value)178 inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } 179 180 /** 181 * <p>The <code>nextToken</code> value returned from a previous paginated 182 * <code>DescribeJobQueues</code> request where <code>maxResults</code> was used 183 * and the results exceeded the value of that parameter. Pagination continues from 184 * the end of the previous results that returned the <code>nextToken</code> value. 185 * This value is <code>null</code> when there are no more results to return.</p> 186 * <p>This token should be treated as an opaque identifier that's only used 187 * to retrieve the next items in a list and not for other programmatic 188 * purposes.</p> 189 */ SetNextToken(Aws::String && value)190 inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } 191 192 /** 193 * <p>The <code>nextToken</code> value returned from a previous paginated 194 * <code>DescribeJobQueues</code> request where <code>maxResults</code> was used 195 * and the results exceeded the value of that parameter. Pagination continues from 196 * the end of the previous results that returned the <code>nextToken</code> value. 197 * This value is <code>null</code> when there are no more results to return.</p> 198 * <p>This token should be treated as an opaque identifier that's only used 199 * to retrieve the next items in a list and not for other programmatic 200 * purposes.</p> 201 */ SetNextToken(const char * value)202 inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } 203 204 /** 205 * <p>The <code>nextToken</code> value returned from a previous paginated 206 * <code>DescribeJobQueues</code> request where <code>maxResults</code> was used 207 * and the results exceeded the value of that parameter. Pagination continues from 208 * the end of the previous results that returned the <code>nextToken</code> value. 209 * This value is <code>null</code> when there are no more results to return.</p> 210 * <p>This token should be treated as an opaque identifier that's only used 211 * to retrieve the next items in a list and not for other programmatic 212 * purposes.</p> 213 */ WithNextToken(const Aws::String & value)214 inline DescribeJobQueuesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} 215 216 /** 217 * <p>The <code>nextToken</code> value returned from a previous paginated 218 * <code>DescribeJobQueues</code> request where <code>maxResults</code> was used 219 * and the results exceeded the value of that parameter. Pagination continues from 220 * the end of the previous results that returned the <code>nextToken</code> value. 221 * This value is <code>null</code> when there are no more results to return.</p> 222 * <p>This token should be treated as an opaque identifier that's only used 223 * to retrieve the next items in a list and not for other programmatic 224 * purposes.</p> 225 */ WithNextToken(Aws::String && value)226 inline DescribeJobQueuesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} 227 228 /** 229 * <p>The <code>nextToken</code> value returned from a previous paginated 230 * <code>DescribeJobQueues</code> request where <code>maxResults</code> was used 231 * and the results exceeded the value of that parameter. Pagination continues from 232 * the end of the previous results that returned the <code>nextToken</code> value. 233 * This value is <code>null</code> when there are no more results to return.</p> 234 * <p>This token should be treated as an opaque identifier that's only used 235 * to retrieve the next items in a list and not for other programmatic 236 * purposes.</p> 237 */ WithNextToken(const char * value)238 inline DescribeJobQueuesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} 239 240 private: 241 242 Aws::Vector<Aws::String> m_jobQueues; 243 bool m_jobQueuesHasBeenSet; 244 245 int m_maxResults; 246 bool m_maxResultsHasBeenSet; 247 248 Aws::String m_nextToken; 249 bool m_nextTokenHasBeenSet; 250 }; 251 252 } // namespace Model 253 } // namespace Batch 254 } // namespace Aws 255