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

#include <UpdateMethodResponseResult.h>

Public Member Functions

 UpdateMethodResponseResult ()
 
 UpdateMethodResponseResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
UpdateMethodResponseResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetStatusCode () const
 
void SetStatusCode (const Aws::String &value)
 
void SetStatusCode (Aws::String &&value)
 
void SetStatusCode (const char *value)
 
UpdateMethodResponseResultWithStatusCode (const Aws::String &value)
 
UpdateMethodResponseResultWithStatusCode (Aws::String &&value)
 
UpdateMethodResponseResultWithStatusCode (const char *value)
 
const Aws::Map< Aws::String, bool > & GetResponseParameters () const
 
void SetResponseParameters (const Aws::Map< Aws::String, bool > &value)
 
void SetResponseParameters (Aws::Map< Aws::String, bool > &&value)
 
UpdateMethodResponseResultWithResponseParameters (const Aws::Map< Aws::String, bool > &value)
 
UpdateMethodResponseResultWithResponseParameters (Aws::Map< Aws::String, bool > &&value)
 
UpdateMethodResponseResultAddResponseParameters (const Aws::String &key, bool value)
 
UpdateMethodResponseResultAddResponseParameters (Aws::String &&key, bool value)
 
UpdateMethodResponseResultAddResponseParameters (const char *key, bool value)
 
const Aws::Map< Aws::String, Aws::String > & GetResponseModels () const
 
void SetResponseModels (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetResponseModels (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateMethodResponseResultWithResponseModels (const Aws::Map< Aws::String, Aws::String > &value)
 
UpdateMethodResponseResultWithResponseModels (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateMethodResponseResultAddResponseModels (const Aws::String &key, const Aws::String &value)
 
UpdateMethodResponseResultAddResponseModels (Aws::String &&key, const Aws::String &value)
 
UpdateMethodResponseResultAddResponseModels (const Aws::String &key, Aws::String &&value)
 
UpdateMethodResponseResultAddResponseModels (Aws::String &&key, Aws::String &&value)
 
UpdateMethodResponseResultAddResponseModels (const char *key, Aws::String &&value)
 
UpdateMethodResponseResultAddResponseModels (Aws::String &&key, const char *value)
 
UpdateMethodResponseResultAddResponseModels (const char *key, const char *value)
 

Detailed Description

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

Example: A MethodResponse instance of an API

Request
The example request retrieves a MethodResponse of the 200 status code.
GET
/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256
Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns 200 OK status and a payload as follows:
{ "_links": { "curies": { "href":
"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
"name": "methodresponse", "templated": true }, "self": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title":
"200" }, "methodresponse:delete": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" },
"methodresponse:update": { "href":
"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } },
"responseModels": { "application/json": "Empty" }, "responseParameters": {
"method.response.header.Content-Type": false }, "statusCode": "200"
}

See Also:

AWS API Reference

Definition at line 58 of file UpdateMethodResponseResult.h.

Constructor & Destructor Documentation

◆ UpdateMethodResponseResult() [1/2]

Aws::APIGateway::Model::UpdateMethodResponseResult::UpdateMethodResponseResult ( )

◆ UpdateMethodResponseResult() [2/2]

Aws::APIGateway::Model::UpdateMethodResponseResult::UpdateMethodResponseResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddResponseModels() [1/7]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::AddResponseModels ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Definition at line 316 of file UpdateMethodResponseResult.h.

◆ AddResponseModels() [2/7]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::AddResponseModels ( Aws::String &&  key,
const Aws::String value 
)
inline

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Definition at line 302 of file UpdateMethodResponseResult.h.

◆ AddResponseModels() [3/7]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::AddResponseModels ( Aws::String &&  key,
const char *  value 
)
inline

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Definition at line 330 of file UpdateMethodResponseResult.h.

◆ AddResponseModels() [4/7]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::AddResponseModels ( const Aws::String key,
Aws::String &&  value 
)
inline

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Definition at line 309 of file UpdateMethodResponseResult.h.

◆ AddResponseModels() [5/7]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::AddResponseModels ( const Aws::String key,
const Aws::String value 
)
inline

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Definition at line 295 of file UpdateMethodResponseResult.h.

◆ AddResponseModels() [6/7]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::AddResponseModels ( const char *  key,
Aws::String &&  value 
)
inline

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Definition at line 323 of file UpdateMethodResponseResult.h.

◆ AddResponseModels() [7/7]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::AddResponseModels ( const char *  key,
const char *  value 
)
inline

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Definition at line 337 of file UpdateMethodResponseResult.h.

◆ AddResponseParameters() [1/3]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::AddResponseParameters ( Aws::String &&  key,
bool  value 
)
inline

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Definition at line 233 of file UpdateMethodResponseResult.h.

◆ AddResponseParameters() [2/3]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::AddResponseParameters ( const Aws::String key,
bool  value 
)
inline

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Definition at line 214 of file UpdateMethodResponseResult.h.

◆ AddResponseParameters() [3/3]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::AddResponseParameters ( const char *  key,
bool  value 
)
inline

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Definition at line 252 of file UpdateMethodResponseResult.h.

◆ GetResponseModels()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::UpdateMethodResponseResult::GetResponseModels ( ) const
inline

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Definition at line 260 of file UpdateMethodResponseResult.h.

◆ GetResponseParameters()

const Aws::Map<Aws::String, bool>& Aws::APIGateway::Model::UpdateMethodResponseResult::GetResponseParameters ( ) const
inline

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Definition at line 119 of file UpdateMethodResponseResult.h.

◆ GetStatusCode()

const Aws::String& Aws::APIGateway::Model::UpdateMethodResponseResult::GetStatusCode ( ) const
inline

The method response's status code.

Definition at line 69 of file UpdateMethodResponseResult.h.

◆ operator=()

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetResponseModels() [1/2]

void Aws::APIGateway::Model::UpdateMethodResponseResult::SetResponseModels ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Definition at line 274 of file UpdateMethodResponseResult.h.

◆ SetResponseModels() [2/2]

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

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Definition at line 267 of file UpdateMethodResponseResult.h.

◆ SetResponseParameters() [1/2]

void Aws::APIGateway::Model::UpdateMethodResponseResult::SetResponseParameters ( Aws::Map< Aws::String, bool > &&  value)
inline

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Definition at line 157 of file UpdateMethodResponseResult.h.

◆ SetResponseParameters() [2/2]

void Aws::APIGateway::Model::UpdateMethodResponseResult::SetResponseParameters ( const Aws::Map< Aws::String, bool > &  value)
inline

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Definition at line 138 of file UpdateMethodResponseResult.h.

◆ SetStatusCode() [1/3]

void Aws::APIGateway::Model::UpdateMethodResponseResult::SetStatusCode ( Aws::String &&  value)
inline

The method response's status code.

Definition at line 79 of file UpdateMethodResponseResult.h.

◆ SetStatusCode() [2/3]

void Aws::APIGateway::Model::UpdateMethodResponseResult::SetStatusCode ( const Aws::String value)
inline

The method response's status code.

Definition at line 74 of file UpdateMethodResponseResult.h.

◆ SetStatusCode() [3/3]

void Aws::APIGateway::Model::UpdateMethodResponseResult::SetStatusCode ( const char *  value)
inline

The method response's status code.

Definition at line 84 of file UpdateMethodResponseResult.h.

◆ WithResponseModels() [1/2]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::WithResponseModels ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Definition at line 288 of file UpdateMethodResponseResult.h.

◆ WithResponseModels() [2/2]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::WithResponseModels ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

Definition at line 281 of file UpdateMethodResponseResult.h.

◆ WithResponseParameters() [1/2]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::WithResponseParameters ( Aws::Map< Aws::String, bool > &&  value)
inline

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Definition at line 195 of file UpdateMethodResponseResult.h.

◆ WithResponseParameters() [2/2]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::WithResponseParameters ( const Aws::Map< Aws::String, bool > &  value)
inline

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Definition at line 176 of file UpdateMethodResponseResult.h.

◆ WithStatusCode() [1/3]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::WithStatusCode ( Aws::String &&  value)
inline

The method response's status code.

Definition at line 94 of file UpdateMethodResponseResult.h.

◆ WithStatusCode() [2/3]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::WithStatusCode ( const Aws::String value)
inline

The method response's status code.

Definition at line 89 of file UpdateMethodResponseResult.h.

◆ WithStatusCode() [3/3]

UpdateMethodResponseResult& Aws::APIGateway::Model::UpdateMethodResponseResult::WithStatusCode ( const char *  value)
inline

The method response's status code.

Definition at line 99 of file UpdateMethodResponseResult.h.


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