class Amazonite::ApiGateway::PutMethodResponseRequest

Overview

Request to add a MethodResponse to an existing Method resource.

Included Modules

Defined in:

api_gateway/put_method_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, response_parameters : Hash(String, Bool) | Nil = nil, response_models : Hash(String, String) | Nil = nil) #

[View source]
def self.new(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 hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def http_method : String #

The HTTP verb of the Method resource.


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

The HTTP verb of the Method resource.


[View source]
def resource_id : String #

The Resource identifier for the Method resource.


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

The Resource identifier for the Method resource.


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

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.


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

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.


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

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 name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from 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.)


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

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 name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from 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.)


[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 status_code : String #

The method response's status code.


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

The method response's status code.


[View source]
def validate! : Nil #

[View source]