Struct aws_sdk_apigatewayv2::operation::create_integration_response::builders::CreateIntegrationResponseInputBuilder
source · #[non_exhaustive]pub struct CreateIntegrationResponseInputBuilder { /* private fields */ }
Expand description
A builder for CreateIntegrationResponseInput
.
Implementations§
source§impl CreateIntegrationResponseInputBuilder
impl CreateIntegrationResponseInputBuilder
sourcepub fn api_id(self, input: impl Into<String>) -> Self
pub fn api_id(self, input: impl Into<String>) -> Self
The API identifier.
This field is required.sourcepub fn set_api_id(self, input: Option<String>) -> Self
pub fn set_api_id(self, input: Option<String>) -> Self
The API identifier.
sourcepub fn get_api_id(&self) -> &Option<String>
pub fn get_api_id(&self) -> &Option<String>
The API identifier.
sourcepub fn content_handling_strategy(self, input: ContentHandlingStrategy) -> Self
pub fn content_handling_strategy(self, input: ContentHandlingStrategy) -> Self
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.
sourcepub fn set_content_handling_strategy(
self,
input: Option<ContentHandlingStrategy>
) -> Self
pub fn set_content_handling_strategy( self, input: Option<ContentHandlingStrategy> ) -> Self
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.
sourcepub fn get_content_handling_strategy(&self) -> &Option<ContentHandlingStrategy>
pub fn get_content_handling_strategy(&self) -> &Option<ContentHandlingStrategy>
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.
sourcepub fn integration_id(self, input: impl Into<String>) -> Self
pub fn integration_id(self, input: impl Into<String>) -> Self
The integration ID.
This field is required.sourcepub fn set_integration_id(self, input: Option<String>) -> Self
pub fn set_integration_id(self, input: Option<String>) -> Self
The integration ID.
sourcepub fn get_integration_id(&self) -> &Option<String>
pub fn get_integration_id(&self) -> &Option<String>
The integration ID.
sourcepub fn integration_response_key(self, input: impl Into<String>) -> Self
pub fn integration_response_key(self, input: impl Into<String>) -> Self
The integration response key.
This field is required.sourcepub fn set_integration_response_key(self, input: Option<String>) -> Self
pub fn set_integration_response_key(self, input: Option<String>) -> Self
The integration response key.
sourcepub fn get_integration_response_key(&self) -> &Option<String>
pub fn get_integration_response_key(&self) -> &Option<String>
The integration response key.
sourcepub fn response_parameters(
self,
k: impl Into<String>,
v: impl Into<String>
) -> Self
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.
sourcepub fn set_response_parameters(
self,
input: Option<HashMap<String, String>>
) -> Self
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.
sourcepub fn get_response_parameters(&self) -> &Option<HashMap<String, String>>
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.
sourcepub fn response_templates(
self,
k: impl Into<String>,
v: impl Into<String>
) -> Self
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.
sourcepub fn set_response_templates(
self,
input: Option<HashMap<String, String>>
) -> Self
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.
sourcepub fn get_response_templates(&self) -> &Option<HashMap<String, String>>
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.
sourcepub fn template_selection_expression(self, input: impl Into<String>) -> Self
pub fn template_selection_expression(self, input: impl Into<String>) -> Self
The template selection expression for the integration response. Supported only for WebSocket APIs.
sourcepub fn set_template_selection_expression(self, input: Option<String>) -> Self
pub fn set_template_selection_expression(self, input: Option<String>) -> Self
The template selection expression for the integration response. Supported only for WebSocket APIs.
sourcepub fn get_template_selection_expression(&self) -> &Option<String>
pub fn get_template_selection_expression(&self) -> &Option<String>
The template selection expression for the integration response. Supported only for WebSocket APIs.
sourcepub fn build(self) -> Result<CreateIntegrationResponseInput, BuildError>
pub fn build(self) -> Result<CreateIntegrationResponseInput, BuildError>
Consumes the builder and constructs a CreateIntegrationResponseInput
.
source§impl CreateIntegrationResponseInputBuilder
impl CreateIntegrationResponseInputBuilder
sourcepub async fn send_with(
self,
client: &Client
) -> Result<CreateIntegrationResponseOutput, SdkError<CreateIntegrationResponseError, HttpResponse>>
pub async fn send_with( self, client: &Client ) -> Result<CreateIntegrationResponseOutput, SdkError<CreateIntegrationResponseError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for CreateIntegrationResponseInputBuilder
impl Clone for CreateIntegrationResponseInputBuilder
source§fn clone(&self) -> CreateIntegrationResponseInputBuilder
fn clone(&self) -> CreateIntegrationResponseInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for CreateIntegrationResponseInputBuilder
impl Default for CreateIntegrationResponseInputBuilder
source§fn default() -> CreateIntegrationResponseInputBuilder
fn default() -> CreateIntegrationResponseInputBuilder
source§impl PartialEq for CreateIntegrationResponseInputBuilder
impl PartialEq for CreateIntegrationResponseInputBuilder
source§fn eq(&self, other: &CreateIntegrationResponseInputBuilder) -> bool
fn eq(&self, other: &CreateIntegrationResponseInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.