#[non_exhaustive]pub struct GetMethodResponseOutput {
pub status_code: Option<String>,
pub response_parameters: Option<HashMap<String, bool>>,
pub response_models: Option<HashMap<String, String>>,
/* private fields */
}
Expand description
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.status_code: Option<String>
The method response's status code.
response_parameters: Option<HashMap<String, bool>>
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 and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}
, where name
is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include 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.)
response_models: Option<HashMap<String, String>>
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.
Implementations§
source§impl GetMethodResponseOutput
impl GetMethodResponseOutput
sourcepub fn status_code(&self) -> Option<&str>
pub fn status_code(&self) -> Option<&str>
The method response's status code.
sourcepub fn response_parameters(&self) -> Option<&HashMap<String, bool>>
pub fn response_parameters(&self) -> Option<&HashMap<String, bool>>
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 and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}
, where name
is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include 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.)
source§impl GetMethodResponseOutput
impl GetMethodResponseOutput
sourcepub fn builder() -> GetMethodResponseOutputBuilder
pub fn builder() -> GetMethodResponseOutputBuilder
Creates a new builder-style object to manufacture GetMethodResponseOutput
.
Trait Implementations§
source§impl Clone for GetMethodResponseOutput
impl Clone for GetMethodResponseOutput
source§fn clone(&self) -> GetMethodResponseOutput
fn clone(&self) -> GetMethodResponseOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for GetMethodResponseOutput
impl Debug for GetMethodResponseOutput
source§impl PartialEq for GetMethodResponseOutput
impl PartialEq for GetMethodResponseOutput
source§fn eq(&self, other: &GetMethodResponseOutput) -> bool
fn eq(&self, other: &GetMethodResponseOutput) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl RequestId for GetMethodResponseOutput
impl RequestId for GetMethodResponseOutput
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for GetMethodResponseOutput
Auto Trait Implementations§
impl Freeze for GetMethodResponseOutput
impl RefUnwindSafe for GetMethodResponseOutput
impl Send for GetMethodResponseOutput
impl Sync for GetMethodResponseOutput
impl Unpin for GetMethodResponseOutput
impl UnwindSafe for GetMethodResponseOutput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more