Package software.amazon.awssdk.services.apigateway.model

Interface PutIntegrationResponseRequest.Builder

    • Method Detail

      • restApiId

        PutIntegrationResponseRequest.Builder restApiId​(String restApiId)

        The string identifier of the associated RestApi.

        Parameters:
        restApiId - The string identifier of the associated RestApi.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceId

        PutIntegrationResponseRequest.Builder resourceId​(String resourceId)

        Specifies a put integration response request's resource identifier.

        Parameters:
        resourceId - Specifies a put integration response request's resource identifier.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • httpMethod

        PutIntegrationResponseRequest.Builder httpMethod​(String httpMethod)

        Specifies a put integration response request's HTTP method.

        Parameters:
        httpMethod - Specifies a put integration response request's HTTP method.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusCode

        PutIntegrationResponseRequest.Builder statusCode​(String statusCodeValue)

        Specifies the status code that is used to map the integration response to an existing MethodResponse.

        Parameters:
        statusCodeValue - Specifies the status code that is used to map the integration response to an existing MethodResponse.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • selectionPattern

        PutIntegrationResponseRequest.Builder selectionPattern​(String selectionPattern)

        Specifies the selection pattern of a put integration response.

        Parameters:
        selectionPattern - Specifies the selection pattern of a put integration response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • responseParameters

        PutIntegrationResponseRequest.Builder responseParameters​(Map<String,​String> responseParameters)

        A key-value map specifying response parameters that are passed to the method response from the back end. 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 must be a valid and unique response header name and JSON-expression 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 back end. 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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • responseTemplates

        PutIntegrationResponseRequest.Builder responseTemplates​(Map<String,​String> responseTemplates)

        Specifies a put integration response's templates.

        Parameters:
        responseTemplates - Specifies a put integration response's templates.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contentHandling

        PutIntegrationResponseRequest.Builder contentHandling​(String contentHandling)

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

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

        Parameters:
        contentHandling - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

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

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

      • contentHandling

        PutIntegrationResponseRequest.Builder contentHandling​(ContentHandlingStrategy contentHandling)

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

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

        Parameters:
        contentHandling - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

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

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