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

#include <MethodResponse.h>

Public Member Functions

 MethodResponse ()
 
 MethodResponse (Aws::Utils::Json::JsonView jsonValue)
 
MethodResponseoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetStatusCode () const
 
bool StatusCodeHasBeenSet () const
 
void SetStatusCode (const Aws::String &value)
 
void SetStatusCode (Aws::String &&value)
 
void SetStatusCode (const char *value)
 
MethodResponseWithStatusCode (const Aws::String &value)
 
MethodResponseWithStatusCode (Aws::String &&value)
 
MethodResponseWithStatusCode (const char *value)
 
const Aws::Map< Aws::String, bool > & GetResponseParameters () const
 
bool ResponseParametersHasBeenSet () const
 
void SetResponseParameters (const Aws::Map< Aws::String, bool > &value)
 
void SetResponseParameters (Aws::Map< Aws::String, bool > &&value)
 
MethodResponseWithResponseParameters (const Aws::Map< Aws::String, bool > &value)
 
MethodResponseWithResponseParameters (Aws::Map< Aws::String, bool > &&value)
 
MethodResponseAddResponseParameters (const Aws::String &key, bool value)
 
MethodResponseAddResponseParameters (Aws::String &&key, bool value)
 
MethodResponseAddResponseParameters (const char *key, bool value)
 
const Aws::Map< Aws::String, Aws::String > & GetResponseModels () const
 
bool ResponseModelsHasBeenSet () const
 
void SetResponseModels (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetResponseModels (Aws::Map< Aws::String, Aws::String > &&value)
 
MethodResponseWithResponseModels (const Aws::Map< Aws::String, Aws::String > &value)
 
MethodResponseWithResponseModels (Aws::Map< Aws::String, Aws::String > &&value)
 
MethodResponseAddResponseModels (const Aws::String &key, const Aws::String &value)
 
MethodResponseAddResponseModels (Aws::String &&key, const Aws::String &value)
 
MethodResponseAddResponseModels (const Aws::String &key, Aws::String &&value)
 
MethodResponseAddResponseModels (Aws::String &&key, Aws::String &&value)
 
MethodResponseAddResponseModels (const char *key, Aws::String &&value)
 
MethodResponseAddResponseModels (Aws::String &&key, const char *value)
 
MethodResponseAddResponseModels (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 57 of file MethodResponse.h.

Constructor & Destructor Documentation

◆ MethodResponse() [1/2]

Aws::APIGateway::Model::MethodResponse::MethodResponse ( )

◆ MethodResponse() [2/2]

Aws::APIGateway::Model::MethodResponse::MethodResponse ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddResponseModels() [1/7]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 347 of file MethodResponse.h.

◆ AddResponseModels() [2/7]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 333 of file MethodResponse.h.

◆ AddResponseModels() [3/7]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 361 of file MethodResponse.h.

◆ AddResponseModels() [4/7]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 340 of file MethodResponse.h.

◆ AddResponseModels() [5/7]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 326 of file MethodResponse.h.

◆ AddResponseModels() [6/7]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 354 of file MethodResponse.h.

◆ AddResponseModels() [7/7]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 368 of file MethodResponse.h.

◆ AddResponseParameters() [1/3]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 257 of file MethodResponse.h.

◆ AddResponseParameters() [2/3]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 238 of file MethodResponse.h.

◆ AddResponseParameters() [3/3]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 276 of file MethodResponse.h.

◆ GetResponseModels()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::MethodResponse::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 284 of file MethodResponse.h.

◆ GetResponseParameters()

const Aws::Map<Aws::String, bool>& Aws::APIGateway::Model::MethodResponse::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 124 of file MethodResponse.h.

◆ GetStatusCode()

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

The method response's status code.

Definition at line 69 of file MethodResponse.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::MethodResponse::Jsonize ( ) const

◆ operator=()

MethodResponse& Aws::APIGateway::Model::MethodResponse::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ResponseModelsHasBeenSet()

bool Aws::APIGateway::Model::MethodResponse::ResponseModelsHasBeenSet ( ) 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 291 of file MethodResponse.h.

◆ ResponseParametersHasBeenSet()

bool Aws::APIGateway::Model::MethodResponse::ResponseParametersHasBeenSet ( ) 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 143 of file MethodResponse.h.

◆ SetResponseModels() [1/2]

void Aws::APIGateway::Model::MethodResponse::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 305 of file MethodResponse.h.

◆ SetResponseModels() [2/2]

void Aws::APIGateway::Model::MethodResponse::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 298 of file MethodResponse.h.

◆ SetResponseParameters() [1/2]

void Aws::APIGateway::Model::MethodResponse::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 181 of file MethodResponse.h.

◆ SetResponseParameters() [2/2]

void Aws::APIGateway::Model::MethodResponse::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 162 of file MethodResponse.h.

◆ SetStatusCode() [1/3]

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

The method response's status code.

Definition at line 84 of file MethodResponse.h.

◆ SetStatusCode() [2/3]

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

The method response's status code.

Definition at line 79 of file MethodResponse.h.

◆ SetStatusCode() [3/3]

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

The method response's status code.

Definition at line 89 of file MethodResponse.h.

◆ StatusCodeHasBeenSet()

bool Aws::APIGateway::Model::MethodResponse::StatusCodeHasBeenSet ( ) const
inline

The method response's status code.

Definition at line 74 of file MethodResponse.h.

◆ WithResponseModels() [1/2]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 319 of file MethodResponse.h.

◆ WithResponseModels() [2/2]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 312 of file MethodResponse.h.

◆ WithResponseParameters() [1/2]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 219 of file MethodResponse.h.

◆ WithResponseParameters() [2/2]

MethodResponse& Aws::APIGateway::Model::MethodResponse::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 200 of file MethodResponse.h.

◆ WithStatusCode() [1/3]

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

The method response's status code.

Definition at line 99 of file MethodResponse.h.

◆ WithStatusCode() [2/3]

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

The method response's status code.

Definition at line 94 of file MethodResponse.h.

◆ WithStatusCode() [3/3]

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

The method response's status code.

Definition at line 104 of file MethodResponse.h.


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