/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include <aws/robomaker/RoboMaker_EXPORTS.h> #include <aws/robomaker/RoboMakerRequest.h> #include <aws/core/utils/memory/stl/AWSString.h> #include <aws/core/utils/memory/stl/AWSVector.h> #include <aws/robomaker/model/Filter.h> #include <utility> namespace Aws { namespace RoboMaker { namespace Model { /** */ class ListSimulationJobsRequest : public RoboMakerRequest { public: AWS_ROBOMAKER_API ListSimulationJobsRequest(); // 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 "ListSimulationJobs"; } AWS_ROBOMAKER_API Aws::String SerializePayload() const override; /** * <p>If the previous paginated request did not return all of the remaining * results, the response object's <code>nextToken</code> parameter value is set to * a token. To retrieve the next set of results, call * <code>ListSimulationJobs</code> again and assign that token to the request * object's <code>nextToken</code> parameter. If there are no remaining results, * the previous response object's NextToken parameter is set to null. </p> */ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** * <p>If the previous paginated request did not return all of the remaining * results, the response object's <code>nextToken</code> parameter value is set to * a token. To retrieve the next set of results, call * <code>ListSimulationJobs</code> again and assign that token to the request * object's <code>nextToken</code> parameter. If there are no remaining results, * the previous response object's NextToken parameter is set to null. </p> */ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** * <p>If the previous paginated request did not return all of the remaining * results, the response object's <code>nextToken</code> parameter value is set to * a token. To retrieve the next set of results, call * <code>ListSimulationJobs</code> again and assign that token to the request * object's <code>nextToken</code> parameter. If there are no remaining results, * the previous response object's NextToken parameter is set to null. </p> */ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** * <p>If the previous paginated request did not return all of the remaining * results, the response object's <code>nextToken</code> parameter value is set to * a token. To retrieve the next set of results, call * <code>ListSimulationJobs</code> again and assign that token to the request * object's <code>nextToken</code> parameter. If there are no remaining results, * the previous response object's NextToken parameter is set to null. </p> */ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** * <p>If the previous paginated request did not return all of the remaining * results, the response object's <code>nextToken</code> parameter value is set to * a token. To retrieve the next set of results, call * <code>ListSimulationJobs</code> again and assign that token to the request * object's <code>nextToken</code> parameter. If there are no remaining results, * the previous response object's NextToken parameter is set to null. </p> */ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** * <p>If the previous paginated request did not return all of the remaining * results, the response object's <code>nextToken</code> parameter value is set to * a token. To retrieve the next set of results, call * <code>ListSimulationJobs</code> again and assign that token to the request * object's <code>nextToken</code> parameter. If there are no remaining results, * the previous response object's NextToken parameter is set to null. </p> */ inline ListSimulationJobsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** * <p>If the previous paginated request did not return all of the remaining * results, the response object's <code>nextToken</code> parameter value is set to * a token. To retrieve the next set of results, call * <code>ListSimulationJobs</code> again and assign that token to the request * object's <code>nextToken</code> parameter. If there are no remaining results, * the previous response object's NextToken parameter is set to null. </p> */ inline ListSimulationJobsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** * <p>If the previous paginated request did not return all of the remaining * results, the response object's <code>nextToken</code> parameter value is set to * a token. To retrieve the next set of results, call * <code>ListSimulationJobs</code> again and assign that token to the request * object's <code>nextToken</code> parameter. If there are no remaining results, * the previous response object's NextToken parameter is set to null. </p> */ inline ListSimulationJobsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** * <p>When this parameter is used, <code>ListSimulationJobs</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>ListSimulationJobs</code> request * with the returned <code>nextToken</code> value. This value can be between 1 and * 1000. If this parameter is not used, then <code>ListSimulationJobs</code> * returns up to 1000 results and a <code>nextToken</code> value if applicable. * </p> */ inline int GetMaxResults() const{ return m_maxResults; } /** * <p>When this parameter is used, <code>ListSimulationJobs</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>ListSimulationJobs</code> request * with the returned <code>nextToken</code> value. This value can be between 1 and * 1000. If this parameter is not used, then <code>ListSimulationJobs</code> * returns up to 1000 results and a <code>nextToken</code> value if applicable. * </p> */ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** * <p>When this parameter is used, <code>ListSimulationJobs</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>ListSimulationJobs</code> request * with the returned <code>nextToken</code> value. This value can be between 1 and * 1000. If this parameter is not used, then <code>ListSimulationJobs</code> * returns up to 1000 results and a <code>nextToken</code> value if applicable. * </p> */ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** * <p>When this parameter is used, <code>ListSimulationJobs</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>ListSimulationJobs</code> request * with the returned <code>nextToken</code> value. This value can be between 1 and * 1000. If this parameter is not used, then <code>ListSimulationJobs</code> * returns up to 1000 results and a <code>nextToken</code> value if applicable. * </p> */ inline ListSimulationJobsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** * <p>Optional filters to limit results.</p> <p>The filter names * <code>status</code> and <code>simulationApplicationName</code> and * <code>robotApplicationName</code> are supported. When filtering, you must use * the complete value of the filtered item. You can use up to three filters, but * they must be for the same named item. For example, if you are looking for items * with the status <code>Preparing</code> or the status <code>Running</code>.</p> */ inline const Aws::Vector<Filter>& GetFilters() const{ return m_filters; } /** * <p>Optional filters to limit results.</p> <p>The filter names * <code>status</code> and <code>simulationApplicationName</code> and * <code>robotApplicationName</code> are supported. When filtering, you must use * the complete value of the filtered item. You can use up to three filters, but * they must be for the same named item. For example, if you are looking for items * with the status <code>Preparing</code> or the status <code>Running</code>.</p> */ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** * <p>Optional filters to limit results.</p> <p>The filter names * <code>status</code> and <code>simulationApplicationName</code> and * <code>robotApplicationName</code> are supported. When filtering, you must use * the complete value of the filtered item. You can use up to three filters, but * they must be for the same named item. For example, if you are looking for items * with the status <code>Preparing</code> or the status <code>Running</code>.</p> */ inline void SetFilters(const Aws::Vector<Filter>& value) { m_filtersHasBeenSet = true; m_filters = value; } /** * <p>Optional filters to limit results.</p> <p>The filter names * <code>status</code> and <code>simulationApplicationName</code> and * <code>robotApplicationName</code> are supported. When filtering, you must use * the complete value of the filtered item. You can use up to three filters, but * they must be for the same named item. For example, if you are looking for items * with the status <code>Preparing</code> or the status <code>Running</code>.</p> */ inline void SetFilters(Aws::Vector<Filter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** * <p>Optional filters to limit results.</p> <p>The filter names * <code>status</code> and <code>simulationApplicationName</code> and * <code>robotApplicationName</code> are supported. When filtering, you must use * the complete value of the filtered item. You can use up to three filters, but * they must be for the same named item. For example, if you are looking for items * with the status <code>Preparing</code> or the status <code>Running</code>.</p> */ inline ListSimulationJobsRequest& WithFilters(const Aws::Vector<Filter>& value) { SetFilters(value); return *this;} /** * <p>Optional filters to limit results.</p> <p>The filter names * <code>status</code> and <code>simulationApplicationName</code> and * <code>robotApplicationName</code> are supported. When filtering, you must use * the complete value of the filtered item. You can use up to three filters, but * they must be for the same named item. For example, if you are looking for items * with the status <code>Preparing</code> or the status <code>Running</code>.</p> */ inline ListSimulationJobsRequest& WithFilters(Aws::Vector<Filter>&& value) { SetFilters(std::move(value)); return *this;} /** * <p>Optional filters to limit results.</p> <p>The filter names * <code>status</code> and <code>simulationApplicationName</code> and * <code>robotApplicationName</code> are supported. When filtering, you must use * the complete value of the filtered item. You can use up to three filters, but * they must be for the same named item. For example, if you are looking for items * with the status <code>Preparing</code> or the status <code>Running</code>.</p> */ inline ListSimulationJobsRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** * <p>Optional filters to limit results.</p> <p>The filter names * <code>status</code> and <code>simulationApplicationName</code> and * <code>robotApplicationName</code> are supported. When filtering, you must use * the complete value of the filtered item. You can use up to three filters, but * they must be for the same named item. For example, if you are looking for items * with the status <code>Preparing</code> or the status <code>Running</code>.</p> */ inline ListSimulationJobsRequest& 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<Filter> m_filters; bool m_filtersHasBeenSet = false; }; } // namespace Model } // namespace RoboMaker } // namespace Aws