AWS SDK for C++  1.8.59
AWS SDK for C++
Public Member Functions | List of all members
Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest Class Reference

#include <ListProfilingGroupsRequest.h>

+ Inheritance diagram for Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest:

Public Member Functions

 ListProfilingGroupsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
bool GetIncludeDescription () const
 
bool IncludeDescriptionHasBeenSet () const
 
void SetIncludeDescription (bool value)
 
ListProfilingGroupsRequestWithIncludeDescription (bool value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListProfilingGroupsRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListProfilingGroupsRequestWithNextToken (const Aws::String &value)
 
ListProfilingGroupsRequestWithNextToken (Aws::String &&value)
 
ListProfilingGroupsRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::CodeGuruProfiler::CodeGuruProfilerRequest
virtual ~CodeGuruProfilerRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::CodeGuruProfiler::CodeGuruProfilerRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

The structure representing the listProfilingGroupsRequest.

See Also:

AWS API Reference

Definition at line 29 of file ListProfilingGroupsRequest.h.

Constructor & Destructor Documentation

◆ ListProfilingGroupsRequest()

Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::ListProfilingGroupsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetIncludeDescription()

bool Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::GetIncludeDescription ( ) const
inline

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.

Definition at line 53 of file ListProfilingGroupsRequest.h.

◆ GetMaxResults()

int Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::GetMaxResults ( ) const
inline

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.

Definition at line 95 of file ListProfilingGroupsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::GetNextToken ( ) const
inline

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.

Definition at line 140 of file ListProfilingGroupsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file ListProfilingGroupsRequest.h.

◆ IncludeDescriptionHasBeenSet()

bool Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::IncludeDescriptionHasBeenSet ( ) const
inline

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.

Definition at line 63 of file ListProfilingGroupsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::MaxResultsHasBeenSet ( ) const
inline

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.

Definition at line 106 of file ListProfilingGroupsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::NextTokenHasBeenSet ( ) const
inline

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.

Definition at line 151 of file ListProfilingGroupsRequest.h.

◆ SerializePayload()

Aws::String Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetIncludeDescription()

void Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::SetIncludeDescription ( bool  value)
inline

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.

Definition at line 73 of file ListProfilingGroupsRequest.h.

◆ SetMaxResults()

void Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::SetMaxResults ( int  value)
inline

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.

Definition at line 117 of file ListProfilingGroupsRequest.h.

◆ SetNextToken() [1/3]

void Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::SetNextToken ( const Aws::String value)
inline

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.

Definition at line 162 of file ListProfilingGroupsRequest.h.

◆ SetNextToken() [2/3]

void Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::SetNextToken ( Aws::String &&  value)
inline

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.

Definition at line 173 of file ListProfilingGroupsRequest.h.

◆ SetNextToken() [3/3]

void Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::SetNextToken ( const char *  value)
inline

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.

Definition at line 184 of file ListProfilingGroupsRequest.h.

◆ WithIncludeDescription()

ListProfilingGroupsRequest& Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::WithIncludeDescription ( bool  value)
inline

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.

Definition at line 83 of file ListProfilingGroupsRequest.h.

◆ WithMaxResults()

ListProfilingGroupsRequest& Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::WithMaxResults ( int  value)
inline

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.

Definition at line 128 of file ListProfilingGroupsRequest.h.

◆ WithNextToken() [1/3]

ListProfilingGroupsRequest& Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::WithNextToken ( const Aws::String value)
inline

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.

Definition at line 195 of file ListProfilingGroupsRequest.h.

◆ WithNextToken() [2/3]

ListProfilingGroupsRequest& Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::WithNextToken ( Aws::String &&  value)
inline

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.

Definition at line 206 of file ListProfilingGroupsRequest.h.

◆ WithNextToken() [3/3]

ListProfilingGroupsRequest& Aws::CodeGuruProfiler::Model::ListProfilingGroupsRequest::WithNextToken ( const char *  value)
inline

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.

Definition at line 217 of file ListProfilingGroupsRequest.h.


The documentation for this class was generated from the following file: