Package com.microsoft.azure.functions.annotation

Annotation Type EventHubOutput

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

    Place this on a parameter whose value would be published to the event hub. The parameter type should be OutputBinding<T>, where T could be one of:

    • Any native Java types such as int, String, byte[]
    • Any POJO type

    The following example shows a Java function that writes a message to an event hub:

    @FunctionName("sendTime")
@EventHubOutput(name = "event", eventHubName = "samples-workitems", connection = "AzureEventHubConnection")
 public String sendTime(
    @TimerTrigger(name = "sendTimeTrigger", schedule = "0 */5 * * * *") String timerInfo
 ) {
     return LocalDateTime.now().toString();
 }
    Since:
    1.0.0

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String connection
      Defines the app setting name that contains the Azure Eventhub connection string.
      java.lang.String eventHubName
      Defines the name of the event hub to which to publish.
      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.

      • eventHubName

        java.lang.String eventHubName
        Defines the name of the event hub to which to publish.
        Returns:
        The event hub name string.

      • connection

        java.lang.String connection
        Defines the app setting name that contains the Azure Eventhub connection string.
        Returns:
        The app setting name of the connection string.

      • 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:
        ""