/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace MigrationHubStrategyRecommendations { namespace Model { /** */ class ListServersRequest : public MigrationHubStrategyRecommendationsRequest { public: AWS_MIGRATIONHUBSTRATEGYRECOMMENDATIONS_API ListServersRequest(); // 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 "ListServers"; } AWS_MIGRATIONHUBSTRATEGYRECOMMENDATIONS_API Aws::String SerializePayload() const override; /** *

Specifies the filter value, which is based on the type of server criteria. * For example, if serverCriteria is OS_NAME, and the * filterValue is equal to WindowsServer, then * ListServers returns all of the servers matching the OS name * WindowsServer.

*/ inline const Aws::String& GetFilterValue() const{ return m_filterValue; } /** *

Specifies the filter value, which is based on the type of server criteria. * For example, if serverCriteria is OS_NAME, and the * filterValue is equal to WindowsServer, then * ListServers returns all of the servers matching the OS name * WindowsServer.

*/ inline bool FilterValueHasBeenSet() const { return m_filterValueHasBeenSet; } /** *

Specifies the filter value, which is based on the type of server criteria. * For example, if serverCriteria is OS_NAME, and the * filterValue is equal to WindowsServer, then * ListServers returns all of the servers matching the OS name * WindowsServer.

*/ inline void SetFilterValue(const Aws::String& value) { m_filterValueHasBeenSet = true; m_filterValue = value; } /** *

Specifies the filter value, which is based on the type of server criteria. * For example, if serverCriteria is OS_NAME, and the * filterValue is equal to WindowsServer, then * ListServers returns all of the servers matching the OS name * WindowsServer.

*/ inline void SetFilterValue(Aws::String&& value) { m_filterValueHasBeenSet = true; m_filterValue = std::move(value); } /** *

Specifies the filter value, which is based on the type of server criteria. * For example, if serverCriteria is OS_NAME, and the * filterValue is equal to WindowsServer, then * ListServers returns all of the servers matching the OS name * WindowsServer.

*/ inline void SetFilterValue(const char* value) { m_filterValueHasBeenSet = true; m_filterValue.assign(value); } /** *

Specifies the filter value, which is based on the type of server criteria. * For example, if serverCriteria is OS_NAME, and the * filterValue is equal to WindowsServer, then * ListServers returns all of the servers matching the OS name * WindowsServer.

*/ inline ListServersRequest& WithFilterValue(const Aws::String& value) { SetFilterValue(value); return *this;} /** *

Specifies the filter value, which is based on the type of server criteria. * For example, if serverCriteria is OS_NAME, and the * filterValue is equal to WindowsServer, then * ListServers returns all of the servers matching the OS name * WindowsServer.

*/ inline ListServersRequest& WithFilterValue(Aws::String&& value) { SetFilterValue(std::move(value)); return *this;} /** *

Specifies the filter value, which is based on the type of server criteria. * For example, if serverCriteria is OS_NAME, and the * filterValue is equal to WindowsServer, then * ListServers returns all of the servers matching the OS name * WindowsServer.

*/ inline ListServersRequest& WithFilterValue(const char* value) { SetFilterValue(value); return *this;} /** *

Specifies the group ID to filter on.

*/ inline const Aws::Vector& GetGroupIdFilter() const{ return m_groupIdFilter; } /** *

Specifies the group ID to filter on.

*/ inline bool GroupIdFilterHasBeenSet() const { return m_groupIdFilterHasBeenSet; } /** *

Specifies the group ID to filter on.

*/ inline void SetGroupIdFilter(const Aws::Vector& value) { m_groupIdFilterHasBeenSet = true; m_groupIdFilter = value; } /** *

Specifies the group ID to filter on.

*/ inline void SetGroupIdFilter(Aws::Vector&& value) { m_groupIdFilterHasBeenSet = true; m_groupIdFilter = std::move(value); } /** *

Specifies the group ID to filter on.

*/ inline ListServersRequest& WithGroupIdFilter(const Aws::Vector& value) { SetGroupIdFilter(value); return *this;} /** *

Specifies the group ID to filter on.

*/ inline ListServersRequest& WithGroupIdFilter(Aws::Vector&& value) { SetGroupIdFilter(std::move(value)); return *this;} /** *

Specifies the group ID to filter on.

*/ inline ListServersRequest& AddGroupIdFilter(const Group& value) { m_groupIdFilterHasBeenSet = true; m_groupIdFilter.push_back(value); return *this; } /** *

Specifies the group ID to filter on.

*/ inline ListServersRequest& AddGroupIdFilter(Group&& value) { m_groupIdFilterHasBeenSet = true; m_groupIdFilter.push_back(std::move(value)); return *this; } /** *

The maximum number of items to include in the response. The maximum value is * 100.

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

The maximum number of items to include in the response. The maximum value is * 100.

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

The maximum number of items to include in the response. The maximum value is * 100.

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

The maximum number of items to include in the response. The maximum value is * 100.

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

The token from a previous call that you use to retrieve the next set of * results. For example, if a previous call to this action returned 100 items, but * you set maxResults to 10. You'll receive a set of 10 results along * with a token. You then use the returned token to retrieve the next set of 10. *

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

The token from a previous call that you use to retrieve the next set of * results. For example, if a previous call to this action returned 100 items, but * you set maxResults to 10. You'll receive a set of 10 results along * with a token. You then use the returned token to retrieve the next set of 10. *

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

The token from a previous call that you use to retrieve the next set of * results. For example, if a previous call to this action returned 100 items, but * you set maxResults to 10. You'll receive a set of 10 results along * with a token. You then use the returned token to retrieve the next set of 10. *

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

The token from a previous call that you use to retrieve the next set of * results. For example, if a previous call to this action returned 100 items, but * you set maxResults to 10. You'll receive a set of 10 results along * with a token. You then use the returned token to retrieve the next set of 10. *

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

The token from a previous call that you use to retrieve the next set of * results. For example, if a previous call to this action returned 100 items, but * you set maxResults to 10. You'll receive a set of 10 results along * with a token. You then use the returned token to retrieve the next set of 10. *

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

The token from a previous call that you use to retrieve the next set of * results. For example, if a previous call to this action returned 100 items, but * you set maxResults to 10. You'll receive a set of 10 results along * with a token. You then use the returned token to retrieve the next set of 10. *

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

The token from a previous call that you use to retrieve the next set of * results. For example, if a previous call to this action returned 100 items, but * you set maxResults to 10. You'll receive a set of 10 results along * with a token. You then use the returned token to retrieve the next set of 10. *

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

The token from a previous call that you use to retrieve the next set of * results. For example, if a previous call to this action returned 100 items, but * you set maxResults to 10. You'll receive a set of 10 results along * with a token. You then use the returned token to retrieve the next set of 10. *

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

Criteria for filtering servers.

*/ inline const ServerCriteria& GetServerCriteria() const{ return m_serverCriteria; } /** *

Criteria for filtering servers.

*/ inline bool ServerCriteriaHasBeenSet() const { return m_serverCriteriaHasBeenSet; } /** *

Criteria for filtering servers.

*/ inline void SetServerCriteria(const ServerCriteria& value) { m_serverCriteriaHasBeenSet = true; m_serverCriteria = value; } /** *

Criteria for filtering servers.

*/ inline void SetServerCriteria(ServerCriteria&& value) { m_serverCriteriaHasBeenSet = true; m_serverCriteria = std::move(value); } /** *

Criteria for filtering servers.

*/ inline ListServersRequest& WithServerCriteria(const ServerCriteria& value) { SetServerCriteria(value); return *this;} /** *

Criteria for filtering servers.

*/ inline ListServersRequest& WithServerCriteria(ServerCriteria&& value) { SetServerCriteria(std::move(value)); return *this;} /** *

Specifies whether to sort by ascending (ASC) or descending * (DESC) order.

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

Specifies whether to sort by ascending (ASC) or descending * (DESC) order.

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

Specifies whether to sort by ascending (ASC) or descending * (DESC) order.

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

Specifies whether to sort by ascending (ASC) or descending * (DESC) order.

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

Specifies whether to sort by ascending (ASC) or descending * (DESC) order.

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

Specifies whether to sort by ascending (ASC) or descending * (DESC) order.

*/ inline ListServersRequest& WithSort(SortOrder&& value) { SetSort(std::move(value)); return *this;} private: Aws::String m_filterValue; bool m_filterValueHasBeenSet = false; Aws::Vector m_groupIdFilter; bool m_groupIdFilterHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; ServerCriteria m_serverCriteria; bool m_serverCriteriaHasBeenSet = false; SortOrder m_sort; bool m_sortHasBeenSet = false; }; } // namespace Model } // namespace MigrationHubStrategyRecommendations } // namespace Aws