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

#include <ImportDocumentationPartsRequest.h>

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

Public Member Functions

 ImportDocumentationPartsRequest ()
 
virtual const char * GetServiceRequestName () 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)
 
ImportDocumentationPartsRequestWithRestApiId (const Aws::String &value)
 
ImportDocumentationPartsRequestWithRestApiId (Aws::String &&value)
 
ImportDocumentationPartsRequestWithRestApiId (const char *value)
 
const PutModeGetMode () const
 
bool ModeHasBeenSet () const
 
void SetMode (const PutMode &value)
 
void SetMode (PutMode &&value)
 
ImportDocumentationPartsRequestWithMode (const PutMode &value)
 
ImportDocumentationPartsRequestWithMode (PutMode &&value)
 
bool GetFailOnWarnings () const
 
bool FailOnWarningsHasBeenSet () const
 
void SetFailOnWarnings (bool value)
 
ImportDocumentationPartsRequestWithFailOnWarnings (bool value)
 
- Public Member Functions inherited from Aws::AmazonStreamingWebServiceRequest
 AmazonStreamingWebServiceRequest ()
 
virtual ~AmazonStreamingWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
void SetBody (const std::shared_ptr< Aws::IOStream > &body)
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
bool IsStreaming () const override
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &contentType)
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) 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::AmazonStreamingWebServiceRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Import documentation parts from an external (e.g., OpenAPI) definition file.

See Also:

AWS API Reference

Definition at line 31 of file ImportDocumentationPartsRequest.h.

Constructor & Destructor Documentation

◆ ImportDocumentationPartsRequest()

Aws::APIGateway::Model::ImportDocumentationPartsRequest::ImportDocumentationPartsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ FailOnWarningsHasBeenSet()

bool Aws::APIGateway::Model::ImportDocumentationPartsRequest::FailOnWarningsHasBeenSet ( ) const
inline

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

Definition at line 147 of file ImportDocumentationPartsRequest.h.

◆ GetFailOnWarnings()

bool Aws::APIGateway::Model::ImportDocumentationPartsRequest::GetFailOnWarnings ( ) const
inline

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

Definition at line 140 of file ImportDocumentationPartsRequest.h.

◆ GetMode()

const PutMode& Aws::APIGateway::Model::ImportDocumentationPartsRequest::GetMode ( ) const
inline

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

Definition at line 92 of file ImportDocumentationPartsRequest.h.

◆ GetRestApiId()

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

[Required] The string identifier of the associated RestApi.

Definition at line 48 of file ImportDocumentationPartsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file ImportDocumentationPartsRequest.h.

◆ ModeHasBeenSet()

bool Aws::APIGateway::Model::ImportDocumentationPartsRequest::ModeHasBeenSet ( ) const
inline

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

Definition at line 100 of file ImportDocumentationPartsRequest.h.

◆ RestApiIdHasBeenSet()

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

[Required] The string identifier of the associated RestApi.

Definition at line 53 of file ImportDocumentationPartsRequest.h.

◆ SetFailOnWarnings()

void Aws::APIGateway::Model::ImportDocumentationPartsRequest::SetFailOnWarnings ( bool  value)
inline

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

Definition at line 154 of file ImportDocumentationPartsRequest.h.

◆ SetMode() [1/2]

void Aws::APIGateway::Model::ImportDocumentationPartsRequest::SetMode ( const PutMode value)
inline

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

Definition at line 108 of file ImportDocumentationPartsRequest.h.

◆ SetMode() [2/2]

void Aws::APIGateway::Model::ImportDocumentationPartsRequest::SetMode ( PutMode &&  value)
inline

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

Definition at line 116 of file ImportDocumentationPartsRequest.h.

◆ SetRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 58 of file ImportDocumentationPartsRequest.h.

◆ SetRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 63 of file ImportDocumentationPartsRequest.h.

◆ SetRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 68 of file ImportDocumentationPartsRequest.h.

◆ WithFailOnWarnings()

ImportDocumentationPartsRequest& Aws::APIGateway::Model::ImportDocumentationPartsRequest::WithFailOnWarnings ( bool  value)
inline

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

Definition at line 161 of file ImportDocumentationPartsRequest.h.

◆ WithMode() [1/2]

ImportDocumentationPartsRequest& Aws::APIGateway::Model::ImportDocumentationPartsRequest::WithMode ( const PutMode value)
inline

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

Definition at line 124 of file ImportDocumentationPartsRequest.h.

◆ WithMode() [2/2]

ImportDocumentationPartsRequest& Aws::APIGateway::Model::ImportDocumentationPartsRequest::WithMode ( PutMode &&  value)
inline

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

Definition at line 132 of file ImportDocumentationPartsRequest.h.

◆ WithRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 73 of file ImportDocumentationPartsRequest.h.

◆ WithRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 78 of file ImportDocumentationPartsRequest.h.

◆ WithRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 83 of file ImportDocumentationPartsRequest.h.


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