Struct GatewayResponse

#[non_exhaustive]
pub struct GatewayResponse {
    pub response_type: Option<GatewayResponseType>,
    pub status_code: Option<String>,
    pub response_parameters: Option<HashMap<String, String>>,
    pub response_templates: Option<HashMap<String, String>>,
    pub default_response: bool,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

response_type: Option<GatewayResponseType>

The response type of the associated GatewayResponse.

status_code: Option<String>

The HTTP status code for this GatewayResponse.

response_parameters: Option<HashMap<String, String>>

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

response_templates: Option<HashMap<String, String>>

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

default_response: bool

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

Implementations

impl GatewayResponse

pub fn response_type(&self) -> Option<&GatewayResponseType>

The response type of the associated GatewayResponse.

pub fn status_code(&self) -> Option<&str>

The HTTP status code for this GatewayResponse.

pub fn response_parameters(&self) -> Option<&HashMap<String, String>>

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

pub fn response_templates(&self) -> Option<&HashMap<String, String>>

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

pub fn default_response(&self) -> bool

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

impl GatewayResponse

pub fn builder() -> GatewayResponseBuilder

Creates a new builder-style object to manufacture GatewayResponse.

Trait Implementations

impl Clone for GatewayResponse

fn clone(&self) -> GatewayResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GatewayResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GatewayResponse

fn eq(&self, other: &GatewayResponse) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GatewayResponse