EventHubOutput Interface

Package:

com.microsoft.azure.functions.annotation

Maven Artifact:

com.microsoft.azure.functions:azure-functions-java-library:1.3.1

Implements

java.lang.annotation.Annotation

public interface EventHubOutput
implements java.lang.annotation.Annotation

Place this on a parameter whose value would be published to the event hub. The parameter type should be OutputBinding, 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();
 }

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	connection() Defines the app setting name that contains the Azure Eventhub connection string.
abstract java.lang.String	dataType() Defines how Functions runtime should treat the parameter value.
abstract java.lang.String	eventHubName() Defines the name of the event hub to which to publish.
abstract java.lang.String	name() The variable name used in function.json.

Method Details

connection

public abstract String connection()

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

Returns:

The app setting name of the connection string.

dataType

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

eventHubName

public abstract String eventHubName()

Defines the name of the event hub to which to publish.

Returns:

The event hub name string.

name

public abstract String name()

The variable name used in function.json.

Returns:

The variable name used in function.json.