EventHubTrigger Interface

  • Reference

Definition

Package:
com.microsoft.azure.functions.annotation
Maven Artifact:
com.microsoft.azure.functions:azure-functions-java-library:1.3.1

Place this on a parameter whose value would come from event hub, and causing the method to run when a new event is arrived. The parameter type can be one of the following:

  • Any native Java types such as int, String, byte[]
  • Nullable values using Optional
  • Any POJO type

The following example shows a Java function that logs the message body of the event hub trigger:

@FunctionName("eventHubMonitor")
 public void logEventHubMessage(
    @EventHubTrigger(name = "event", 
    eventHubName = "samples-workitems", 
    connection = "AzureEventHubConnection") String message,
     final ExecutionContext context
 ) {
     context.getLogger().info("Event hub message received: " + message);
 }

public interface EventHubTrigger implements Annotation
Implements
java.lang.annotation.Annotation

Methods

cardinality()

Cardinality of the trigger input. Choose 'One' if the input is a single message or 'Many' if the input is an array of messages. 'Many' is the default if unspecified
connection()

Defines the app setting name that contains the Azure Eventhub connection string.
consumerGroup()

Defines the consumer group of the event hub to which to bind.
dataType()

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

  • "": get the value as a string, and try to deserialize to actual parameter type like POJO
  • string: always get the value as a string
  • binary: get the value as a binary data, and try to deserialize to actual parameter type byte[]
eventHubName()

Defines the name of the event hub to which to bind.
name()

The variable name used in function.json.

Applies to