AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::ApiGatewayV2::Model::ExportApiRequest Class Reference

#include <ExportApiRequest.h>

+ Inheritance diagram for Aws::ApiGatewayV2::Model::ExportApiRequest:

Public Member Functions

 ExportApiRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetApiId () const
 
bool ApiIdHasBeenSet () const
 
void SetApiId (const Aws::String &value)
 
void SetApiId (Aws::String &&value)
 
void SetApiId (const char *value)
 
ExportApiRequestWithApiId (const Aws::String &value)
 
ExportApiRequestWithApiId (Aws::String &&value)
 
ExportApiRequestWithApiId (const char *value)
 
const Aws::StringGetExportVersion () const
 
bool ExportVersionHasBeenSet () const
 
void SetExportVersion (const Aws::String &value)
 
void SetExportVersion (Aws::String &&value)
 
void SetExportVersion (const char *value)
 
ExportApiRequestWithExportVersion (const Aws::String &value)
 
ExportApiRequestWithExportVersion (Aws::String &&value)
 
ExportApiRequestWithExportVersion (const char *value)
 
bool GetIncludeExtensions () const
 
bool IncludeExtensionsHasBeenSet () const
 
void SetIncludeExtensions (bool value)
 
ExportApiRequestWithIncludeExtensions (bool value)
 
const Aws::StringGetOutputType () const
 
bool OutputTypeHasBeenSet () const
 
void SetOutputType (const Aws::String &value)
 
void SetOutputType (Aws::String &&value)
 
void SetOutputType (const char *value)
 
ExportApiRequestWithOutputType (const Aws::String &value)
 
ExportApiRequestWithOutputType (Aws::String &&value)
 
ExportApiRequestWithOutputType (const char *value)
 
const Aws::StringGetSpecification () const
 
bool SpecificationHasBeenSet () const
 
void SetSpecification (const Aws::String &value)
 
void SetSpecification (Aws::String &&value)
 
void SetSpecification (const char *value)
 
ExportApiRequestWithSpecification (const Aws::String &value)
 
ExportApiRequestWithSpecification (Aws::String &&value)
 
ExportApiRequestWithSpecification (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)
 
ExportApiRequestWithStageName (const Aws::String &value)
 
ExportApiRequestWithStageName (Aws::String &&value)
 
ExportApiRequestWithStageName (const char *value)
 
- Public Member Functions inherited from Aws::ApiGatewayV2::ApiGatewayV2Request
virtual ~ApiGatewayV2Request ()
 
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::ApiGatewayV2::ApiGatewayV2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file ExportApiRequest.h.

Constructor & Destructor Documentation

◆ ExportApiRequest()

Aws::ApiGatewayV2::Model::ExportApiRequest::ExportApiRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::ApiGatewayV2::Model::ExportApiRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ApiIdHasBeenSet()

bool Aws::ApiGatewayV2::Model::ExportApiRequest::ApiIdHasBeenSet ( ) const
inline

The API identifier.

Definition at line 49 of file ExportApiRequest.h.

◆ ExportVersionHasBeenSet()

bool Aws::ApiGatewayV2::Model::ExportApiRequest::ExportVersionHasBeenSet ( ) const
inline

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Definition at line 92 of file ExportApiRequest.h.

◆ GetApiId()

const Aws::String& Aws::ApiGatewayV2::Model::ExportApiRequest::GetApiId ( ) const
inline

The API identifier.

Definition at line 44 of file ExportApiRequest.h.

◆ GetExportVersion()

const Aws::String& Aws::ApiGatewayV2::Model::ExportApiRequest::GetExportVersion ( ) const
inline

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Definition at line 86 of file ExportApiRequest.h.

◆ GetIncludeExtensions()

bool Aws::ApiGatewayV2::Model::ExportApiRequest::GetIncludeExtensions ( ) const
inline

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

Definition at line 137 of file ExportApiRequest.h.

◆ GetOutputType()

const Aws::String& Aws::ApiGatewayV2::Model::ExportApiRequest::GetOutputType ( ) const
inline

The output type of the exported definition file. Valid values are JSON and YAML.

Definition at line 168 of file ExportApiRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ApiGatewayV2::Model::ExportApiRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file ExportApiRequest.h.

◆ GetSpecification()

const Aws::String& Aws::ApiGatewayV2::Model::ExportApiRequest::GetSpecification ( ) const
inline

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Definition at line 217 of file ExportApiRequest.h.

◆ GetStageName()

const Aws::String& Aws::ApiGatewayV2::Model::ExportApiRequest::GetStageName ( ) const
inline

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Definition at line 266 of file ExportApiRequest.h.

◆ IncludeExtensionsHasBeenSet()

bool Aws::ApiGatewayV2::Model::ExportApiRequest::IncludeExtensionsHasBeenSet ( ) const
inline

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

Definition at line 145 of file ExportApiRequest.h.

◆ OutputTypeHasBeenSet()

bool Aws::ApiGatewayV2::Model::ExportApiRequest::OutputTypeHasBeenSet ( ) const
inline

The output type of the exported definition file. Valid values are JSON and YAML.

Definition at line 174 of file ExportApiRequest.h.

◆ SerializePayload()

Aws::String Aws::ApiGatewayV2::Model::ExportApiRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApiId() [1/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetApiId ( const Aws::String value)
inline

The API identifier.

Definition at line 54 of file ExportApiRequest.h.

◆ SetApiId() [2/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetApiId ( Aws::String &&  value)
inline

The API identifier.

Definition at line 59 of file ExportApiRequest.h.

◆ SetApiId() [3/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetApiId ( const char *  value)
inline

The API identifier.

Definition at line 64 of file ExportApiRequest.h.

◆ SetExportVersion() [1/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetExportVersion ( const Aws::String value)
inline

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Definition at line 98 of file ExportApiRequest.h.

◆ SetExportVersion() [2/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetExportVersion ( Aws::String &&  value)
inline

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Definition at line 104 of file ExportApiRequest.h.

◆ SetExportVersion() [3/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetExportVersion ( const char *  value)
inline

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Definition at line 110 of file ExportApiRequest.h.

◆ SetIncludeExtensions()

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetIncludeExtensions ( bool  value)
inline

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

Definition at line 153 of file ExportApiRequest.h.

◆ SetOutputType() [1/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetOutputType ( const Aws::String value)
inline

The output type of the exported definition file. Valid values are JSON and YAML.

Definition at line 180 of file ExportApiRequest.h.

◆ SetOutputType() [2/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetOutputType ( Aws::String &&  value)
inline

The output type of the exported definition file. Valid values are JSON and YAML.

Definition at line 186 of file ExportApiRequest.h.

◆ SetOutputType() [3/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetOutputType ( const char *  value)
inline

The output type of the exported definition file. Valid values are JSON and YAML.

Definition at line 192 of file ExportApiRequest.h.

◆ SetSpecification() [1/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetSpecification ( const Aws::String value)
inline

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Definition at line 229 of file ExportApiRequest.h.

◆ SetSpecification() [2/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetSpecification ( Aws::String &&  value)
inline

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Definition at line 235 of file ExportApiRequest.h.

◆ SetSpecification() [3/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetSpecification ( const char *  value)
inline

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Definition at line 241 of file ExportApiRequest.h.

◆ SetStageName() [1/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetStageName ( const Aws::String value)
inline

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Definition at line 278 of file ExportApiRequest.h.

◆ SetStageName() [2/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetStageName ( Aws::String &&  value)
inline

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Definition at line 284 of file ExportApiRequest.h.

◆ SetStageName() [3/3]

void Aws::ApiGatewayV2::Model::ExportApiRequest::SetStageName ( const char *  value)
inline

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Definition at line 290 of file ExportApiRequest.h.

◆ SpecificationHasBeenSet()

bool Aws::ApiGatewayV2::Model::ExportApiRequest::SpecificationHasBeenSet ( ) const
inline

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Definition at line 223 of file ExportApiRequest.h.

◆ StageNameHasBeenSet()

bool Aws::ApiGatewayV2::Model::ExportApiRequest::StageNameHasBeenSet ( ) const
inline

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Definition at line 272 of file ExportApiRequest.h.

◆ WithApiId() [1/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithApiId ( const Aws::String value)
inline

The API identifier.

Definition at line 69 of file ExportApiRequest.h.

◆ WithApiId() [2/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithApiId ( Aws::String &&  value)
inline

The API identifier.

Definition at line 74 of file ExportApiRequest.h.

◆ WithApiId() [3/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithApiId ( const char *  value)
inline

The API identifier.

Definition at line 79 of file ExportApiRequest.h.

◆ WithExportVersion() [1/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithExportVersion ( const Aws::String value)
inline

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Definition at line 116 of file ExportApiRequest.h.

◆ WithExportVersion() [2/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithExportVersion ( Aws::String &&  value)
inline

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Definition at line 122 of file ExportApiRequest.h.

◆ WithExportVersion() [3/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithExportVersion ( const char *  value)
inline

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Definition at line 128 of file ExportApiRequest.h.

◆ WithIncludeExtensions()

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithIncludeExtensions ( bool  value)
inline

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

Definition at line 161 of file ExportApiRequest.h.

◆ WithOutputType() [1/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithOutputType ( const Aws::String value)
inline

The output type of the exported definition file. Valid values are JSON and YAML.

Definition at line 198 of file ExportApiRequest.h.

◆ WithOutputType() [2/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithOutputType ( Aws::String &&  value)
inline

The output type of the exported definition file. Valid values are JSON and YAML.

Definition at line 204 of file ExportApiRequest.h.

◆ WithOutputType() [3/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithOutputType ( const char *  value)
inline

The output type of the exported definition file. Valid values are JSON and YAML.

Definition at line 210 of file ExportApiRequest.h.

◆ WithSpecification() [1/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithSpecification ( const Aws::String value)
inline

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Definition at line 247 of file ExportApiRequest.h.

◆ WithSpecification() [2/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithSpecification ( Aws::String &&  value)
inline

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Definition at line 253 of file ExportApiRequest.h.

◆ WithSpecification() [3/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithSpecification ( const char *  value)
inline

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Definition at line 259 of file ExportApiRequest.h.

◆ WithStageName() [1/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithStageName ( const Aws::String value)
inline

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Definition at line 296 of file ExportApiRequest.h.

◆ WithStageName() [2/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithStageName ( Aws::String &&  value)
inline

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Definition at line 302 of file ExportApiRequest.h.

◆ WithStageName() [3/3]

ExportApiRequest& Aws::ApiGatewayV2::Model::ExportApiRequest::WithStageName ( const char *  value)
inline

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Definition at line 308 of file ExportApiRequest.h.


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