/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace CodeGuruProfiler { namespace Model { /** *

The structure representing the listProfilingGroupsRequest.

See * Also:

AWS * API Reference

*/ class ListProfilingGroupsRequest : public CodeGuruProfilerRequest { public: AWS_CODEGURUPROFILER_API ListProfilingGroupsRequest(); // 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 "ListProfilingGroups"; } AWS_CODEGURUPROFILER_API Aws::String SerializePayload() const override; AWS_CODEGURUPROFILER_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

A Boolean value indicating whether to include a description. If * true, then a list of * ProfilingGroupDescription objects that contain detailed * information about profiling groups is returned. If false, then a * list of profiling group names is returned.

*/ inline bool GetIncludeDescription() const{ return m_includeDescription; } /** *

A Boolean value indicating whether to include a description. If * true, then a list of * ProfilingGroupDescription objects that contain detailed * information about profiling groups is returned. If false, then a * list of profiling group names is returned.

*/ inline bool IncludeDescriptionHasBeenSet() const { return m_includeDescriptionHasBeenSet; } /** *

A Boolean value indicating whether to include a description. If * true, then a list of * ProfilingGroupDescription objects that contain detailed * information about profiling groups is returned. If false, then a * list of profiling group names is returned.

*/ inline void SetIncludeDescription(bool value) { m_includeDescriptionHasBeenSet = true; m_includeDescription = value; } /** *

A Boolean value indicating whether to include a description. If * true, then a list of * ProfilingGroupDescription objects that contain detailed * information about profiling groups is returned. If false, then a * list of profiling group names is returned.

*/ inline ListProfilingGroupsRequest& WithIncludeDescription(bool value) { SetIncludeDescription(value); return *this;} /** *

The maximum number of profiling groups results returned by * ListProfilingGroups in paginated output. When this parameter is * used, ListProfilingGroups 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 * ListProfilingGroups request with the returned * nextToken value.

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

The maximum number of profiling groups results returned by * ListProfilingGroups in paginated output. When this parameter is * used, ListProfilingGroups 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 * ListProfilingGroups request with the returned * nextToken value.

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

The maximum number of profiling groups results returned by * ListProfilingGroups in paginated output. When this parameter is * used, ListProfilingGroups 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 * ListProfilingGroups request with the returned * nextToken value.

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

The maximum number of profiling groups results returned by * ListProfilingGroups in paginated output. When this parameter is * used, ListProfilingGroups 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 * ListProfilingGroups request with the returned * nextToken value.

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

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

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

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