/** * 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 RoboMaker { namespace Model { /** */ class ListWorldsRequest : public RoboMakerRequest { public: AWS_ROBOMAKER_API ListWorldsRequest(); // 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 "ListWorlds"; } AWS_ROBOMAKER_API Aws::String SerializePayload() const override; /** *

If the previous paginated request did not return all of the remaining * results, the response object's nextToken parameter value is set to * a token. To retrieve the next set of results, call ListWorlds again * and assign that token to the request object's nextToken parameter. * If there are no remaining results, the previous response object's NextToken * parameter is set to null.

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

If the previous paginated request did not return all of the remaining * results, the response object's nextToken parameter value is set to * a token. To retrieve the next set of results, call ListWorlds again * and assign that token to the request object's nextToken parameter. * If there are no remaining results, the previous response object's NextToken * parameter is set to null.

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

If the previous paginated request did not return all of the remaining * results, the response object's nextToken parameter value is set to * a token. To retrieve the next set of results, call ListWorlds again * and assign that token to the request object's nextToken parameter. * If there are no remaining results, the previous response object's NextToken * parameter is set to null.

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

If the previous paginated request did not return all of the remaining * results, the response object's nextToken parameter value is set to * a token. To retrieve the next set of results, call ListWorlds again * and assign that token to the request object's nextToken parameter. * If there are no remaining results, the previous response object's NextToken * parameter is set to null.

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

If the previous paginated request did not return all of the remaining * results, the response object's nextToken parameter value is set to * a token. To retrieve the next set of results, call ListWorlds again * and assign that token to the request object's nextToken parameter. * If there are no remaining results, the previous response object's NextToken * parameter is set to null.

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

If the previous paginated request did not return all of the remaining * results, the response object's nextToken parameter value is set to * a token. To retrieve the next set of results, call ListWorlds again * and assign that token to the request object's nextToken parameter. * If there are no remaining results, the previous response object's NextToken * parameter is set to null.

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

If the previous paginated request did not return all of the remaining * results, the response object's nextToken parameter value is set to * a token. To retrieve the next set of results, call ListWorlds again * and assign that token to the request object's nextToken parameter. * If there are no remaining results, the previous response object's NextToken * parameter is set to null.

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

If the previous paginated request did not return all of the remaining * results, the response object's nextToken parameter value is set to * a token. To retrieve the next set of results, call ListWorlds again * and assign that token to the request object's nextToken parameter. * If there are no remaining results, the previous response object's NextToken * parameter is set to null.

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

When this parameter is used, ListWorlds 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 ListWorlds request with the * returned nextToken value. This value can be between 1 and 100. If * this parameter is not used, then ListWorlds returns up to 100 * results and a nextToken value if applicable.

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

When this parameter is used, ListWorlds 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 ListWorlds request with the * returned nextToken value. This value can be between 1 and 100. If * this parameter is not used, then ListWorlds returns up to 100 * results and a nextToken value if applicable.

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

When this parameter is used, ListWorlds 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 ListWorlds request with the * returned nextToken value. This value can be between 1 and 100. If * this parameter is not used, then ListWorlds returns up to 100 * results and a nextToken value if applicable.

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

When this parameter is used, ListWorlds 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 ListWorlds request with the * returned nextToken value. This value can be between 1 and 100. If * this parameter is not used, then ListWorlds returns up to 100 * results and a nextToken value if applicable.

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

Optional filters to limit results. You can use status.

*/ inline const Aws::Vector& GetFilters() const{ return m_filters; } /** *

Optional filters to limit results. You can use status.

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

Optional filters to limit results. You can use status.

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

Optional filters to limit results. You can use status.

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

Optional filters to limit results. You can use status.

*/ inline ListWorldsRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

Optional filters to limit results. You can use status.

*/ inline ListWorldsRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

Optional filters to limit results. You can use status.

*/ inline ListWorldsRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

Optional filters to limit results. You can use status.

*/ inline ListWorldsRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } private: Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; }; } // namespace Model } // namespace RoboMaker } // namespace Aws