Struct PutMethodResponseInputBuilder

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

A builder for PutMethodResponseInput.

Implementations

impl PutMethodResponseInputBuilder

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

The string identifier of the associated RestApi.

This field is required.

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

The string identifier of the associated RestApi.

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

The string identifier of the associated RestApi.

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

The Resource identifier for the Method resource.

This field is required.

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

The Resource identifier for the Method resource.

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

The Resource identifier for the Method resource.

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

The HTTP verb of the Method resource.

This field is required.

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

The HTTP verb of the Method resource.

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

The HTTP verb of the Method resource.

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

The method response's status code.

This field is required.

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

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

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

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) -> Result<PutMethodResponseInput, BuildError>

Consumes the builder and constructs a PutMethodResponseInput.

impl PutMethodResponseInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<PutMethodResponseOutput, SdkError<PutMethodResponseError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for PutMethodResponseInputBuilder

fn clone(&self) -> PutMethodResponseInputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PutMethodResponseInputBuilder

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

Formats the value using the given formatter.

impl Default for PutMethodResponseInputBuilder

fn default() -> PutMethodResponseInputBuilder

Returns the “default value” for a type.

impl PartialEq for PutMethodResponseInputBuilder

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

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

const 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 PutMethodResponseInputBuilder