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

#include <PutRestApiRequest.h>

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

Public Member Functions

 PutRestApiRequest ()
 
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)
 
PutRestApiRequestWithRestApiId (const Aws::String &value)
 
PutRestApiRequestWithRestApiId (Aws::String &&value)
 
PutRestApiRequestWithRestApiId (const char *value)
 
const PutModeGetMode () const
 
bool ModeHasBeenSet () const
 
void SetMode (const PutMode &value)
 
void SetMode (PutMode &&value)
 
PutRestApiRequestWithMode (const PutMode &value)
 
PutRestApiRequestWithMode (PutMode &&value)
 
bool GetFailOnWarnings () const
 
bool FailOnWarningsHasBeenSet () const
 
void SetFailOnWarnings (bool value)
 
PutRestApiRequestWithFailOnWarnings (bool 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)
 
PutRestApiRequestWithParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
PutRestApiRequestWithParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
PutRestApiRequestAddParameters (const Aws::String &key, const Aws::String &value)
 
PutRestApiRequestAddParameters (Aws::String &&key, const Aws::String &value)
 
PutRestApiRequestAddParameters (const Aws::String &key, Aws::String &&value)
 
PutRestApiRequestAddParameters (Aws::String &&key, Aws::String &&value)
 
PutRestApiRequestAddParameters (const char *key, Aws::String &&value)
 
PutRestApiRequestAddParameters (Aws::String &&key, const char *value)
 
PutRestApiRequestAddParameters (const char *key, const char *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

A PUT request to update an existing API, with external API definitions specified as the request body.

See Also:

AWS API Reference

Definition at line 32 of file PutRestApiRequest.h.

Constructor & Destructor Documentation

◆ PutRestApiRequest()

Aws::APIGateway::Model::PutRestApiRequest::PutRestApiRequest ( )

Member Function Documentation

◆ AddParameters() [1/7]

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 214 of file PutRestApiRequest.h.

◆ AddParameters() [2/7]

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 223 of file PutRestApiRequest.h.

◆ AddParameters() [3/7]

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 232 of file PutRestApiRequest.h.

◆ AddParameters() [4/7]

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 241 of file PutRestApiRequest.h.

◆ AddParameters() [5/7]

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 250 of file PutRestApiRequest.h.

◆ AddParameters() [6/7]

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 259 of file PutRestApiRequest.h.

◆ AddParameters() [7/7]

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 268 of file PutRestApiRequest.h.

◆ AddQueryStringParameters()

void Aws::APIGateway::Model::PutRestApiRequest::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::PutRestApiRequest::FailOnWarningsHasBeenSet ( ) const
inline

A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

Definition at line 136 of file PutRestApiRequest.h.

◆ GetFailOnWarnings()

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

A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

Definition at line 129 of file PutRestApiRequest.h.

◆ GetMode()

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

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Definition at line 91 of file PutRestApiRequest.h.

◆ GetParameters()

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 160 of file PutRestApiRequest.h.

◆ GetRestApiId()

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

[Required] The string identifier of the associated RestApi.

Definition at line 49 of file PutRestApiRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 41 of file PutRestApiRequest.h.

◆ ModeHasBeenSet()

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

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Definition at line 97 of file PutRestApiRequest.h.

◆ ParametersHasBeenSet()

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 169 of file PutRestApiRequest.h.

◆ RestApiIdHasBeenSet()

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

[Required] The string identifier of the associated RestApi.

Definition at line 54 of file PutRestApiRequest.h.

◆ SetFailOnWarnings()

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

A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

Definition at line 143 of file PutRestApiRequest.h.

◆ SetMode() [1/2]

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

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Definition at line 103 of file PutRestApiRequest.h.

◆ SetMode() [2/2]

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

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Definition at line 109 of file PutRestApiRequest.h.

◆ SetParameters() [1/2]

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 178 of file PutRestApiRequest.h.

◆ SetParameters() [2/2]

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 187 of file PutRestApiRequest.h.

◆ SetRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 59 of file PutRestApiRequest.h.

◆ SetRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 64 of file PutRestApiRequest.h.

◆ SetRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 69 of file PutRestApiRequest.h.

◆ WithFailOnWarnings()

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

A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

Definition at line 150 of file PutRestApiRequest.h.

◆ WithMode() [1/2]

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

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Definition at line 115 of file PutRestApiRequest.h.

◆ WithMode() [2/2]

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

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Definition at line 121 of file PutRestApiRequest.h.

◆ WithParameters() [1/2]

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 196 of file PutRestApiRequest.h.

◆ WithParameters() [2/2]

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api –parameters ignore=documentation –body 'file:///path/to/imported-api-body.json'.

Definition at line 205 of file PutRestApiRequest.h.

◆ WithRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 74 of file PutRestApiRequest.h.

◆ WithRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 79 of file PutRestApiRequest.h.

◆ WithRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 84 of file PutRestApiRequest.h.


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