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

#include <CreateIntegrationResponseRequest.h>

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

Public Member Functions

 CreateIntegrationResponseRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () 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)
 
CreateIntegrationResponseRequestWithApiId (const Aws::String &value)
 
CreateIntegrationResponseRequestWithApiId (Aws::String &&value)
 
CreateIntegrationResponseRequestWithApiId (const char *value)
 
const ContentHandlingStrategyGetContentHandlingStrategy () const
 
bool ContentHandlingStrategyHasBeenSet () const
 
void SetContentHandlingStrategy (const ContentHandlingStrategy &value)
 
void SetContentHandlingStrategy (ContentHandlingStrategy &&value)
 
CreateIntegrationResponseRequestWithContentHandlingStrategy (const ContentHandlingStrategy &value)
 
CreateIntegrationResponseRequestWithContentHandlingStrategy (ContentHandlingStrategy &&value)
 
const Aws::StringGetIntegrationId () const
 
bool IntegrationIdHasBeenSet () const
 
void SetIntegrationId (const Aws::String &value)
 
void SetIntegrationId (Aws::String &&value)
 
void SetIntegrationId (const char *value)
 
CreateIntegrationResponseRequestWithIntegrationId (const Aws::String &value)
 
CreateIntegrationResponseRequestWithIntegrationId (Aws::String &&value)
 
CreateIntegrationResponseRequestWithIntegrationId (const char *value)
 
const Aws::StringGetIntegrationResponseKey () const
 
bool IntegrationResponseKeyHasBeenSet () const
 
void SetIntegrationResponseKey (const Aws::String &value)
 
void SetIntegrationResponseKey (Aws::String &&value)
 
void SetIntegrationResponseKey (const char *value)
 
CreateIntegrationResponseRequestWithIntegrationResponseKey (const Aws::String &value)
 
CreateIntegrationResponseRequestWithIntegrationResponseKey (Aws::String &&value)
 
CreateIntegrationResponseRequestWithIntegrationResponseKey (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetResponseParameters () const
 
bool ResponseParametersHasBeenSet () const
 
void SetResponseParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetResponseParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateIntegrationResponseRequestWithResponseParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateIntegrationResponseRequestWithResponseParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateIntegrationResponseRequestAddResponseParameters (const Aws::String &key, const Aws::String &value)
 
CreateIntegrationResponseRequestAddResponseParameters (Aws::String &&key, const Aws::String &value)
 
CreateIntegrationResponseRequestAddResponseParameters (const Aws::String &key, Aws::String &&value)
 
CreateIntegrationResponseRequestAddResponseParameters (Aws::String &&key, Aws::String &&value)
 
CreateIntegrationResponseRequestAddResponseParameters (const char *key, Aws::String &&value)
 
CreateIntegrationResponseRequestAddResponseParameters (Aws::String &&key, const char *value)
 
CreateIntegrationResponseRequestAddResponseParameters (const char *key, const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetResponseTemplates () const
 
bool ResponseTemplatesHasBeenSet () const
 
void SetResponseTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetResponseTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateIntegrationResponseRequestWithResponseTemplates (const Aws::Map< Aws::String, Aws::String > &value)
 
CreateIntegrationResponseRequestWithResponseTemplates (Aws::Map< Aws::String, Aws::String > &&value)
 
CreateIntegrationResponseRequestAddResponseTemplates (const Aws::String &key, const Aws::String &value)
 
CreateIntegrationResponseRequestAddResponseTemplates (Aws::String &&key, const Aws::String &value)
 
CreateIntegrationResponseRequestAddResponseTemplates (const Aws::String &key, Aws::String &&value)
 
CreateIntegrationResponseRequestAddResponseTemplates (Aws::String &&key, Aws::String &&value)
 
CreateIntegrationResponseRequestAddResponseTemplates (const char *key, Aws::String &&value)
 
CreateIntegrationResponseRequestAddResponseTemplates (Aws::String &&key, const char *value)
 
CreateIntegrationResponseRequestAddResponseTemplates (const char *key, const char *value)
 
const Aws::StringGetTemplateSelectionExpression () const
 
bool TemplateSelectionExpressionHasBeenSet () const
 
void SetTemplateSelectionExpression (const Aws::String &value)
 
void SetTemplateSelectionExpression (Aws::String &&value)
 
void SetTemplateSelectionExpression (const char *value)
 
CreateIntegrationResponseRequestWithTemplateSelectionExpression (const Aws::String &value)
 
CreateIntegrationResponseRequestWithTemplateSelectionExpression (Aws::String &&value)
 
CreateIntegrationResponseRequestWithTemplateSelectionExpression (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 AddQueryStringParameters (Aws::Http::URI &uri) const
 
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

Creates a new IntegrationResponse resource to represent an integration response.

See Also:

AWS API Reference

Definition at line 27 of file CreateIntegrationResponseRequest.h.

Constructor & Destructor Documentation

◆ CreateIntegrationResponseRequest()

Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::CreateIntegrationResponseRequest ( )

Member Function Documentation

◆ AddResponseParameters() [1/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseParameters ( const Aws::String key,
const Aws::String value 
)
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 340 of file CreateIntegrationResponseRequest.h.

◆ AddResponseParameters() [2/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 355 of file CreateIntegrationResponseRequest.h.

◆ AddResponseParameters() [3/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 370 of file CreateIntegrationResponseRequest.h.

◆ AddResponseParameters() [4/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 385 of file CreateIntegrationResponseRequest.h.

◆ AddResponseParameters() [5/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseParameters ( const char *  key,
Aws::String &&  value 
)
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 400 of file CreateIntegrationResponseRequest.h.

◆ AddResponseParameters() [6/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseParameters ( Aws::String &&  key,
const char *  value 
)
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 415 of file CreateIntegrationResponseRequest.h.

◆ AddResponseParameters() [7/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseParameters ( const char *  key,
const char *  value 
)
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 430 of file CreateIntegrationResponseRequest.h.

◆ AddResponseTemplates() [1/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseTemplates ( const Aws::String key,
const Aws::String value 
)
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 480 of file CreateIntegrationResponseRequest.h.

◆ AddResponseTemplates() [2/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseTemplates ( Aws::String &&  key,
const Aws::String value 
)
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 487 of file CreateIntegrationResponseRequest.h.

◆ AddResponseTemplates() [3/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseTemplates ( const Aws::String key,
Aws::String &&  value 
)
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 494 of file CreateIntegrationResponseRequest.h.

◆ AddResponseTemplates() [4/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseTemplates ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 501 of file CreateIntegrationResponseRequest.h.

◆ AddResponseTemplates() [5/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseTemplates ( const char *  key,
Aws::String &&  value 
)
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 508 of file CreateIntegrationResponseRequest.h.

◆ AddResponseTemplates() [6/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseTemplates ( Aws::String &&  key,
const char *  value 
)
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 515 of file CreateIntegrationResponseRequest.h.

◆ AddResponseTemplates() [7/7]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::AddResponseTemplates ( const char *  key,
const char *  value 
)
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 522 of file CreateIntegrationResponseRequest.h.

◆ ApiIdHasBeenSet()

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

The API identifier.

Definition at line 49 of file CreateIntegrationResponseRequest.h.

◆ ContentHandlingStrategyHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::ContentHandlingStrategyHasBeenSet ( ) const
inline

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Definition at line 104 of file CreateIntegrationResponseRequest.h.

◆ GetApiId()

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

The API identifier.

Definition at line 44 of file CreateIntegrationResponseRequest.h.

◆ GetContentHandlingStrategy()

const ContentHandlingStrategy& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::GetContentHandlingStrategy ( ) const
inline

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Definition at line 92 of file CreateIntegrationResponseRequest.h.

◆ GetIntegrationId()

const Aws::String& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::GetIntegrationId ( ) const
inline

The integration ID.

Definition at line 158 of file CreateIntegrationResponseRequest.h.

◆ GetIntegrationResponseKey()

const Aws::String& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::GetIntegrationResponseKey ( ) const
inline

The integration response key.

Definition at line 199 of file CreateIntegrationResponseRequest.h.

◆ GetResponseParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::GetResponseParameters ( ) const
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 250 of file CreateIntegrationResponseRequest.h.

◆ GetResponseTemplates()

const Aws::Map<Aws::String, Aws::String>& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::GetResponseTemplates ( ) const
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 438 of file CreateIntegrationResponseRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateIntegrationResponseRequest.h.

◆ GetTemplateSelectionExpression()

const Aws::String& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::GetTemplateSelectionExpression ( ) const
inline

The template selection expression for the integration response. Supported only for WebSocket APIs.

Definition at line 529 of file CreateIntegrationResponseRequest.h.

◆ IntegrationIdHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::IntegrationIdHasBeenSet ( ) const
inline

The integration ID.

Definition at line 163 of file CreateIntegrationResponseRequest.h.

◆ IntegrationResponseKeyHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::IntegrationResponseKeyHasBeenSet ( ) const
inline

The integration response key.

Definition at line 204 of file CreateIntegrationResponseRequest.h.

◆ ResponseParametersHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::ResponseParametersHasBeenSet ( ) const
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 265 of file CreateIntegrationResponseRequest.h.

◆ ResponseTemplatesHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::ResponseTemplatesHasBeenSet ( ) const
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 445 of file CreateIntegrationResponseRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApiId() [1/3]

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

The API identifier.

Definition at line 54 of file CreateIntegrationResponseRequest.h.

◆ SetApiId() [2/3]

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

The API identifier.

Definition at line 59 of file CreateIntegrationResponseRequest.h.

◆ SetApiId() [3/3]

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

The API identifier.

Definition at line 64 of file CreateIntegrationResponseRequest.h.

◆ SetContentHandlingStrategy() [1/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetContentHandlingStrategy ( const ContentHandlingStrategy value)
inline

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Definition at line 116 of file CreateIntegrationResponseRequest.h.

◆ SetContentHandlingStrategy() [2/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetContentHandlingStrategy ( ContentHandlingStrategy &&  value)
inline

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Definition at line 128 of file CreateIntegrationResponseRequest.h.

◆ SetIntegrationId() [1/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetIntegrationId ( const Aws::String value)
inline

The integration ID.

Definition at line 168 of file CreateIntegrationResponseRequest.h.

◆ SetIntegrationId() [2/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetIntegrationId ( Aws::String &&  value)
inline

The integration ID.

Definition at line 173 of file CreateIntegrationResponseRequest.h.

◆ SetIntegrationId() [3/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetIntegrationId ( const char *  value)
inline

The integration ID.

Definition at line 178 of file CreateIntegrationResponseRequest.h.

◆ SetIntegrationResponseKey() [1/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetIntegrationResponseKey ( const Aws::String value)
inline

The integration response key.

Definition at line 209 of file CreateIntegrationResponseRequest.h.

◆ SetIntegrationResponseKey() [2/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetIntegrationResponseKey ( Aws::String &&  value)
inline

The integration response key.

Definition at line 214 of file CreateIntegrationResponseRequest.h.

◆ SetIntegrationResponseKey() [3/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetIntegrationResponseKey ( const char *  value)
inline

The integration response key.

Definition at line 219 of file CreateIntegrationResponseRequest.h.

◆ SetResponseParameters() [1/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetResponseParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 280 of file CreateIntegrationResponseRequest.h.

◆ SetResponseParameters() [2/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetResponseParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 295 of file CreateIntegrationResponseRequest.h.

◆ SetResponseTemplates() [1/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetResponseTemplates ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 452 of file CreateIntegrationResponseRequest.h.

◆ SetResponseTemplates() [2/2]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetResponseTemplates ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 459 of file CreateIntegrationResponseRequest.h.

◆ SetTemplateSelectionExpression() [1/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetTemplateSelectionExpression ( const Aws::String value)
inline

The template selection expression for the integration response. Supported only for WebSocket APIs.

Definition at line 541 of file CreateIntegrationResponseRequest.h.

◆ SetTemplateSelectionExpression() [2/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetTemplateSelectionExpression ( Aws::String &&  value)
inline

The template selection expression for the integration response. Supported only for WebSocket APIs.

Definition at line 547 of file CreateIntegrationResponseRequest.h.

◆ SetTemplateSelectionExpression() [3/3]

void Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::SetTemplateSelectionExpression ( const char *  value)
inline

The template selection expression for the integration response. Supported only for WebSocket APIs.

Definition at line 553 of file CreateIntegrationResponseRequest.h.

◆ TemplateSelectionExpressionHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::TemplateSelectionExpressionHasBeenSet ( ) const
inline

The template selection expression for the integration response. Supported only for WebSocket APIs.

Definition at line 535 of file CreateIntegrationResponseRequest.h.

◆ WithApiId() [1/3]

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

The API identifier.

Definition at line 69 of file CreateIntegrationResponseRequest.h.

◆ WithApiId() [2/3]

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

The API identifier.

Definition at line 74 of file CreateIntegrationResponseRequest.h.

◆ WithApiId() [3/3]

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

The API identifier.

Definition at line 79 of file CreateIntegrationResponseRequest.h.

◆ WithContentHandlingStrategy() [1/2]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithContentHandlingStrategy ( const ContentHandlingStrategy value)
inline

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Definition at line 140 of file CreateIntegrationResponseRequest.h.

◆ WithContentHandlingStrategy() [2/2]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithContentHandlingStrategy ( ContentHandlingStrategy &&  value)
inline

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

Definition at line 152 of file CreateIntegrationResponseRequest.h.

◆ WithIntegrationId() [1/3]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithIntegrationId ( const Aws::String value)
inline

The integration ID.

Definition at line 183 of file CreateIntegrationResponseRequest.h.

◆ WithIntegrationId() [2/3]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithIntegrationId ( Aws::String &&  value)
inline

The integration ID.

Definition at line 188 of file CreateIntegrationResponseRequest.h.

◆ WithIntegrationId() [3/3]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithIntegrationId ( const char *  value)
inline

The integration ID.

Definition at line 193 of file CreateIntegrationResponseRequest.h.

◆ WithIntegrationResponseKey() [1/3]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithIntegrationResponseKey ( const Aws::String value)
inline

The integration response key.

Definition at line 224 of file CreateIntegrationResponseRequest.h.

◆ WithIntegrationResponseKey() [2/3]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithIntegrationResponseKey ( Aws::String &&  value)
inline

The integration response key.

Definition at line 229 of file CreateIntegrationResponseRequest.h.

◆ WithIntegrationResponseKey() [3/3]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithIntegrationResponseKey ( const char *  value)
inline

The integration response key.

Definition at line 234 of file CreateIntegrationResponseRequest.h.

◆ WithResponseParameters() [1/2]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithResponseParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 310 of file CreateIntegrationResponseRequest.h.

◆ WithResponseParameters() [2/2]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithResponseParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.

Definition at line 325 of file CreateIntegrationResponseRequest.h.

◆ WithResponseTemplates() [1/2]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithResponseTemplates ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 466 of file CreateIntegrationResponseRequest.h.

◆ WithResponseTemplates() [2/2]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithResponseTemplates ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Definition at line 473 of file CreateIntegrationResponseRequest.h.

◆ WithTemplateSelectionExpression() [1/3]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithTemplateSelectionExpression ( const Aws::String value)
inline

The template selection expression for the integration response. Supported only for WebSocket APIs.

Definition at line 559 of file CreateIntegrationResponseRequest.h.

◆ WithTemplateSelectionExpression() [2/3]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithTemplateSelectionExpression ( Aws::String &&  value)
inline

The template selection expression for the integration response. Supported only for WebSocket APIs.

Definition at line 565 of file CreateIntegrationResponseRequest.h.

◆ WithTemplateSelectionExpression() [3/3]

CreateIntegrationResponseRequest& Aws::ApiGatewayV2::Model::CreateIntegrationResponseRequest::WithTemplateSelectionExpression ( const char *  value)
inline

The template selection expression for the integration response. Supported only for WebSocket APIs.

Definition at line 571 of file CreateIntegrationResponseRequest.h.


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