Package software.amazon.awssdk.services.apigatewayv2.model

Interface CreateIntegrationResponseRequest.Builder

All Superinterfaces:
ApiGatewayV2Request.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateIntegrationResponseRequest.Builder,CreateIntegrationResponseRequest>, SdkBuilder<CreateIntegrationResponseRequest.Builder,CreateIntegrationResponseRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateIntegrationResponseRequest
public static interface CreateIntegrationResponseRequest.Builder extends ApiGatewayV2Request.Builder, SdkPojo, CopyableBuilder<CreateIntegrationResponseRequest.Builder,CreateIntegrationResponseRequest>

  • Method Details

    • apiId

      CreateIntegrationResponseRequest.Builder apiId(String apiId)

      The API identifier.

      Parameters:
      apiId - The API identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentHandlingStrategy

      CreateIntegrationResponseRequest.Builder contentHandlingStrategy(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contentHandlingStrategy

      CreateIntegrationResponseRequest.Builder contentHandlingStrategy(ContentHandlingStrategy 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • integrationId

      CreateIntegrationResponseRequest.Builder integrationId(String integrationId)

      The integration ID.

      Parameters:
      integrationId - The integration ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • integrationResponseKey

      CreateIntegrationResponseRequest.Builder integrationResponseKey(String integrationResponseKey)

      The integration response key.

      Parameters:
      integrationResponseKey - The integration response key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • responseParameters

      CreateIntegrationResponseRequest.Builder responseParameters(Map<String,String> responseParameters)

      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.

      Parameters:
      responseParameters - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • responseTemplates

      CreateIntegrationResponseRequest.Builder responseTemplates(Map<String,String> responseTemplates)

      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.

      Parameters:
      responseTemplates - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateSelectionExpression

      CreateIntegrationResponseRequest.Builder templateSelectionExpression(String templateSelectionExpression)

      The template selection expression for the integration response. Supported only for WebSocket APIs.

      Parameters:
      templateSelectionExpression - The template selection expression for the integration response. Supported only for WebSocket APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateIntegrationResponseRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateIntegrationResponseRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.