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

Class PutIntegrationResponseResponse

    • Method Detail

      • statusCode

        public final String statusCode()

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

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

      • selectionPattern

        public final String selectionPattern()

        Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched.

        Returns:
        Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched.

      • hasResponseParameters

        public final boolean hasResponseParameters()
        For responses, this returns true if the service returned a value for the ResponseParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • responseParameters

        public final 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 is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResponseParameters() method.

        Returns:
        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 is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

      • hasResponseTemplates

        public final boolean hasResponseTemplates()
        For responses, this returns true if the service returned a value for the ResponseTemplates property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • responseTemplates

        public final Map<String,​String> responseTemplates()

        Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResponseTemplates() method.

        Returns:
        Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

      • contentHandling

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, contentHandling will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentHandlingAsString().

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

        See Also:
        ContentHandlingStrategy

      • contentHandlingAsString

        public final String contentHandlingAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, contentHandling will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentHandlingAsString().

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

        See Also:
        ContentHandlingStrategy

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object