Struct aws_sdk_apigatewayv2::operation::create_integration_response::builders::CreateIntegrationResponseOutputBuilder

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

A builder for CreateIntegrationResponseOutput.

Implementations

impl CreateIntegrationResponseOutputBuilder

pub fn content_handling_strategy(self, input: ContentHandlingStrategy) -> Self

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

pub fn set_content_handling_strategy( self, input: Option<ContentHandlingStrategy> ) -> Self

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

pub fn get_content_handling_strategy(&self) -> &Option<ContentHandlingStrategy>

Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

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

The integration response ID.

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

The integration response ID.

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

The integration response ID.

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

The integration response key.

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

The integration response key.

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

The integration response key.

pub fn response_parameters( self, k: impl Into<String>, v: impl Into<String> ) -> 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 response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

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

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

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

A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

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

Adds a key-value pair to response_templates.

To override the contents of this collection use set_response_templates.

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

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

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

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

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

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

The template selection expressions for the integration response.

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

The template selection expressions for the integration response.

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

The template selection expressions for the integration response.

pub fn build(self) -> CreateIntegrationResponseOutput

Consumes the builder and constructs a CreateIntegrationResponseOutput.

Trait Implementations

impl Clone for CreateIntegrationResponseOutputBuilder

fn clone(&self) -> CreateIntegrationResponseOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateIntegrationResponseOutputBuilder

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

Formats the value using the given formatter.

impl Default for CreateIntegrationResponseOutputBuilder

fn default() -> CreateIntegrationResponseOutputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateIntegrationResponseOutputBuilder

fn eq(&self, other: &CreateIntegrationResponseOutputBuilder) -> 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 CreateIntegrationResponseOutputBuilder