251 lines
12 KiB
C++
251 lines
12 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/batch/Batch_EXPORTS.h>
|
|
#include <aws/batch/BatchRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Batch
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_BATCH_API DescribeJobQueuesRequest : public BatchRequest
|
|
{
|
|
public:
|
|
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::String SerializePayload() const override;
|
|
|
|
|
|
/**
|
|
* <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN)
|
|
* entries.</p>
|
|
*/
|
|
inline const Aws::Vector<Aws::String>& GetJobQueues() const{ return m_jobQueues; }
|
|
|
|
/**
|
|
* <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN)
|
|
* entries.</p>
|
|
*/
|
|
inline bool JobQueuesHasBeenSet() const { return m_jobQueuesHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN)
|
|
* entries.</p>
|
|
*/
|
|
inline void SetJobQueues(const Aws::Vector<Aws::String>& value) { m_jobQueuesHasBeenSet = true; m_jobQueues = value; }
|
|
|
|
/**
|
|
* <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN)
|
|
* entries.</p>
|
|
*/
|
|
inline void SetJobQueues(Aws::Vector<Aws::String>&& value) { m_jobQueuesHasBeenSet = true; m_jobQueues = std::move(value); }
|
|
|
|
/**
|
|
* <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN)
|
|
* entries.</p>
|
|
*/
|
|
inline DescribeJobQueuesRequest& WithJobQueues(const Aws::Vector<Aws::String>& value) { SetJobQueues(value); return *this;}
|
|
|
|
/**
|
|
* <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN)
|
|
* entries.</p>
|
|
*/
|
|
inline DescribeJobQueuesRequest& WithJobQueues(Aws::Vector<Aws::String>&& value) { SetJobQueues(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN)
|
|
* entries.</p>
|
|
*/
|
|
inline DescribeJobQueuesRequest& AddJobQueues(const Aws::String& value) { m_jobQueuesHasBeenSet = true; m_jobQueues.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN)
|
|
* entries.</p>
|
|
*/
|
|
inline DescribeJobQueuesRequest& AddJobQueues(Aws::String&& value) { m_jobQueuesHasBeenSet = true; m_jobQueues.push_back(std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN)
|
|
* entries.</p>
|
|
*/
|
|
inline DescribeJobQueuesRequest& AddJobQueues(const char* value) { m_jobQueuesHasBeenSet = true; m_jobQueues.push_back(value); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>The maximum number of results returned by <code>DescribeJobQueues</code> in
|
|
* paginated output. When this parameter is used, <code>DescribeJobQueues</code>
|
|
* only returns <code>maxResults</code> results in a single page along with a
|
|
* <code>nextToken</code> response element. The remaining results of the initial
|
|
* request can be seen by sending another <code>DescribeJobQueues</code> request
|
|
* with the returned <code>nextToken</code> value. This value can be between 1 and
|
|
* 100. If this parameter is not used, then <code>DescribeJobQueues</code> returns
|
|
* up to 100 results and a <code>nextToken</code> value if applicable.</p>
|
|
*/
|
|
inline int GetMaxResults() const{ return m_maxResults; }
|
|
|
|
/**
|
|
* <p>The maximum number of results returned by <code>DescribeJobQueues</code> in
|
|
* paginated output. When this parameter is used, <code>DescribeJobQueues</code>
|
|
* only returns <code>maxResults</code> results in a single page along with a
|
|
* <code>nextToken</code> response element. The remaining results of the initial
|
|
* request can be seen by sending another <code>DescribeJobQueues</code> request
|
|
* with the returned <code>nextToken</code> value. This value can be between 1 and
|
|
* 100. If this parameter is not used, then <code>DescribeJobQueues</code> returns
|
|
* up to 100 results and a <code>nextToken</code> value if applicable.</p>
|
|
*/
|
|
inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The maximum number of results returned by <code>DescribeJobQueues</code> in
|
|
* paginated output. When this parameter is used, <code>DescribeJobQueues</code>
|
|
* only returns <code>maxResults</code> results in a single page along with a
|
|
* <code>nextToken</code> response element. The remaining results of the initial
|
|
* request can be seen by sending another <code>DescribeJobQueues</code> request
|
|
* with the returned <code>nextToken</code> value. This value can be between 1 and
|
|
* 100. If this parameter is not used, then <code>DescribeJobQueues</code> returns
|
|
* up to 100 results and a <code>nextToken</code> value if applicable.</p>
|
|
*/
|
|
inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
|
|
|
|
/**
|
|
* <p>The maximum number of results returned by <code>DescribeJobQueues</code> in
|
|
* paginated output. When this parameter is used, <code>DescribeJobQueues</code>
|
|
* only returns <code>maxResults</code> results in a single page along with a
|
|
* <code>nextToken</code> response element. The remaining results of the initial
|
|
* request can be seen by sending another <code>DescribeJobQueues</code> request
|
|
* with the returned <code>nextToken</code> value. This value can be between 1 and
|
|
* 100. If this parameter is not used, then <code>DescribeJobQueues</code> returns
|
|
* up to 100 results and a <code>nextToken</code> value if applicable.</p>
|
|
*/
|
|
inline DescribeJobQueuesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
* <code>DescribeJobQueues</code> request where <code>maxResults</code> was used
|
|
* and the results exceeded the value of that parameter. Pagination continues from
|
|
* the end of the previous results that returned the <code>nextToken</code> value.
|
|
* This value is <code>null</code> when there are no more results to return.</p>
|
|
* <p>This token should be treated as an opaque identifier that is only used
|
|
* to retrieve the next items in a list and not for other programmatic
|
|
* purposes.</p>
|
|
*/
|
|
inline const Aws::String& GetNextToken() const{ return m_nextToken; }
|
|
|
|
/**
|
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
* <code>DescribeJobQueues</code> request where <code>maxResults</code> was used
|
|
* and the results exceeded the value of that parameter. Pagination continues from
|
|
* the end of the previous results that returned the <code>nextToken</code> value.
|
|
* This value is <code>null</code> when there are no more results to return.</p>
|
|
* <p>This token should be treated as an opaque identifier that is only used
|
|
* to retrieve the next items in a list and not for other programmatic
|
|
* purposes.</p>
|
|
*/
|
|
inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
* <code>DescribeJobQueues</code> request where <code>maxResults</code> was used
|
|
* and the results exceeded the value of that parameter. Pagination continues from
|
|
* the end of the previous results that returned the <code>nextToken</code> value.
|
|
* This value is <code>null</code> when there are no more results to return.</p>
|
|
* <p>This token should be treated as an opaque identifier that is only used
|
|
* to retrieve the next items in a list and not for other programmatic
|
|
* purposes.</p>
|
|
*/
|
|
inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
|
|
|
|
/**
|
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
* <code>DescribeJobQueues</code> request where <code>maxResults</code> was used
|
|
* and the results exceeded the value of that parameter. Pagination continues from
|
|
* the end of the previous results that returned the <code>nextToken</code> value.
|
|
* This value is <code>null</code> when there are no more results to return.</p>
|
|
* <p>This token should be treated as an opaque identifier that is only used
|
|
* to retrieve the next items in a list and not for other programmatic
|
|
* purposes.</p>
|
|
*/
|
|
inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
|
|
|
|
/**
|
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
* <code>DescribeJobQueues</code> request where <code>maxResults</code> was used
|
|
* and the results exceeded the value of that parameter. Pagination continues from
|
|
* the end of the previous results that returned the <code>nextToken</code> value.
|
|
* This value is <code>null</code> when there are no more results to return.</p>
|
|
* <p>This token should be treated as an opaque identifier that is only used
|
|
* to retrieve the next items in a list and not for other programmatic
|
|
* purposes.</p>
|
|
*/
|
|
inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
|
|
|
|
/**
|
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
* <code>DescribeJobQueues</code> request where <code>maxResults</code> was used
|
|
* and the results exceeded the value of that parameter. Pagination continues from
|
|
* the end of the previous results that returned the <code>nextToken</code> value.
|
|
* This value is <code>null</code> when there are no more results to return.</p>
|
|
* <p>This token should be treated as an opaque identifier that is only used
|
|
* to retrieve the next items in a list and not for other programmatic
|
|
* purposes.</p>
|
|
*/
|
|
inline DescribeJobQueuesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
|
|
|
|
/**
|
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
* <code>DescribeJobQueues</code> request where <code>maxResults</code> was used
|
|
* and the results exceeded the value of that parameter. Pagination continues from
|
|
* the end of the previous results that returned the <code>nextToken</code> value.
|
|
* This value is <code>null</code> when there are no more results to return.</p>
|
|
* <p>This token should be treated as an opaque identifier that is only used
|
|
* to retrieve the next items in a list and not for other programmatic
|
|
* purposes.</p>
|
|
*/
|
|
inline DescribeJobQueuesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The <code>nextToken</code> value returned from a previous paginated
|
|
* <code>DescribeJobQueues</code> request where <code>maxResults</code> was used
|
|
* and the results exceeded the value of that parameter. Pagination continues from
|
|
* the end of the previous results that returned the <code>nextToken</code> value.
|
|
* This value is <code>null</code> when there are no more results to return.</p>
|
|
* <p>This token should be treated as an opaque identifier that is only used
|
|
* to retrieve the next items in a list and not for other programmatic
|
|
* purposes.</p>
|
|
*/
|
|
inline DescribeJobQueuesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::Vector<Aws::String> m_jobQueues;
|
|
bool m_jobQueuesHasBeenSet;
|
|
|
|
int m_maxResults;
|
|
bool m_maxResultsHasBeenSet;
|
|
|
|
Aws::String m_nextToken;
|
|
bool m_nextTokenHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace Batch
|
|
} // namespace Aws
|