AWS SDK for C++  1.9.104
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::GetDocumentationVersionsRequest Class Reference

#include <GetDocumentationVersionsRequest.h>

+ Inheritance diagram for Aws::APIGateway::Model::GetDocumentationVersionsRequest:

Public Member Functions

 GetDocumentationVersionsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetRestApiId () const
 
bool RestApiIdHasBeenSet () const
 
void SetRestApiId (const Aws::String &value)
 
void SetRestApiId (Aws::String &&value)
 
void SetRestApiId (const char *value)
 
GetDocumentationVersionsRequestWithRestApiId (const Aws::String &value)
 
GetDocumentationVersionsRequestWithRestApiId (Aws::String &&value)
 
GetDocumentationVersionsRequestWithRestApiId (const char *value)
 
const Aws::StringGetPosition () const
 
bool PositionHasBeenSet () const
 
void SetPosition (const Aws::String &value)
 
void SetPosition (Aws::String &&value)
 
void SetPosition (const char *value)
 
GetDocumentationVersionsRequestWithPosition (const Aws::String &value)
 
GetDocumentationVersionsRequestWithPosition (Aws::String &&value)
 
GetDocumentationVersionsRequestWithPosition (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
GetDocumentationVersionsRequestWithLimit (int value)
 
- Public Member Functions inherited from Aws::APIGateway::APIGatewayRequest
virtual ~APIGatewayRequest ()
 
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::APIGateway::APIGatewayRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Gets the documentation versions of an API.

See Also:

AWS API Reference

Definition at line 28 of file GetDocumentationVersionsRequest.h.

Constructor & Destructor Documentation

◆ GetDocumentationVersionsRequest()

Aws::APIGateway::Model::GetDocumentationVersionsRequest::GetDocumentationVersionsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::APIGateway::Model::GetDocumentationVersionsRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetLimit()

int Aws::APIGateway::Model::GetDocumentationVersionsRequest::GetLimit ( ) const
inline

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Definition at line 130 of file GetDocumentationVersionsRequest.h.

◆ GetPosition()

const Aws::String& Aws::APIGateway::Model::GetDocumentationVersionsRequest::GetPosition ( ) const
inline

The current pagination position in the paged result set.

Definition at line 88 of file GetDocumentationVersionsRequest.h.

◆ GetRestApiId()

const Aws::String& Aws::APIGateway::Model::GetDocumentationVersionsRequest::GetRestApiId ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 47 of file GetDocumentationVersionsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::APIGateway::Model::GetDocumentationVersionsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file GetDocumentationVersionsRequest.h.

◆ LimitHasBeenSet()

bool Aws::APIGateway::Model::GetDocumentationVersionsRequest::LimitHasBeenSet ( ) const
inline

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Definition at line 136 of file GetDocumentationVersionsRequest.h.

◆ PositionHasBeenSet()

bool Aws::APIGateway::Model::GetDocumentationVersionsRequest::PositionHasBeenSet ( ) const
inline

The current pagination position in the paged result set.

Definition at line 93 of file GetDocumentationVersionsRequest.h.

◆ RestApiIdHasBeenSet()

bool Aws::APIGateway::Model::GetDocumentationVersionsRequest::RestApiIdHasBeenSet ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 52 of file GetDocumentationVersionsRequest.h.

◆ SerializePayload()

Aws::String Aws::APIGateway::Model::GetDocumentationVersionsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetLimit()

void Aws::APIGateway::Model::GetDocumentationVersionsRequest::SetLimit ( int  value)
inline

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Definition at line 142 of file GetDocumentationVersionsRequest.h.

◆ SetPosition() [1/3]

void Aws::APIGateway::Model::GetDocumentationVersionsRequest::SetPosition ( Aws::String &&  value)
inline

The current pagination position in the paged result set.

Definition at line 103 of file GetDocumentationVersionsRequest.h.

◆ SetPosition() [2/3]

void Aws::APIGateway::Model::GetDocumentationVersionsRequest::SetPosition ( const Aws::String value)
inline

The current pagination position in the paged result set.

Definition at line 98 of file GetDocumentationVersionsRequest.h.

◆ SetPosition() [3/3]

void Aws::APIGateway::Model::GetDocumentationVersionsRequest::SetPosition ( const char *  value)
inline

The current pagination position in the paged result set.

Definition at line 108 of file GetDocumentationVersionsRequest.h.

◆ SetRestApiId() [1/3]

void Aws::APIGateway::Model::GetDocumentationVersionsRequest::SetRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 62 of file GetDocumentationVersionsRequest.h.

◆ SetRestApiId() [2/3]

void Aws::APIGateway::Model::GetDocumentationVersionsRequest::SetRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 57 of file GetDocumentationVersionsRequest.h.

◆ SetRestApiId() [3/3]

void Aws::APIGateway::Model::GetDocumentationVersionsRequest::SetRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 67 of file GetDocumentationVersionsRequest.h.

◆ WithLimit()

GetDocumentationVersionsRequest& Aws::APIGateway::Model::GetDocumentationVersionsRequest::WithLimit ( int  value)
inline

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Definition at line 148 of file GetDocumentationVersionsRequest.h.

◆ WithPosition() [1/3]

GetDocumentationVersionsRequest& Aws::APIGateway::Model::GetDocumentationVersionsRequest::WithPosition ( Aws::String &&  value)
inline

The current pagination position in the paged result set.

Definition at line 118 of file GetDocumentationVersionsRequest.h.

◆ WithPosition() [2/3]

GetDocumentationVersionsRequest& Aws::APIGateway::Model::GetDocumentationVersionsRequest::WithPosition ( const Aws::String value)
inline

The current pagination position in the paged result set.

Definition at line 113 of file GetDocumentationVersionsRequest.h.

◆ WithPosition() [3/3]

GetDocumentationVersionsRequest& Aws::APIGateway::Model::GetDocumentationVersionsRequest::WithPosition ( const char *  value)
inline

The current pagination position in the paged result set.

Definition at line 123 of file GetDocumentationVersionsRequest.h.

◆ WithRestApiId() [1/3]

GetDocumentationVersionsRequest& Aws::APIGateway::Model::GetDocumentationVersionsRequest::WithRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 77 of file GetDocumentationVersionsRequest.h.

◆ WithRestApiId() [2/3]

GetDocumentationVersionsRequest& Aws::APIGateway::Model::GetDocumentationVersionsRequest::WithRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 72 of file GetDocumentationVersionsRequest.h.

◆ WithRestApiId() [3/3]

GetDocumentationVersionsRequest& Aws::APIGateway::Model::GetDocumentationVersionsRequest::WithRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 82 of file GetDocumentationVersionsRequest.h.


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