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

#include <CreateDocumentationPartRequest.h>

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

Public Member Functions

 CreateDocumentationPartRequest ()
 
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)
 
CreateDocumentationPartRequestWithRestApiId (const Aws::String &value)
 
CreateDocumentationPartRequestWithRestApiId (Aws::String &&value)
 
CreateDocumentationPartRequestWithRestApiId (const char *value)
 
const DocumentationPartLocationGetLocation () const
 
bool LocationHasBeenSet () const
 
void SetLocation (const DocumentationPartLocation &value)
 
void SetLocation (DocumentationPartLocation &&value)
 
CreateDocumentationPartRequestWithLocation (const DocumentationPartLocation &value)
 
CreateDocumentationPartRequestWithLocation (DocumentationPartLocation &&value)
 
const Aws::StringGetProperties () const
 
bool PropertiesHasBeenSet () const
 
void SetProperties (const Aws::String &value)
 
void SetProperties (Aws::String &&value)
 
void SetProperties (const char *value)
 
CreateDocumentationPartRequestWithProperties (const Aws::String &value)
 
CreateDocumentationPartRequestWithProperties (Aws::String &&value)
 
CreateDocumentationPartRequestWithProperties (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 part of a given API.

See Also:

AWS API Reference

Definition at line 26 of file CreateDocumentationPartRequest.h.

Constructor & Destructor Documentation

◆ CreateDocumentationPartRequest()

Aws::APIGateway::Model::CreateDocumentationPartRequest::CreateDocumentationPartRequest ( )

Member Function Documentation

◆ GetLocation()

const DocumentationPartLocation& Aws::APIGateway::Model::CreateDocumentationPartRequest::GetLocation ( ) const
inline

[Required] The location of the targeted API entity of the to-be-created documentation part.

Definition at line 85 of file CreateDocumentationPartRequest.h.

◆ GetProperties()

const Aws::String& Aws::APIGateway::Model::CreateDocumentationPartRequest::GetProperties ( ) const
inline

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Definition at line 123 of file CreateDocumentationPartRequest.h.

◆ GetRestApiId()

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

[Required] The string identifier of the associated RestApi.

Definition at line 43 of file CreateDocumentationPartRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CreateDocumentationPartRequest.h.

◆ LocationHasBeenSet()

bool Aws::APIGateway::Model::CreateDocumentationPartRequest::LocationHasBeenSet ( ) const
inline

[Required] The location of the targeted API entity of the to-be-created documentation part.

Definition at line 91 of file CreateDocumentationPartRequest.h.

◆ PropertiesHasBeenSet()

bool Aws::APIGateway::Model::CreateDocumentationPartRequest::PropertiesHasBeenSet ( ) const
inline

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Definition at line 130 of file CreateDocumentationPartRequest.h.

◆ RestApiIdHasBeenSet()

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

[Required] The string identifier of the associated RestApi.

Definition at line 48 of file CreateDocumentationPartRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetLocation() [1/2]

void Aws::APIGateway::Model::CreateDocumentationPartRequest::SetLocation ( const DocumentationPartLocation value)
inline

[Required] The location of the targeted API entity of the to-be-created documentation part.

Definition at line 97 of file CreateDocumentationPartRequest.h.

◆ SetLocation() [2/2]

void Aws::APIGateway::Model::CreateDocumentationPartRequest::SetLocation ( DocumentationPartLocation &&  value)
inline

[Required] The location of the targeted API entity of the to-be-created documentation part.

Definition at line 103 of file CreateDocumentationPartRequest.h.

◆ SetProperties() [1/3]

void Aws::APIGateway::Model::CreateDocumentationPartRequest::SetProperties ( const Aws::String value)
inline

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Definition at line 137 of file CreateDocumentationPartRequest.h.

◆ SetProperties() [2/3]

void Aws::APIGateway::Model::CreateDocumentationPartRequest::SetProperties ( Aws::String &&  value)
inline

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Definition at line 144 of file CreateDocumentationPartRequest.h.

◆ SetProperties() [3/3]

void Aws::APIGateway::Model::CreateDocumentationPartRequest::SetProperties ( const char *  value)
inline

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Definition at line 151 of file CreateDocumentationPartRequest.h.

◆ SetRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 53 of file CreateDocumentationPartRequest.h.

◆ SetRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 58 of file CreateDocumentationPartRequest.h.

◆ SetRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 63 of file CreateDocumentationPartRequest.h.

◆ WithLocation() [1/2]

CreateDocumentationPartRequest& Aws::APIGateway::Model::CreateDocumentationPartRequest::WithLocation ( const DocumentationPartLocation value)
inline

[Required] The location of the targeted API entity of the to-be-created documentation part.

Definition at line 109 of file CreateDocumentationPartRequest.h.

◆ WithLocation() [2/2]

CreateDocumentationPartRequest& Aws::APIGateway::Model::CreateDocumentationPartRequest::WithLocation ( DocumentationPartLocation &&  value)
inline

[Required] The location of the targeted API entity of the to-be-created documentation part.

Definition at line 115 of file CreateDocumentationPartRequest.h.

◆ WithProperties() [1/3]

CreateDocumentationPartRequest& Aws::APIGateway::Model::CreateDocumentationPartRequest::WithProperties ( const Aws::String value)
inline

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Definition at line 158 of file CreateDocumentationPartRequest.h.

◆ WithProperties() [2/3]

CreateDocumentationPartRequest& Aws::APIGateway::Model::CreateDocumentationPartRequest::WithProperties ( Aws::String &&  value)
inline

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Definition at line 165 of file CreateDocumentationPartRequest.h.

◆ WithProperties() [3/3]

CreateDocumentationPartRequest& Aws::APIGateway::Model::CreateDocumentationPartRequest::WithProperties ( const char *  value)
inline

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Definition at line 172 of file CreateDocumentationPartRequest.h.

◆ WithRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 68 of file CreateDocumentationPartRequest.h.

◆ WithRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 73 of file CreateDocumentationPartRequest.h.

◆ WithRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 78 of file CreateDocumentationPartRequest.h.


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