/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace ECS { namespace Model { /** */ class ListTaskDefinitionsRequest : public ECSRequest { public: AWS_ECS_API ListTaskDefinitionsRequest(); // 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 "ListTaskDefinitions"; } AWS_ECS_API Aws::String SerializePayload() const override; AWS_ECS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The full family name to filter the ListTaskDefinitions results * with. Specifying a familyPrefix limits the listed task definitions * to task definition revisions that belong to that family.

*/ inline const Aws::String& GetFamilyPrefix() const{ return m_familyPrefix; } /** *

The full family name to filter the ListTaskDefinitions results * with. Specifying a familyPrefix limits the listed task definitions * to task definition revisions that belong to that family.

*/ inline bool FamilyPrefixHasBeenSet() const { return m_familyPrefixHasBeenSet; } /** *

The full family name to filter the ListTaskDefinitions results * with. Specifying a familyPrefix limits the listed task definitions * to task definition revisions that belong to that family.

*/ inline void SetFamilyPrefix(const Aws::String& value) { m_familyPrefixHasBeenSet = true; m_familyPrefix = value; } /** *

The full family name to filter the ListTaskDefinitions results * with. Specifying a familyPrefix limits the listed task definitions * to task definition revisions that belong to that family.

*/ inline void SetFamilyPrefix(Aws::String&& value) { m_familyPrefixHasBeenSet = true; m_familyPrefix = std::move(value); } /** *

The full family name to filter the ListTaskDefinitions results * with. Specifying a familyPrefix limits the listed task definitions * to task definition revisions that belong to that family.

*/ inline void SetFamilyPrefix(const char* value) { m_familyPrefixHasBeenSet = true; m_familyPrefix.assign(value); } /** *

The full family name to filter the ListTaskDefinitions results * with. Specifying a familyPrefix limits the listed task definitions * to task definition revisions that belong to that family.

*/ inline ListTaskDefinitionsRequest& WithFamilyPrefix(const Aws::String& value) { SetFamilyPrefix(value); return *this;} /** *

The full family name to filter the ListTaskDefinitions results * with. Specifying a familyPrefix limits the listed task definitions * to task definition revisions that belong to that family.

*/ inline ListTaskDefinitionsRequest& WithFamilyPrefix(Aws::String&& value) { SetFamilyPrefix(std::move(value)); return *this;} /** *

The full family name to filter the ListTaskDefinitions results * with. Specifying a familyPrefix limits the listed task definitions * to task definition revisions that belong to that family.

*/ inline ListTaskDefinitionsRequest& WithFamilyPrefix(const char* value) { SetFamilyPrefix(value); return *this;} /** *

The task definition status to filter the ListTaskDefinitions * results with. By default, only ACTIVE task definitions are listed. * By setting this parameter to INACTIVE, you can view task * definitions that are INACTIVE as long as an active task or service * still references them. If you paginate the resulting output, be sure to keep the * status value constant in each subsequent request.

*/ inline const TaskDefinitionStatus& GetStatus() const{ return m_status; } /** *

The task definition status to filter the ListTaskDefinitions * results with. By default, only ACTIVE task definitions are listed. * By setting this parameter to INACTIVE, you can view task * definitions that are INACTIVE as long as an active task or service * still references them. If you paginate the resulting output, be sure to keep the * status value constant in each subsequent request.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The task definition status to filter the ListTaskDefinitions * results with. By default, only ACTIVE task definitions are listed. * By setting this parameter to INACTIVE, you can view task * definitions that are INACTIVE as long as an active task or service * still references them. If you paginate the resulting output, be sure to keep the * status value constant in each subsequent request.

*/ inline void SetStatus(const TaskDefinitionStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The task definition status to filter the ListTaskDefinitions * results with. By default, only ACTIVE task definitions are listed. * By setting this parameter to INACTIVE, you can view task * definitions that are INACTIVE as long as an active task or service * still references them. If you paginate the resulting output, be sure to keep the * status value constant in each subsequent request.

*/ inline void SetStatus(TaskDefinitionStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The task definition status to filter the ListTaskDefinitions * results with. By default, only ACTIVE task definitions are listed. * By setting this parameter to INACTIVE, you can view task * definitions that are INACTIVE as long as an active task or service * still references them. If you paginate the resulting output, be sure to keep the * status value constant in each subsequent request.

*/ inline ListTaskDefinitionsRequest& WithStatus(const TaskDefinitionStatus& value) { SetStatus(value); return *this;} /** *

The task definition status to filter the ListTaskDefinitions * results with. By default, only ACTIVE task definitions are listed. * By setting this parameter to INACTIVE, you can view task * definitions that are INACTIVE as long as an active task or service * still references them. If you paginate the resulting output, be sure to keep the * status value constant in each subsequent request.

*/ inline ListTaskDefinitionsRequest& WithStatus(TaskDefinitionStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

The order to sort the results in. Valid values are ASC and * DESC. By default, (ASC) task definitions are listed * lexicographically by family name and in ascending numerical order by revision so * that the newest task definitions in a family are listed last. Setting this * parameter to DESC reverses the sort order on family name and * revision. This is so that the newest task definitions in a family are listed * first.

*/ inline const SortOrder& GetSort() const{ return m_sort; } /** *

The order to sort the results in. Valid values are ASC and * DESC. By default, (ASC) task definitions are listed * lexicographically by family name and in ascending numerical order by revision so * that the newest task definitions in a family are listed last. Setting this * parameter to DESC reverses the sort order on family name and * revision. This is so that the newest task definitions in a family are listed * first.

*/ inline bool SortHasBeenSet() const { return m_sortHasBeenSet; } /** *

The order to sort the results in. Valid values are ASC and * DESC. By default, (ASC) task definitions are listed * lexicographically by family name and in ascending numerical order by revision so * that the newest task definitions in a family are listed last. Setting this * parameter to DESC reverses the sort order on family name and * revision. This is so that the newest task definitions in a family are listed * first.

*/ inline void SetSort(const SortOrder& value) { m_sortHasBeenSet = true; m_sort = value; } /** *

The order to sort the results in. Valid values are ASC and * DESC. By default, (ASC) task definitions are listed * lexicographically by family name and in ascending numerical order by revision so * that the newest task definitions in a family are listed last. Setting this * parameter to DESC reverses the sort order on family name and * revision. This is so that the newest task definitions in a family are listed * first.

*/ inline void SetSort(SortOrder&& value) { m_sortHasBeenSet = true; m_sort = std::move(value); } /** *

The order to sort the results in. Valid values are ASC and * DESC. By default, (ASC) task definitions are listed * lexicographically by family name and in ascending numerical order by revision so * that the newest task definitions in a family are listed last. Setting this * parameter to DESC reverses the sort order on family name and * revision. This is so that the newest task definitions in a family are listed * first.

*/ inline ListTaskDefinitionsRequest& WithSort(const SortOrder& value) { SetSort(value); return *this;} /** *

The order to sort the results in. Valid values are ASC and * DESC. By default, (ASC) task definitions are listed * lexicographically by family name and in ascending numerical order by revision so * that the newest task definitions in a family are listed last. Setting this * parameter to DESC reverses the sort order on family name and * revision. This is so that the newest task definitions in a family are listed * first.

*/ inline ListTaskDefinitionsRequest& WithSort(SortOrder&& value) { SetSort(std::move(value)); return *this;} /** *

The nextToken value returned from a * ListTaskDefinitions request indicating that more results are * available to fulfill the request and further calls will be needed. If * maxResults was provided, it is possible the number of results to be * fewer than maxResults.

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.

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

The nextToken value returned from a * ListTaskDefinitions request indicating that more results are * available to fulfill the request and further calls will be needed. If * maxResults was provided, it is possible the number of results to be * fewer than maxResults.

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.

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

The nextToken value returned from a * ListTaskDefinitions request indicating that more results are * available to fulfill the request and further calls will be needed. If * maxResults was provided, it is possible the number of results to be * fewer than maxResults.

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.

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

The nextToken value returned from a * ListTaskDefinitions request indicating that more results are * available to fulfill the request and further calls will be needed. If * maxResults was provided, it is possible the number of results to be * fewer than maxResults.

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.

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

The nextToken value returned from a * ListTaskDefinitions request indicating that more results are * available to fulfill the request and further calls will be needed. If * maxResults was provided, it is possible the number of results to be * fewer than maxResults.

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.

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

The nextToken value returned from a * ListTaskDefinitions request indicating that more results are * available to fulfill the request and further calls will be needed. If * maxResults was provided, it is possible the number of results to be * fewer than maxResults.

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.

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

The nextToken value returned from a * ListTaskDefinitions request indicating that more results are * available to fulfill the request and further calls will be needed. If * maxResults was provided, it is possible the number of results to be * fewer than maxResults.

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.

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

The nextToken value returned from a * ListTaskDefinitions request indicating that more results are * available to fulfill the request and further calls will be needed. If * maxResults was provided, it is possible the number of results to be * fewer than maxResults.

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.

*/ inline ListTaskDefinitionsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The maximum number of task definition results that * ListTaskDefinitions returned in paginated output. When this * parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request * with the returned nextToken value. This value can be between 1 and * 100. If this parameter isn't used, then ListTaskDefinitions returns * up to 100 results and a nextToken value if applicable.

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

The maximum number of task definition results that * ListTaskDefinitions returned in paginated output. When this * parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request * with the returned nextToken value. This value can be between 1 and * 100. If this parameter isn't used, then ListTaskDefinitions returns * up to 100 results and a nextToken value if applicable.

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

The maximum number of task definition results that * ListTaskDefinitions returned in paginated output. When this * parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request * with the returned nextToken value. This value can be between 1 and * 100. If this parameter isn't used, then ListTaskDefinitions 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 task definition results that * ListTaskDefinitions returned in paginated output. When this * parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request * with the returned nextToken value. This value can be between 1 and * 100. If this parameter isn't used, then ListTaskDefinitions returns * up to 100 results and a nextToken value if applicable.

*/ inline ListTaskDefinitionsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} private: Aws::String m_familyPrefix; bool m_familyPrefixHasBeenSet = false; TaskDefinitionStatus m_status; bool m_statusHasBeenSet = false; SortOrder m_sort; bool m_sortHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; }; } // namespace Model } // namespace ECS } // namespace Aws