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

#include <GetDocumentationPartsRequest.h>

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

Public Member Functions

 GetDocumentationPartsRequest ()
 
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)
 
GetDocumentationPartsRequestWithRestApiId (const Aws::String &value)
 
GetDocumentationPartsRequestWithRestApiId (Aws::String &&value)
 
GetDocumentationPartsRequestWithRestApiId (const char *value)
 
const DocumentationPartTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const DocumentationPartType &value)
 
void SetType (DocumentationPartType &&value)
 
GetDocumentationPartsRequestWithType (const DocumentationPartType &value)
 
GetDocumentationPartsRequestWithType (DocumentationPartType &&value)
 
const Aws::StringGetNameQuery () const
 
bool NameQueryHasBeenSet () const
 
void SetNameQuery (const Aws::String &value)
 
void SetNameQuery (Aws::String &&value)
 
void SetNameQuery (const char *value)
 
GetDocumentationPartsRequestWithNameQuery (const Aws::String &value)
 
GetDocumentationPartsRequestWithNameQuery (Aws::String &&value)
 
GetDocumentationPartsRequestWithNameQuery (const char *value)
 
const Aws::StringGetPath () const
 
bool PathHasBeenSet () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
GetDocumentationPartsRequestWithPath (const Aws::String &value)
 
GetDocumentationPartsRequestWithPath (Aws::String &&value)
 
GetDocumentationPartsRequestWithPath (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)
 
GetDocumentationPartsRequestWithPosition (const Aws::String &value)
 
GetDocumentationPartsRequestWithPosition (Aws::String &&value)
 
GetDocumentationPartsRequestWithPosition (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
GetDocumentationPartsRequestWithLimit (int value)
 
const LocationStatusTypeGetLocationStatus () const
 
bool LocationStatusHasBeenSet () const
 
void SetLocationStatus (const LocationStatusType &value)
 
void SetLocationStatus (LocationStatusType &&value)
 
GetDocumentationPartsRequestWithLocationStatus (const LocationStatusType &value)
 
GetDocumentationPartsRequestWithLocationStatus (LocationStatusType &&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 parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

See Also:

AWS API Reference

Definition at line 31 of file GetDocumentationPartsRequest.h.

Constructor & Destructor Documentation

◆ GetDocumentationPartsRequest()

Aws::APIGateway::Model::GetDocumentationPartsRequest::GetDocumentationPartsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::APIGateway::Model::GetDocumentationPartsRequest::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::GetDocumentationPartsRequest::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 246 of file GetDocumentationPartsRequest.h.

◆ GetLocationStatus()

const LocationStatusType& Aws::APIGateway::Model::GetDocumentationPartsRequest::GetLocationStatus ( ) const
inline

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

Definition at line 273 of file GetDocumentationPartsRequest.h.

◆ GetNameQuery()

const Aws::String& Aws::APIGateway::Model::GetDocumentationPartsRequest::GetNameQuery ( ) const
inline

The name of API entities of the to-be-retrieved documentation parts.

Definition at line 122 of file GetDocumentationPartsRequest.h.

◆ GetPath()

const Aws::String& Aws::APIGateway::Model::GetDocumentationPartsRequest::GetPath ( ) const
inline

The path of API entities of the to-be-retrieved documentation parts.

Definition at line 163 of file GetDocumentationPartsRequest.h.

◆ GetPosition()

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

The current pagination position in the paged result set.

Definition at line 204 of file GetDocumentationPartsRequest.h.

◆ GetRestApiId()

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

[Required] The string identifier of the associated RestApi.

Definition at line 50 of file GetDocumentationPartsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file GetDocumentationPartsRequest.h.

◆ GetType()

const DocumentationPartType& Aws::APIGateway::Model::GetDocumentationPartsRequest::GetType ( ) const
inline

The type of API entities of the to-be-retrieved documentation parts.

Definition at line 91 of file GetDocumentationPartsRequest.h.

◆ LimitHasBeenSet()

bool Aws::APIGateway::Model::GetDocumentationPartsRequest::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 252 of file GetDocumentationPartsRequest.h.

◆ LocationStatusHasBeenSet()

bool Aws::APIGateway::Model::GetDocumentationPartsRequest::LocationStatusHasBeenSet ( ) const
inline

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

Definition at line 281 of file GetDocumentationPartsRequest.h.

◆ NameQueryHasBeenSet()

bool Aws::APIGateway::Model::GetDocumentationPartsRequest::NameQueryHasBeenSet ( ) const
inline

The name of API entities of the to-be-retrieved documentation parts.

Definition at line 127 of file GetDocumentationPartsRequest.h.

◆ PathHasBeenSet()

bool Aws::APIGateway::Model::GetDocumentationPartsRequest::PathHasBeenSet ( ) const
inline

The path of API entities of the to-be-retrieved documentation parts.

Definition at line 168 of file GetDocumentationPartsRequest.h.

◆ PositionHasBeenSet()

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

The current pagination position in the paged result set.

Definition at line 209 of file GetDocumentationPartsRequest.h.

◆ RestApiIdHasBeenSet()

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

[Required] The string identifier of the associated RestApi.

Definition at line 55 of file GetDocumentationPartsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetLimit()

void Aws::APIGateway::Model::GetDocumentationPartsRequest::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 258 of file GetDocumentationPartsRequest.h.

◆ SetLocationStatus() [1/2]

void Aws::APIGateway::Model::GetDocumentationPartsRequest::SetLocationStatus ( const LocationStatusType value)
inline

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

Definition at line 289 of file GetDocumentationPartsRequest.h.

◆ SetLocationStatus() [2/2]

void Aws::APIGateway::Model::GetDocumentationPartsRequest::SetLocationStatus ( LocationStatusType &&  value)
inline

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

Definition at line 297 of file GetDocumentationPartsRequest.h.

◆ SetNameQuery() [1/3]

void Aws::APIGateway::Model::GetDocumentationPartsRequest::SetNameQuery ( Aws::String &&  value)
inline

The name of API entities of the to-be-retrieved documentation parts.

Definition at line 137 of file GetDocumentationPartsRequest.h.

◆ SetNameQuery() [2/3]

void Aws::APIGateway::Model::GetDocumentationPartsRequest::SetNameQuery ( const Aws::String value)
inline

The name of API entities of the to-be-retrieved documentation parts.

Definition at line 132 of file GetDocumentationPartsRequest.h.

◆ SetNameQuery() [3/3]

void Aws::APIGateway::Model::GetDocumentationPartsRequest::SetNameQuery ( const char *  value)
inline

The name of API entities of the to-be-retrieved documentation parts.

Definition at line 142 of file GetDocumentationPartsRequest.h.

◆ SetPath() [1/3]

void Aws::APIGateway::Model::GetDocumentationPartsRequest::SetPath ( Aws::String &&  value)
inline

The path of API entities of the to-be-retrieved documentation parts.

Definition at line 178 of file GetDocumentationPartsRequest.h.

◆ SetPath() [2/3]

void Aws::APIGateway::Model::GetDocumentationPartsRequest::SetPath ( const Aws::String value)
inline

The path of API entities of the to-be-retrieved documentation parts.

Definition at line 173 of file GetDocumentationPartsRequest.h.

◆ SetPath() [3/3]

void Aws::APIGateway::Model::GetDocumentationPartsRequest::SetPath ( const char *  value)
inline

The path of API entities of the to-be-retrieved documentation parts.

Definition at line 183 of file GetDocumentationPartsRequest.h.

◆ SetPosition() [1/3]

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

The current pagination position in the paged result set.

Definition at line 219 of file GetDocumentationPartsRequest.h.

◆ SetPosition() [2/3]

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

The current pagination position in the paged result set.

Definition at line 214 of file GetDocumentationPartsRequest.h.

◆ SetPosition() [3/3]

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

The current pagination position in the paged result set.

Definition at line 224 of file GetDocumentationPartsRequest.h.

◆ SetRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 65 of file GetDocumentationPartsRequest.h.

◆ SetRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 60 of file GetDocumentationPartsRequest.h.

◆ SetRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 70 of file GetDocumentationPartsRequest.h.

◆ SetType() [1/2]

void Aws::APIGateway::Model::GetDocumentationPartsRequest::SetType ( const DocumentationPartType value)
inline

The type of API entities of the to-be-retrieved documentation parts.

Definition at line 101 of file GetDocumentationPartsRequest.h.

◆ SetType() [2/2]

void Aws::APIGateway::Model::GetDocumentationPartsRequest::SetType ( DocumentationPartType &&  value)
inline

The type of API entities of the to-be-retrieved documentation parts.

Definition at line 106 of file GetDocumentationPartsRequest.h.

◆ TypeHasBeenSet()

bool Aws::APIGateway::Model::GetDocumentationPartsRequest::TypeHasBeenSet ( ) const
inline

The type of API entities of the to-be-retrieved documentation parts.

Definition at line 96 of file GetDocumentationPartsRequest.h.

◆ WithLimit()

GetDocumentationPartsRequest& Aws::APIGateway::Model::GetDocumentationPartsRequest::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 264 of file GetDocumentationPartsRequest.h.

◆ WithLocationStatus() [1/2]

GetDocumentationPartsRequest& Aws::APIGateway::Model::GetDocumentationPartsRequest::WithLocationStatus ( const LocationStatusType value)
inline

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

Definition at line 305 of file GetDocumentationPartsRequest.h.

◆ WithLocationStatus() [2/2]

GetDocumentationPartsRequest& Aws::APIGateway::Model::GetDocumentationPartsRequest::WithLocationStatus ( LocationStatusType &&  value)
inline

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

Definition at line 313 of file GetDocumentationPartsRequest.h.

◆ WithNameQuery() [1/3]

GetDocumentationPartsRequest& Aws::APIGateway::Model::GetDocumentationPartsRequest::WithNameQuery ( Aws::String &&  value)
inline

The name of API entities of the to-be-retrieved documentation parts.

Definition at line 152 of file GetDocumentationPartsRequest.h.

◆ WithNameQuery() [2/3]

GetDocumentationPartsRequest& Aws::APIGateway::Model::GetDocumentationPartsRequest::WithNameQuery ( const Aws::String value)
inline

The name of API entities of the to-be-retrieved documentation parts.

Definition at line 147 of file GetDocumentationPartsRequest.h.

◆ WithNameQuery() [3/3]

GetDocumentationPartsRequest& Aws::APIGateway::Model::GetDocumentationPartsRequest::WithNameQuery ( const char *  value)
inline

The name of API entities of the to-be-retrieved documentation parts.

Definition at line 157 of file GetDocumentationPartsRequest.h.

◆ WithPath() [1/3]

GetDocumentationPartsRequest& Aws::APIGateway::Model::GetDocumentationPartsRequest::WithPath ( Aws::String &&  value)
inline

The path of API entities of the to-be-retrieved documentation parts.

Definition at line 193 of file GetDocumentationPartsRequest.h.

◆ WithPath() [2/3]

GetDocumentationPartsRequest& Aws::APIGateway::Model::GetDocumentationPartsRequest::WithPath ( const Aws::String value)
inline

The path of API entities of the to-be-retrieved documentation parts.

Definition at line 188 of file GetDocumentationPartsRequest.h.

◆ WithPath() [3/3]

GetDocumentationPartsRequest& Aws::APIGateway::Model::GetDocumentationPartsRequest::WithPath ( const char *  value)
inline

The path of API entities of the to-be-retrieved documentation parts.

Definition at line 198 of file GetDocumentationPartsRequest.h.

◆ WithPosition() [1/3]

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

The current pagination position in the paged result set.

Definition at line 234 of file GetDocumentationPartsRequest.h.

◆ WithPosition() [2/3]

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

The current pagination position in the paged result set.

Definition at line 229 of file GetDocumentationPartsRequest.h.

◆ WithPosition() [3/3]

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

The current pagination position in the paged result set.

Definition at line 239 of file GetDocumentationPartsRequest.h.

◆ WithRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 80 of file GetDocumentationPartsRequest.h.

◆ WithRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 75 of file GetDocumentationPartsRequest.h.

◆ WithRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 85 of file GetDocumentationPartsRequest.h.

◆ WithType() [1/2]

GetDocumentationPartsRequest& Aws::APIGateway::Model::GetDocumentationPartsRequest::WithType ( const DocumentationPartType value)
inline

The type of API entities of the to-be-retrieved documentation parts.

Definition at line 111 of file GetDocumentationPartsRequest.h.

◆ WithType() [2/2]

GetDocumentationPartsRequest& Aws::APIGateway::Model::GetDocumentationPartsRequest::WithType ( DocumentationPartType &&  value)
inline

The type of API entities of the to-be-retrieved documentation parts.

Definition at line 116 of file GetDocumentationPartsRequest.h.


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