/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Batch { namespace Model { /** *

Contains the parameters for DescribeJobQueues.

See * Also:

AWS * API Reference

*/ class DescribeJobQueuesRequest : public BatchRequest { public: AWS_BATCH_API DescribeJobQueuesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribeJobQueues"; } AWS_BATCH_API Aws::String SerializePayload() const override; /** *

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) * entries.

*/ inline const Aws::Vector& GetJobQueues() const{ return m_jobQueues; } /** *

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) * entries.

*/ inline bool JobQueuesHasBeenSet() const { return m_jobQueuesHasBeenSet; } /** *

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) * entries.

*/ inline void SetJobQueues(const Aws::Vector& value) { m_jobQueuesHasBeenSet = true; m_jobQueues = value; } /** *

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) * entries.

*/ inline void SetJobQueues(Aws::Vector&& value) { m_jobQueuesHasBeenSet = true; m_jobQueues = std::move(value); } /** *

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) * entries.

*/ inline DescribeJobQueuesRequest& WithJobQueues(const Aws::Vector& value) { SetJobQueues(value); return *this;} /** *

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) * entries.

*/ inline DescribeJobQueuesRequest& WithJobQueues(Aws::Vector&& value) { SetJobQueues(std::move(value)); return *this;} /** *

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) * entries.

*/ inline DescribeJobQueuesRequest& AddJobQueues(const Aws::String& value) { m_jobQueuesHasBeenSet = true; m_jobQueues.push_back(value); return *this; } /** *

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) * entries.

*/ inline DescribeJobQueuesRequest& AddJobQueues(Aws::String&& value) { m_jobQueuesHasBeenSet = true; m_jobQueues.push_back(std::move(value)); return *this; } /** *

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) * entries.

*/ inline DescribeJobQueuesRequest& AddJobQueues(const char* value) { m_jobQueuesHasBeenSet = true; m_jobQueues.push_back(value); return *this; } /** *

The maximum number of results returned by DescribeJobQueues in * paginated output. When this parameter is used, DescribeJobQueues * only returns maxResults results in a single page and a * nextToken response element. The remaining results of the initial * request can be seen by sending another DescribeJobQueues request * with the returned nextToken value. This value can be between 1 and * 100. If this parameter isn't used, then DescribeJobQueues returns * up to 100 results and a nextToken value if applicable.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The maximum number of results returned by DescribeJobQueues in * paginated output. When this parameter is used, DescribeJobQueues * only returns maxResults results in a single page and a * nextToken response element. The remaining results of the initial * request can be seen by sending another DescribeJobQueues request * with the returned nextToken value. This value can be between 1 and * 100. If this parameter isn't used, then DescribeJobQueues returns * up to 100 results and a nextToken value if applicable.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The maximum number of results returned by DescribeJobQueues in * paginated output. When this parameter is used, DescribeJobQueues * only returns maxResults results in a single page and a * nextToken response element. The remaining results of the initial * request can be seen by sending another DescribeJobQueues request * with the returned nextToken value. This value can be between 1 and * 100. If this parameter isn't used, then DescribeJobQueues returns * up to 100 results and a nextToken value if applicable.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The maximum number of results returned by DescribeJobQueues in * paginated output. When this parameter is used, DescribeJobQueues * only returns maxResults results in a single page and a * nextToken response element. The remaining results of the initial * request can be seen by sending another DescribeJobQueues request * with the returned nextToken value. This value can be between 1 and * 100. If this parameter isn't used, then DescribeJobQueues returns * up to 100 results and a nextToken value if applicable.

*/ inline DescribeJobQueuesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

The nextToken value returned from a previous paginated * DescribeJobQueues request where maxResults was used * and the results exceeded the value of that parameter. Pagination continues from * the end of the previous results that returned the nextToken value. * This value is null when there are no more results to return.

*

Treat this token as an opaque identifier that's only used to retrieve * the next items in a list and not for other programmatic purposes.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

The nextToken value returned from a previous paginated * DescribeJobQueues request where maxResults was used * and the results exceeded the value of that parameter. Pagination continues from * the end of the previous results that returned the nextToken value. * This value is null when there are no more results to return.

*

Treat this token as an opaque identifier that's only used to retrieve * the next items in a list and not for other programmatic purposes.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

The nextToken value returned from a previous paginated * DescribeJobQueues request where maxResults was used * and the results exceeded the value of that parameter. Pagination continues from * the end of the previous results that returned the nextToken value. * This value is null when there are no more results to return.

*

Treat this token as an opaque identifier that's only used to retrieve * the next items in a list and not for other programmatic purposes.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

The nextToken value returned from a previous paginated * DescribeJobQueues request where maxResults was used * and the results exceeded the value of that parameter. Pagination continues from * the end of the previous results that returned the nextToken value. * This value is null when there are no more results to return.

*

Treat this token as an opaque identifier that's only used to retrieve * the next items in a list and not for other programmatic purposes.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

The nextToken value returned from a previous paginated * DescribeJobQueues request where maxResults was used * and the results exceeded the value of that parameter. Pagination continues from * the end of the previous results that returned the nextToken value. * This value is null when there are no more results to return.

*

Treat this token as an opaque identifier that's only used to retrieve * the next items in a list and not for other programmatic purposes.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

The nextToken value returned from a previous paginated * DescribeJobQueues request where maxResults was used * and the results exceeded the value of that parameter. Pagination continues from * the end of the previous results that returned the nextToken value. * This value is null when there are no more results to return.

*

Treat this token as an opaque identifier that's only used to retrieve * the next items in a list and not for other programmatic purposes.

*/ inline DescribeJobQueuesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

The nextToken value returned from a previous paginated * DescribeJobQueues request where maxResults was used * and the results exceeded the value of that parameter. Pagination continues from * the end of the previous results that returned the nextToken value. * This value is null when there are no more results to return.

*

Treat this token as an opaque identifier that's only used to retrieve * the next items in a list and not for other programmatic purposes.

*/ inline DescribeJobQueuesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

The nextToken value returned from a previous paginated * DescribeJobQueues request where maxResults was used * and the results exceeded the value of that parameter. Pagination continues from * the end of the previous results that returned the nextToken value. * This value is null when there are no more results to return.

*

Treat this token as an opaque identifier that's only used to retrieve * the next items in a list and not for other programmatic purposes.

*/ inline DescribeJobQueuesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::Vector m_jobQueues; bool m_jobQueuesHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace Batch } // namespace Aws