class Amazonite::ApiGateway::PutIntegrationResponseRequest

Overview

Represents a put integration response request.

Included Modules

Defined in:

api_gateway/put_integration_response_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(rest_api_id : String, resource_id : String, http_method : String, status_code : String, selection_pattern : String | Nil = nil, response_parameters : Hash(String, String) | Nil = nil, response_templates : Hash(String, String) | Nil = nil, content_handling : ContentHandlingStrategy | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def content_handling : ContentHandlingStrategy | Nil #

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.


[View source]
def content_handling=(content_handling : ContentHandlingStrategy | Nil) #

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.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def http_method : String #

Specifies a put integration response request's HTTP method.


[View source]
def http_method=(http_method : String) #

Specifies a put integration response request's HTTP method.


[View source]
def resource_id : String #

Specifies a put integration response request's resource identifier.


[View source]
def resource_id=(resource_id : String) #

Specifies a put integration response request's resource identifier.


[View source]
def response_parameters : Hash(String, String) | Nil #

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.


[View source]
def response_parameters=(response_parameters : Hash(String, String) | Nil) #

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.


[View source]
def response_templates : Hash(String, String) | Nil #

Specifies a put integration response's templates.


[View source]
def response_templates=(response_templates : Hash(String, String) | Nil) #

Specifies a put integration response's templates.


[View source]
def rest_api_id : String #

The string identifier of the associated RestApi.


[View source]
def rest_api_id=(rest_api_id : String) #

The string identifier of the associated RestApi.


[View source]
def selection_pattern : String | Nil #

Specifies the selection pattern of a put integration response.


[View source]
def selection_pattern=(selection_pattern : String | Nil) #

Specifies the selection pattern of a put integration response.


[View source]
def status_code : String #

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


[View source]
def status_code=(status_code : String) #

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


[View source]
def validate! : Nil #

[View source]