Class UpdateGatewayResponseResponse

    • Method Detail

      • responseTypeAsString

        public final String responseTypeAsString()

        The response type of the associated GatewayResponse.

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

        Returns:
        The response type of the associated GatewayResponse.
        See Also:
        GatewayResponseType
      • statusCode

        public final String statusCode()

        The HTTP status code for this GatewayResponse.

        Returns:
        The HTTP status code for this GatewayResponse.
      • 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()

        Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

        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:
        Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
      • 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()

        Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

        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:
        Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
      • defaultResponse

        public final Boolean defaultResponse()

        A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

        Returns:
        A Boolean flag to indicate whether this GatewayResponse is the default gateway response ( true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.
      • 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