class Amazonite::ApiGateway::GatewayResponse

• Amazonite::ApiGateway::GatewayResponse
• Reference
• Object

Overview

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

Included Modules

• JSON::Serializable

Defined in:

api_gateway/gateway_response.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(response_type : GatewayResponseType | Nil = nil, status_code : String | Nil = nil, response_parameters : Hash(String, String) | Nil = nil, response_templates : Hash(String, String) | Nil = nil, default_response : Bool | Nil = nil)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #default_response : Bool | Nil

  A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false).

• #default_response=(default_response : Bool | Nil)

  A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false).

• #hash(hasher)

  See Object#hash(hasher)

• #response_parameters : Hash(String, String) | Nil

  Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

• #response_parameters=(response_parameters : Hash(String, String) | Nil)

  Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

• #response_templates : Hash(String, String) | Nil

  Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

• #response_templates=(response_templates : Hash(String, String) | Nil)

  Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

• #response_type : GatewayResponseType | Nil

  The response type of the associated GatewayResponse.

• #response_type=(response_type : GatewayResponseType | Nil)

  The response type of the associated GatewayResponse.

• #status_code : String | Nil

  The HTTP status code for this GatewayResponse.

• #status_code=(status_code : String | Nil)

  The HTTP status code for this GatewayResponse.

• #validate! : Nil

Constructor Detail

Instance Method Detail