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

#include <CreateDocumentationVersionRequest.h>

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

Public Member Functions

 CreateDocumentationVersionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () 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)
 
CreateDocumentationVersionRequestWithRestApiId (const Aws::String &value)
 
CreateDocumentationVersionRequestWithRestApiId (Aws::String &&value)
 
CreateDocumentationVersionRequestWithRestApiId (const char *value)
 
const Aws::StringGetDocumentationVersion () const
 
bool DocumentationVersionHasBeenSet () const
 
void SetDocumentationVersion (const Aws::String &value)
 
void SetDocumentationVersion (Aws::String &&value)
 
void SetDocumentationVersion (const char *value)
 
CreateDocumentationVersionRequestWithDocumentationVersion (const Aws::String &value)
 
CreateDocumentationVersionRequestWithDocumentationVersion (Aws::String &&value)
 
CreateDocumentationVersionRequestWithDocumentationVersion (const char *value)
 
const Aws::StringGetStageName () const
 
bool StageNameHasBeenSet () const
 
void SetStageName (const Aws::String &value)
 
void SetStageName (Aws::String &&value)
 
void SetStageName (const char *value)
 
CreateDocumentationVersionRequestWithStageName (const Aws::String &value)
 
CreateDocumentationVersionRequestWithStageName (Aws::String &&value)
 
CreateDocumentationVersionRequestWithStageName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateDocumentationVersionRequestWithDescription (const Aws::String &value)
 
CreateDocumentationVersionRequestWithDescription (Aws::String &&value)
 
CreateDocumentationVersionRequestWithDescription (const char *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 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::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

Creates a new documentation version of a given API.

See Also:

AWS API Reference

Definition at line 25 of file CreateDocumentationVersionRequest.h.

Constructor & Destructor Documentation

◆ CreateDocumentationVersionRequest()

Aws::APIGateway::Model::CreateDocumentationVersionRequest::CreateDocumentationVersionRequest ( )

Member Function Documentation

◆ DescriptionHasBeenSet()

bool Aws::APIGateway::Model::CreateDocumentationVersionRequest::DescriptionHasBeenSet ( ) const
inline

A description about the new documentation snapshot.

Definition at line 170 of file CreateDocumentationVersionRequest.h.

◆ DocumentationVersionHasBeenSet()

bool Aws::APIGateway::Model::CreateDocumentationVersionRequest::DocumentationVersionHasBeenSet ( ) const
inline

[Required] The version identifier of the new snapshot.

Definition at line 88 of file CreateDocumentationVersionRequest.h.

◆ GetDescription()

const Aws::String& Aws::APIGateway::Model::CreateDocumentationVersionRequest::GetDescription ( ) const
inline

A description about the new documentation snapshot.

Definition at line 165 of file CreateDocumentationVersionRequest.h.

◆ GetDocumentationVersion()

const Aws::String& Aws::APIGateway::Model::CreateDocumentationVersionRequest::GetDocumentationVersion ( ) const
inline

[Required] The version identifier of the new snapshot.

Definition at line 83 of file CreateDocumentationVersionRequest.h.

◆ GetRestApiId()

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

[Required] The string identifier of the associated RestApi.

Definition at line 42 of file CreateDocumentationVersionRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreateDocumentationVersionRequest.h.

◆ GetStageName()

const Aws::String& Aws::APIGateway::Model::CreateDocumentationVersionRequest::GetStageName ( ) const
inline

The stage name to be associated with the new documentation snapshot.

Definition at line 124 of file CreateDocumentationVersionRequest.h.

◆ RestApiIdHasBeenSet()

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

[Required] The string identifier of the associated RestApi.

Definition at line 47 of file CreateDocumentationVersionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

void Aws::APIGateway::Model::CreateDocumentationVersionRequest::SetDescription ( const Aws::String value)
inline

A description about the new documentation snapshot.

Definition at line 175 of file CreateDocumentationVersionRequest.h.

◆ SetDescription() [2/3]

void Aws::APIGateway::Model::CreateDocumentationVersionRequest::SetDescription ( Aws::String &&  value)
inline

A description about the new documentation snapshot.

Definition at line 180 of file CreateDocumentationVersionRequest.h.

◆ SetDescription() [3/3]

void Aws::APIGateway::Model::CreateDocumentationVersionRequest::SetDescription ( const char *  value)
inline

A description about the new documentation snapshot.

Definition at line 185 of file CreateDocumentationVersionRequest.h.

◆ SetDocumentationVersion() [1/3]

void Aws::APIGateway::Model::CreateDocumentationVersionRequest::SetDocumentationVersion ( const Aws::String value)
inline

[Required] The version identifier of the new snapshot.

Definition at line 93 of file CreateDocumentationVersionRequest.h.

◆ SetDocumentationVersion() [2/3]

void Aws::APIGateway::Model::CreateDocumentationVersionRequest::SetDocumentationVersion ( Aws::String &&  value)
inline

[Required] The version identifier of the new snapshot.

Definition at line 98 of file CreateDocumentationVersionRequest.h.

◆ SetDocumentationVersion() [3/3]

void Aws::APIGateway::Model::CreateDocumentationVersionRequest::SetDocumentationVersion ( const char *  value)
inline

[Required] The version identifier of the new snapshot.

Definition at line 103 of file CreateDocumentationVersionRequest.h.

◆ SetRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 52 of file CreateDocumentationVersionRequest.h.

◆ SetRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 57 of file CreateDocumentationVersionRequest.h.

◆ SetRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 62 of file CreateDocumentationVersionRequest.h.

◆ SetStageName() [1/3]

void Aws::APIGateway::Model::CreateDocumentationVersionRequest::SetStageName ( const Aws::String value)
inline

The stage name to be associated with the new documentation snapshot.

Definition at line 134 of file CreateDocumentationVersionRequest.h.

◆ SetStageName() [2/3]

void Aws::APIGateway::Model::CreateDocumentationVersionRequest::SetStageName ( Aws::String &&  value)
inline

The stage name to be associated with the new documentation snapshot.

Definition at line 139 of file CreateDocumentationVersionRequest.h.

◆ SetStageName() [3/3]

void Aws::APIGateway::Model::CreateDocumentationVersionRequest::SetStageName ( const char *  value)
inline

The stage name to be associated with the new documentation snapshot.

Definition at line 144 of file CreateDocumentationVersionRequest.h.

◆ StageNameHasBeenSet()

bool Aws::APIGateway::Model::CreateDocumentationVersionRequest::StageNameHasBeenSet ( ) const
inline

The stage name to be associated with the new documentation snapshot.

Definition at line 129 of file CreateDocumentationVersionRequest.h.

◆ WithDescription() [1/3]

CreateDocumentationVersionRequest& Aws::APIGateway::Model::CreateDocumentationVersionRequest::WithDescription ( const Aws::String value)
inline

A description about the new documentation snapshot.

Definition at line 190 of file CreateDocumentationVersionRequest.h.

◆ WithDescription() [2/3]

CreateDocumentationVersionRequest& Aws::APIGateway::Model::CreateDocumentationVersionRequest::WithDescription ( Aws::String &&  value)
inline

A description about the new documentation snapshot.

Definition at line 195 of file CreateDocumentationVersionRequest.h.

◆ WithDescription() [3/3]

CreateDocumentationVersionRequest& Aws::APIGateway::Model::CreateDocumentationVersionRequest::WithDescription ( const char *  value)
inline

A description about the new documentation snapshot.

Definition at line 200 of file CreateDocumentationVersionRequest.h.

◆ WithDocumentationVersion() [1/3]

CreateDocumentationVersionRequest& Aws::APIGateway::Model::CreateDocumentationVersionRequest::WithDocumentationVersion ( const Aws::String value)
inline

[Required] The version identifier of the new snapshot.

Definition at line 108 of file CreateDocumentationVersionRequest.h.

◆ WithDocumentationVersion() [2/3]

CreateDocumentationVersionRequest& Aws::APIGateway::Model::CreateDocumentationVersionRequest::WithDocumentationVersion ( Aws::String &&  value)
inline

[Required] The version identifier of the new snapshot.

Definition at line 113 of file CreateDocumentationVersionRequest.h.

◆ WithDocumentationVersion() [3/3]

CreateDocumentationVersionRequest& Aws::APIGateway::Model::CreateDocumentationVersionRequest::WithDocumentationVersion ( const char *  value)
inline

[Required] The version identifier of the new snapshot.

Definition at line 118 of file CreateDocumentationVersionRequest.h.

◆ WithRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 67 of file CreateDocumentationVersionRequest.h.

◆ WithRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 72 of file CreateDocumentationVersionRequest.h.

◆ WithRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 77 of file CreateDocumentationVersionRequest.h.

◆ WithStageName() [1/3]

CreateDocumentationVersionRequest& Aws::APIGateway::Model::CreateDocumentationVersionRequest::WithStageName ( const Aws::String value)
inline

The stage name to be associated with the new documentation snapshot.

Definition at line 149 of file CreateDocumentationVersionRequest.h.

◆ WithStageName() [2/3]

CreateDocumentationVersionRequest& Aws::APIGateway::Model::CreateDocumentationVersionRequest::WithStageName ( Aws::String &&  value)
inline

The stage name to be associated with the new documentation snapshot.

Definition at line 154 of file CreateDocumentationVersionRequest.h.

◆ WithStageName() [3/3]

CreateDocumentationVersionRequest& Aws::APIGateway::Model::CreateDocumentationVersionRequest::WithStageName ( const char *  value)
inline

The stage name to be associated with the new documentation snapshot.

Definition at line 159 of file CreateDocumentationVersionRequest.h.


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