/** * 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 * DescribeComputeEnvironments.

See Also:

AWS * API Reference

*/ class DescribeComputeEnvironmentsRequest : public BatchRequest { public: AWS_BATCH_API DescribeComputeEnvironmentsRequest(); // 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 "DescribeComputeEnvironments"; } AWS_BATCH_API Aws::String SerializePayload() const override; /** *

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

*/ inline const Aws::Vector& GetComputeEnvironments() const{ return m_computeEnvironments; } /** *

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

*/ inline bool ComputeEnvironmentsHasBeenSet() const { return m_computeEnvironmentsHasBeenSet; } /** *

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

*/ inline void SetComputeEnvironments(const Aws::Vector& value) { m_computeEnvironmentsHasBeenSet = true; m_computeEnvironments = value; } /** *

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

*/ inline void SetComputeEnvironments(Aws::Vector&& value) { m_computeEnvironmentsHasBeenSet = true; m_computeEnvironments = std::move(value); } /** *

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

*/ inline DescribeComputeEnvironmentsRequest& WithComputeEnvironments(const Aws::Vector& value) { SetComputeEnvironments(value); return *this;} /** *

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

*/ inline DescribeComputeEnvironmentsRequest& WithComputeEnvironments(Aws::Vector&& value) { SetComputeEnvironments(std::move(value)); return *this;} /** *

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

*/ inline DescribeComputeEnvironmentsRequest& AddComputeEnvironments(const Aws::String& value) { m_computeEnvironmentsHasBeenSet = true; m_computeEnvironments.push_back(value); return *this; } /** *

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

*/ inline DescribeComputeEnvironmentsRequest& AddComputeEnvironments(Aws::String&& value) { m_computeEnvironmentsHasBeenSet = true; m_computeEnvironments.push_back(std::move(value)); return *this; } /** *

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

*/ inline DescribeComputeEnvironmentsRequest& AddComputeEnvironments(const char* value) { m_computeEnvironmentsHasBeenSet = true; m_computeEnvironments.push_back(value); return *this; } /** *

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

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

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

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

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

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

The nextToken value returned from a previous paginated * DescribeComputeEnvironments 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 * DescribeComputeEnvironments 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 * DescribeComputeEnvironments 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 * DescribeComputeEnvironments 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 * DescribeComputeEnvironments 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 * DescribeComputeEnvironments 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 DescribeComputeEnvironmentsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

The nextToken value returned from a previous paginated * DescribeComputeEnvironments 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 DescribeComputeEnvironmentsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

The nextToken value returned from a previous paginated * DescribeComputeEnvironments 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 DescribeComputeEnvironmentsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::Vector m_computeEnvironments; bool m_computeEnvironmentsHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace Batch } // namespace Aws