EventGridTrigger Interface

  • Reference
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 EventGridTrigger
implements java.lang.annotation.Annotation

Place this on a parameter whose value would come from EventGrid, and causing the method to run when an 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 prints out an event:

@FunctionName("eventGridMonitor")
 public void logEvent(
    @EventGridTrigger(name = "event") String content,
     final ExecutionContext context
 ) {
     context.getLogger().info(content);
 }

Method Summary

Modifier and Type Method and Description
abstract java.lang.String dataType()

Defines how Functions runtime should treat the parameter value.
abstract java.lang.String name()

The variable name used in function.json.

Method Details

dataType

public abstract String 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[]

Returns:

The dataType which will be used by the Functions runtime.

name

public abstract String name()

The variable name used in function.json.

Returns:

The variable name used in function.json.

Applies to