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

#include <GetExportRequest.h>

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

Public Member Functions

 GetExportRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () 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)
 
GetExportRequestWithRestApiId (const Aws::String &value)
 
GetExportRequestWithRestApiId (Aws::String &&value)
 
GetExportRequestWithRestApiId (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)
 
GetExportRequestWithStageName (const Aws::String &value)
 
GetExportRequestWithStageName (Aws::String &&value)
 
GetExportRequestWithStageName (const char *value)
 
const Aws::StringGetExportType () const
 
bool ExportTypeHasBeenSet () const
 
void SetExportType (const Aws::String &value)
 
void SetExportType (Aws::String &&value)
 
void SetExportType (const char *value)
 
GetExportRequestWithExportType (const Aws::String &value)
 
GetExportRequestWithExportType (Aws::String &&value)
 
GetExportRequestWithExportType (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
GetExportRequestWithParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
GetExportRequestWithParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
GetExportRequestAddParameters (const Aws::String &key, const Aws::String &value)
 
GetExportRequestAddParameters (Aws::String &&key, const Aws::String &value)
 
GetExportRequestAddParameters (const Aws::String &key, Aws::String &&value)
 
GetExportRequestAddParameters (Aws::String &&key, Aws::String &&value)
 
GetExportRequestAddParameters (const char *key, Aws::String &&value)
 
GetExportRequestAddParameters (Aws::String &&key, const char *value)
 
GetExportRequestAddParameters (const char *key, const char *value)
 
const Aws::StringGetAccepts () const
 
bool AcceptsHasBeenSet () const
 
void SetAccepts (const Aws::String &value)
 
void SetAccepts (Aws::String &&value)
 
void SetAccepts (const char *value)
 
GetExportRequestWithAccepts (const Aws::String &value)
 
GetExportRequestWithAccepts (Aws::String &&value)
 
GetExportRequestWithAccepts (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 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::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Request a new export of a RestApi for a particular Stage.

See Also:

AWS API Reference

Definition at line 30 of file GetExportRequest.h.

Constructor & Destructor Documentation

◆ GetExportRequest()

Aws::APIGateway::Model::GetExportRequest::GetExportRequest ( )

Member Function Documentation

◆ AcceptsHasBeenSet()

bool Aws::APIGateway::Model::GetExportRequest::AcceptsHasBeenSet ( ) const
inline

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

Definition at line 365 of file GetExportRequest.h.

◆ AddParameters() [1/7]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::AddParameters ( const Aws::String key,
const Aws::String value 
)
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 268 of file GetExportRequest.h.

◆ AddParameters() [2/7]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::AddParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 281 of file GetExportRequest.h.

◆ AddParameters() [3/7]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::AddParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 294 of file GetExportRequest.h.

◆ AddParameters() [4/7]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::AddParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 307 of file GetExportRequest.h.

◆ AddParameters() [5/7]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::AddParameters ( const char *  key,
Aws::String &&  value 
)
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 320 of file GetExportRequest.h.

◆ AddParameters() [6/7]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::AddParameters ( Aws::String &&  key,
const char *  value 
)
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 333 of file GetExportRequest.h.

◆ AddParameters() [7/7]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::AddParameters ( const char *  key,
const char *  value 
)
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 346 of file GetExportRequest.h.

◆ AddQueryStringParameters()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ExportTypeHasBeenSet()

bool Aws::APIGateway::Model::GetExportRequest::ExportTypeHasBeenSet ( ) const
inline

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Definition at line 140 of file GetExportRequest.h.

◆ GetAccepts()

const Aws::String& Aws::APIGateway::Model::GetExportRequest::GetAccepts ( ) const
inline

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

Definition at line 356 of file GetExportRequest.h.

◆ GetExportType()

const Aws::String& Aws::APIGateway::Model::GetExportRequest::GetExportType ( ) const
inline

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Definition at line 134 of file GetExportRequest.h.

◆ GetParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::GetExportRequest::GetParameters ( ) const
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 190 of file GetExportRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::APIGateway::Model::GetExportRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetRestApiId()

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

[Required] The string identifier of the associated RestApi.

Definition at line 51 of file GetExportRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file GetExportRequest.h.

◆ GetStageName()

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

[Required] The name of the Stage that will be exported.

Definition at line 92 of file GetExportRequest.h.

◆ ParametersHasBeenSet()

bool Aws::APIGateway::Model::GetExportRequest::ParametersHasBeenSet ( ) const
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 203 of file GetExportRequest.h.

◆ RestApiIdHasBeenSet()

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

[Required] The string identifier of the associated RestApi.

Definition at line 56 of file GetExportRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccepts() [1/3]

void Aws::APIGateway::Model::GetExportRequest::SetAccepts ( const Aws::String value)
inline

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

Definition at line 374 of file GetExportRequest.h.

◆ SetAccepts() [2/3]

void Aws::APIGateway::Model::GetExportRequest::SetAccepts ( Aws::String &&  value)
inline

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

Definition at line 383 of file GetExportRequest.h.

◆ SetAccepts() [3/3]

void Aws::APIGateway::Model::GetExportRequest::SetAccepts ( const char *  value)
inline

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

Definition at line 392 of file GetExportRequest.h.

◆ SetExportType() [1/3]

void Aws::APIGateway::Model::GetExportRequest::SetExportType ( const Aws::String value)
inline

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Definition at line 146 of file GetExportRequest.h.

◆ SetExportType() [2/3]

void Aws::APIGateway::Model::GetExportRequest::SetExportType ( Aws::String &&  value)
inline

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Definition at line 152 of file GetExportRequest.h.

◆ SetExportType() [3/3]

void Aws::APIGateway::Model::GetExportRequest::SetExportType ( const char *  value)
inline

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Definition at line 158 of file GetExportRequest.h.

◆ SetParameters() [1/2]

void Aws::APIGateway::Model::GetExportRequest::SetParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 216 of file GetExportRequest.h.

◆ SetParameters() [2/2]

void Aws::APIGateway::Model::GetExportRequest::SetParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 229 of file GetExportRequest.h.

◆ SetRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 61 of file GetExportRequest.h.

◆ SetRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 66 of file GetExportRequest.h.

◆ SetRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 71 of file GetExportRequest.h.

◆ SetStageName() [1/3]

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

[Required] The name of the Stage that will be exported.

Definition at line 102 of file GetExportRequest.h.

◆ SetStageName() [2/3]

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

[Required] The name of the Stage that will be exported.

Definition at line 107 of file GetExportRequest.h.

◆ SetStageName() [3/3]

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

[Required] The name of the Stage that will be exported.

Definition at line 112 of file GetExportRequest.h.

◆ StageNameHasBeenSet()

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

[Required] The name of the Stage that will be exported.

Definition at line 97 of file GetExportRequest.h.

◆ WithAccepts() [1/3]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::WithAccepts ( const Aws::String value)
inline

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

Definition at line 401 of file GetExportRequest.h.

◆ WithAccepts() [2/3]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::WithAccepts ( Aws::String &&  value)
inline

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

Definition at line 410 of file GetExportRequest.h.

◆ WithAccepts() [3/3]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::WithAccepts ( const char *  value)
inline

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

Definition at line 419 of file GetExportRequest.h.

◆ WithExportType() [1/3]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::WithExportType ( const Aws::String value)
inline

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Definition at line 164 of file GetExportRequest.h.

◆ WithExportType() [2/3]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::WithExportType ( Aws::String &&  value)
inline

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Definition at line 170 of file GetExportRequest.h.

◆ WithExportType() [3/3]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::WithExportType ( const char *  value)
inline

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Definition at line 176 of file GetExportRequest.h.

◆ WithParameters() [1/2]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::WithParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 242 of file GetExportRequest.h.

◆ WithParameters() [2/2]

GetExportRequest& Aws::APIGateway::Model::GetExportRequest::WithParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Definition at line 255 of file GetExportRequest.h.

◆ WithRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 76 of file GetExportRequest.h.

◆ WithRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 81 of file GetExportRequest.h.

◆ WithRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 86 of file GetExportRequest.h.

◆ WithStageName() [1/3]

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

[Required] The name of the Stage that will be exported.

Definition at line 117 of file GetExportRequest.h.

◆ WithStageName() [2/3]

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

[Required] The name of the Stage that will be exported.

Definition at line 122 of file GetExportRequest.h.

◆ WithStageName() [3/3]

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

[Required] The name of the Stage that will be exported.

Definition at line 127 of file GetExportRequest.h.


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