Annotation Type HttpOutput


  • @Retention(RUNTIME)
    @Target({PARAMETER,METHOD})
    public @interface HttpOutput

    Place this on a parameter whose value would be send back to the user as an HTTP response. The parameter type should be OutputBinding<T>, where T could be one of:

    • HttpResponseMessage
    • Any native Java types such as int, String, byte[]
    • Any POJO type
    Since:
    1.0.0
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      The variable name used in function.json.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String dataType
      Defines how Functions runtime should treat the parameter value.
    • Element Detail

      • name

        java.lang.String name
        The variable name used in function.json.
        Returns:
        The variable name used in function.json.
      • dataType

        java.lang.String dataType

        Defines how Functions runtime should treat the parameter value. Possible values are:

        • "" or string: treat it as a string whose value is serialized from the parameter
        • binary: treat it as a binary data whose value comes from for example OutputBinding<byte[]>
        Returns:
        The dataType which will be used by the Functions runtime.
        Default:
        ""