AWS SDK for C++  1.9.124
AWS SDK for C++
Public Member Functions | List of all members
Aws::Synthetics::Model::DescribeCanariesRequest Class Reference

#include <DescribeCanariesRequest.h>

+ Inheritance diagram for Aws::Synthetics::Model::DescribeCanariesRequest:

Public Member Functions

 DescribeCanariesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeCanariesRequestWithNextToken (const Aws::String &value)
 
DescribeCanariesRequestWithNextToken (Aws::String &&value)
 
DescribeCanariesRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeCanariesRequestWithMaxResults (int value)
 
- Public Member Functions inherited from Aws::Synthetics::SyntheticsRequest
virtual ~SyntheticsRequest ()
 
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 AddQueryStringParameters (Aws::Http::URI &uri) const
 
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::Synthetics::SyntheticsRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file DescribeCanariesRequest.h.

Constructor & Destructor Documentation

◆ DescribeCanariesRequest()

Aws::Synthetics::Model::DescribeCanariesRequest::DescribeCanariesRequest ( )

Member Function Documentation

◆ GetMaxResults()

int Aws::Synthetics::Model::DescribeCanariesRequest::GetMaxResults ( ) const
inline

Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

Definition at line 89 of file DescribeCanariesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Synthetics::Model::DescribeCanariesRequest::GetNextToken ( ) const
inline

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Definition at line 39 of file DescribeCanariesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Synthetics::Model::DescribeCanariesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file DescribeCanariesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Synthetics::Model::DescribeCanariesRequest::MaxResultsHasBeenSet ( ) const
inline

Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

Definition at line 96 of file DescribeCanariesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Synthetics::Model::DescribeCanariesRequest::NextTokenHasBeenSet ( ) const
inline

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Definition at line 45 of file DescribeCanariesRequest.h.

◆ SerializePayload()

Aws::String Aws::Synthetics::Model::DescribeCanariesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaxResults()

void Aws::Synthetics::Model::DescribeCanariesRequest::SetMaxResults ( int  value)
inline

Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

Definition at line 103 of file DescribeCanariesRequest.h.

◆ SetNextToken() [1/3]

void Aws::Synthetics::Model::DescribeCanariesRequest::SetNextToken ( Aws::String &&  value)
inline

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Definition at line 57 of file DescribeCanariesRequest.h.

◆ SetNextToken() [2/3]

void Aws::Synthetics::Model::DescribeCanariesRequest::SetNextToken ( const Aws::String value)
inline

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Definition at line 51 of file DescribeCanariesRequest.h.

◆ SetNextToken() [3/3]

void Aws::Synthetics::Model::DescribeCanariesRequest::SetNextToken ( const char *  value)
inline

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Definition at line 63 of file DescribeCanariesRequest.h.

◆ WithMaxResults()

DescribeCanariesRequest& Aws::Synthetics::Model::DescribeCanariesRequest::WithMaxResults ( int  value)
inline

Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

Definition at line 110 of file DescribeCanariesRequest.h.

◆ WithNextToken() [1/3]

DescribeCanariesRequest& Aws::Synthetics::Model::DescribeCanariesRequest::WithNextToken ( Aws::String &&  value)
inline

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Definition at line 75 of file DescribeCanariesRequest.h.

◆ WithNextToken() [2/3]

DescribeCanariesRequest& Aws::Synthetics::Model::DescribeCanariesRequest::WithNextToken ( const Aws::String value)
inline

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Definition at line 69 of file DescribeCanariesRequest.h.

◆ WithNextToken() [3/3]

DescribeCanariesRequest& Aws::Synthetics::Model::DescribeCanariesRequest::WithNextToken ( const char *  value)
inline

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Definition at line 81 of file DescribeCanariesRequest.h.


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