Struct aws_sdk_apigateway::types::builders::MethodResponseBuilder

#[non_exhaustive]
pub struct MethodResponseBuilder { /* private fields */ }

A builder for MethodResponse.

Implementations

impl MethodResponseBuilder

pub fn status_code(self, input: impl Into<String>) -> Self

The method response's status code.

pub fn set_status_code(self, input: Option<String>) -> Self

The method response's status code.

pub fn get_status_code(&self) -> &Option<String>

The method response's status code.

pub fn response_parameters(self, k: impl Into<String>, v: bool) -> Self

Adds a key-value pair to response_parameters.

To override the contents of this collection use set_response_parameters.

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.)

pub fn set_response_parameters( self, input: Option<HashMap<String, bool>> ) -> Self

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.)

pub fn get_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.)

pub fn response_models(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to response_models.

To override the contents of this collection use set_response_models.

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.

pub fn set_response_models(self, input: Option<HashMap<String, String>>) -> Self

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.

pub fn get_response_models(&self) -> &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.

pub fn build(self) -> MethodResponse

Consumes the builder and constructs a MethodResponse.

Trait Implementations

impl Clone for MethodResponseBuilder

fn clone(&self) -> MethodResponseBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MethodResponseBuilder

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

Formats the value using the given formatter.

impl Default for MethodResponseBuilder

fn default() -> MethodResponseBuilder

Returns the “default value” for a type.

impl PartialEq<MethodResponseBuilder> for MethodResponseBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for MethodResponseBuilder