/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace APIGateway { namespace Model { /** *

Represents a put integration response request.

See Also:

AWS * API Reference

*/ class PutIntegrationResponseRequest : public APIGatewayRequest { public: AWS_APIGATEWAY_API PutIntegrationResponseRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "PutIntegrationResponse"; } AWS_APIGATEWAY_API Aws::String SerializePayload() const override; /** *

The string identifier of the associated RestApi.

*/ inline const Aws::String& GetRestApiId() const{ return m_restApiId; } /** *

The string identifier of the associated RestApi.

*/ inline bool RestApiIdHasBeenSet() const { return m_restApiIdHasBeenSet; } /** *

The string identifier of the associated RestApi.

*/ inline void SetRestApiId(const Aws::String& value) { m_restApiIdHasBeenSet = true; m_restApiId = value; } /** *

The string identifier of the associated RestApi.

*/ inline void SetRestApiId(Aws::String&& value) { m_restApiIdHasBeenSet = true; m_restApiId = std::move(value); } /** *

The string identifier of the associated RestApi.

*/ inline void SetRestApiId(const char* value) { m_restApiIdHasBeenSet = true; m_restApiId.assign(value); } /** *

The string identifier of the associated RestApi.

*/ inline PutIntegrationResponseRequest& WithRestApiId(const Aws::String& value) { SetRestApiId(value); return *this;} /** *

The string identifier of the associated RestApi.

*/ inline PutIntegrationResponseRequest& WithRestApiId(Aws::String&& value) { SetRestApiId(std::move(value)); return *this;} /** *

The string identifier of the associated RestApi.

*/ inline PutIntegrationResponseRequest& WithRestApiId(const char* value) { SetRestApiId(value); return *this;} /** *

Specifies a put integration response request's resource identifier.

*/ inline const Aws::String& GetResourceId() const{ return m_resourceId; } /** *

Specifies a put integration response request's resource identifier.

*/ inline bool ResourceIdHasBeenSet() const { return m_resourceIdHasBeenSet; } /** *

Specifies a put integration response request's resource identifier.

*/ inline void SetResourceId(const Aws::String& value) { m_resourceIdHasBeenSet = true; m_resourceId = value; } /** *

Specifies a put integration response request's resource identifier.

*/ inline void SetResourceId(Aws::String&& value) { m_resourceIdHasBeenSet = true; m_resourceId = std::move(value); } /** *

Specifies a put integration response request's resource identifier.

*/ inline void SetResourceId(const char* value) { m_resourceIdHasBeenSet = true; m_resourceId.assign(value); } /** *

Specifies a put integration response request's resource identifier.

*/ inline PutIntegrationResponseRequest& WithResourceId(const Aws::String& value) { SetResourceId(value); return *this;} /** *

Specifies a put integration response request's resource identifier.

*/ inline PutIntegrationResponseRequest& WithResourceId(Aws::String&& value) { SetResourceId(std::move(value)); return *this;} /** *

Specifies a put integration response request's resource identifier.

*/ inline PutIntegrationResponseRequest& WithResourceId(const char* value) { SetResourceId(value); return *this;} /** *

Specifies a put integration response request's HTTP method.

*/ inline const Aws::String& GetHttpMethod() const{ return m_httpMethod; } /** *

Specifies a put integration response request's HTTP method.

*/ inline bool HttpMethodHasBeenSet() const { return m_httpMethodHasBeenSet; } /** *

Specifies a put integration response request's HTTP method.

*/ inline void SetHttpMethod(const Aws::String& value) { m_httpMethodHasBeenSet = true; m_httpMethod = value; } /** *

Specifies a put integration response request's HTTP method.

*/ inline void SetHttpMethod(Aws::String&& value) { m_httpMethodHasBeenSet = true; m_httpMethod = std::move(value); } /** *

Specifies a put integration response request's HTTP method.

*/ inline void SetHttpMethod(const char* value) { m_httpMethodHasBeenSet = true; m_httpMethod.assign(value); } /** *

Specifies a put integration response request's HTTP method.

*/ inline PutIntegrationResponseRequest& WithHttpMethod(const Aws::String& value) { SetHttpMethod(value); return *this;} /** *

Specifies a put integration response request's HTTP method.

*/ inline PutIntegrationResponseRequest& WithHttpMethod(Aws::String&& value) { SetHttpMethod(std::move(value)); return *this;} /** *

Specifies a put integration response request's HTTP method.

*/ inline PutIntegrationResponseRequest& WithHttpMethod(const char* value) { SetHttpMethod(value); return *this;} /** *

Specifies the status code that is used to map the integration response to an * existing MethodResponse.

*/ inline const Aws::String& GetStatusCode() const{ return m_statusCode; } /** *

Specifies the status code that is used to map the integration response to an * existing MethodResponse.

*/ inline bool StatusCodeHasBeenSet() const { return m_statusCodeHasBeenSet; } /** *

Specifies the status code that is used to map the integration response to an * existing MethodResponse.

*/ inline void SetStatusCode(const Aws::String& value) { m_statusCodeHasBeenSet = true; m_statusCode = value; } /** *

Specifies the status code that is used to map the integration response to an * existing MethodResponse.

*/ inline void SetStatusCode(Aws::String&& value) { m_statusCodeHasBeenSet = true; m_statusCode = std::move(value); } /** *

Specifies the status code that is used to map the integration response to an * existing MethodResponse.

*/ inline void SetStatusCode(const char* value) { m_statusCodeHasBeenSet = true; m_statusCode.assign(value); } /** *

Specifies the status code that is used to map the integration response to an * existing MethodResponse.

*/ inline PutIntegrationResponseRequest& WithStatusCode(const Aws::String& value) { SetStatusCode(value); return *this;} /** *

Specifies the status code that is used to map the integration response to an * existing MethodResponse.

*/ inline PutIntegrationResponseRequest& WithStatusCode(Aws::String&& value) { SetStatusCode(std::move(value)); return *this;} /** *

Specifies the status code that is used to map the integration response to an * existing MethodResponse.

*/ inline PutIntegrationResponseRequest& WithStatusCode(const char* value) { SetStatusCode(value); return *this;} /** *

Specifies the selection pattern of a put integration response.

*/ inline const Aws::String& GetSelectionPattern() const{ return m_selectionPattern; } /** *

Specifies the selection pattern of a put integration response.

*/ inline bool SelectionPatternHasBeenSet() const { return m_selectionPatternHasBeenSet; } /** *

Specifies the selection pattern of a put integration response.

*/ inline void SetSelectionPattern(const Aws::String& value) { m_selectionPatternHasBeenSet = true; m_selectionPattern = value; } /** *

Specifies the selection pattern of a put integration response.

*/ inline void SetSelectionPattern(Aws::String&& value) { m_selectionPatternHasBeenSet = true; m_selectionPattern = std::move(value); } /** *

Specifies the selection pattern of a put integration response.

*/ inline void SetSelectionPattern(const char* value) { m_selectionPatternHasBeenSet = true; m_selectionPattern.assign(value); } /** *

Specifies the selection pattern of a put integration response.

*/ inline PutIntegrationResponseRequest& WithSelectionPattern(const Aws::String& value) { SetSelectionPattern(value); return *this;} /** *

Specifies the selection pattern of a put integration response.

*/ inline PutIntegrationResponseRequest& WithSelectionPattern(Aws::String&& value) { SetSelectionPattern(std::move(value)); return *this;} /** *

Specifies the selection pattern of a put integration response.

*/ inline PutIntegrationResponseRequest& WithSelectionPattern(const char* value) { SetSelectionPattern(value); return *this;} /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline const Aws::Map& GetResponseParameters() const{ return m_responseParameters; } /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline bool ResponseParametersHasBeenSet() const { return m_responseParametersHasBeenSet; } /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline void SetResponseParameters(const Aws::Map& value) { m_responseParametersHasBeenSet = true; m_responseParameters = value; } /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline void SetResponseParameters(Aws::Map&& value) { m_responseParametersHasBeenSet = true; m_responseParameters = std::move(value); } /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline PutIntegrationResponseRequest& WithResponseParameters(const Aws::Map& value) { SetResponseParameters(value); return *this;} /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline PutIntegrationResponseRequest& WithResponseParameters(Aws::Map&& value) { SetResponseParameters(std::move(value)); return *this;} /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline PutIntegrationResponseRequest& AddResponseParameters(const Aws::String& key, const Aws::String& value) { m_responseParametersHasBeenSet = true; m_responseParameters.emplace(key, value); return *this; } /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline PutIntegrationResponseRequest& AddResponseParameters(Aws::String&& key, const Aws::String& value) { m_responseParametersHasBeenSet = true; m_responseParameters.emplace(std::move(key), value); return *this; } /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline PutIntegrationResponseRequest& AddResponseParameters(const Aws::String& key, Aws::String&& value) { m_responseParametersHasBeenSet = true; m_responseParameters.emplace(key, std::move(value)); return *this; } /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline PutIntegrationResponseRequest& AddResponseParameters(Aws::String&& key, Aws::String&& value) { m_responseParametersHasBeenSet = true; m_responseParameters.emplace(std::move(key), std::move(value)); return *this; } /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline PutIntegrationResponseRequest& AddResponseParameters(const char* key, Aws::String&& value) { m_responseParametersHasBeenSet = true; m_responseParameters.emplace(key, std::move(value)); return *this; } /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline PutIntegrationResponseRequest& AddResponseParameters(Aws::String&& key, const char* value) { m_responseParametersHasBeenSet = true; m_responseParameters.emplace(std::move(key), value); return *this; } /** *

A key-value map specifying response parameters that are passed to the method * response from the back end. 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 must be a valid and unique response header name and * JSON-expression a valid JSON expression without the $ * prefix.

*/ inline PutIntegrationResponseRequest& AddResponseParameters(const char* key, const char* value) { m_responseParametersHasBeenSet = true; m_responseParameters.emplace(key, value); return *this; } /** *

Specifies a put integration response's templates.

*/ inline const Aws::Map& GetResponseTemplates() const{ return m_responseTemplates; } /** *

Specifies a put integration response's templates.

*/ inline bool ResponseTemplatesHasBeenSet() const { return m_responseTemplatesHasBeenSet; } /** *

Specifies a put integration response's templates.

*/ inline void SetResponseTemplates(const Aws::Map& value) { m_responseTemplatesHasBeenSet = true; m_responseTemplates = value; } /** *

Specifies a put integration response's templates.

*/ inline void SetResponseTemplates(Aws::Map&& value) { m_responseTemplatesHasBeenSet = true; m_responseTemplates = std::move(value); } /** *

Specifies a put integration response's templates.

*/ inline PutIntegrationResponseRequest& WithResponseTemplates(const Aws::Map& value) { SetResponseTemplates(value); return *this;} /** *

Specifies a put integration response's templates.

*/ inline PutIntegrationResponseRequest& WithResponseTemplates(Aws::Map&& value) { SetResponseTemplates(std::move(value)); return *this;} /** *

Specifies a put integration response's templates.

*/ inline PutIntegrationResponseRequest& AddResponseTemplates(const Aws::String& key, const Aws::String& value) { m_responseTemplatesHasBeenSet = true; m_responseTemplates.emplace(key, value); return *this; } /** *

Specifies a put integration response's templates.

*/ inline PutIntegrationResponseRequest& AddResponseTemplates(Aws::String&& key, const Aws::String& value) { m_responseTemplatesHasBeenSet = true; m_responseTemplates.emplace(std::move(key), value); return *this; } /** *

Specifies a put integration response's templates.

*/ inline PutIntegrationResponseRequest& AddResponseTemplates(const Aws::String& key, Aws::String&& value) { m_responseTemplatesHasBeenSet = true; m_responseTemplates.emplace(key, std::move(value)); return *this; } /** *

Specifies a put integration response's templates.

*/ inline PutIntegrationResponseRequest& AddResponseTemplates(Aws::String&& key, Aws::String&& value) { m_responseTemplatesHasBeenSet = true; m_responseTemplates.emplace(std::move(key), std::move(value)); return *this; } /** *

Specifies a put integration response's templates.

*/ inline PutIntegrationResponseRequest& AddResponseTemplates(const char* key, Aws::String&& value) { m_responseTemplatesHasBeenSet = true; m_responseTemplates.emplace(key, std::move(value)); return *this; } /** *

Specifies a put integration response's templates.

*/ inline PutIntegrationResponseRequest& AddResponseTemplates(Aws::String&& key, const char* value) { m_responseTemplatesHasBeenSet = true; m_responseTemplates.emplace(std::move(key), value); return *this; } /** *

Specifies a put integration response's templates.

*/ inline PutIntegrationResponseRequest& AddResponseTemplates(const char* key, const char* value) { m_responseTemplatesHasBeenSet = true; m_responseTemplates.emplace(key, value); return *this; } /** *

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

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

*/ inline const ContentHandlingStrategy& GetContentHandling() const{ return m_contentHandling; } /** *

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

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

*/ inline bool ContentHandlingHasBeenSet() const { return m_contentHandlingHasBeenSet; } /** *

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

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

*/ inline void SetContentHandling(const ContentHandlingStrategy& value) { m_contentHandlingHasBeenSet = true; m_contentHandling = value; } /** *

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

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

*/ inline void SetContentHandling(ContentHandlingStrategy&& value) { m_contentHandlingHasBeenSet = true; m_contentHandling = std::move(value); } /** *

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

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

*/ inline PutIntegrationResponseRequest& WithContentHandling(const ContentHandlingStrategy& value) { SetContentHandling(value); return *this;} /** *

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

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

*/ inline PutIntegrationResponseRequest& WithContentHandling(ContentHandlingStrategy&& value) { SetContentHandling(std::move(value)); return *this;} private: Aws::String m_restApiId; bool m_restApiIdHasBeenSet = false; Aws::String m_resourceId; bool m_resourceIdHasBeenSet = false; Aws::String m_httpMethod; bool m_httpMethodHasBeenSet = false; Aws::String m_statusCode; bool m_statusCodeHasBeenSet = false; Aws::String m_selectionPattern; bool m_selectionPatternHasBeenSet = false; Aws::Map m_responseParameters; bool m_responseParametersHasBeenSet = false; Aws::Map m_responseTemplates; bool m_responseTemplatesHasBeenSet = false; ContentHandlingStrategy m_contentHandling; bool m_contentHandlingHasBeenSet = false; }; } // namespace Model } // namespace APIGateway } // namespace Aws