QueueTrigger Interface

Definition

Place this on a parameter whose value would come from a storage queue, and causing the method to run when a new item is pushed. 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 polls the "myqueue-items" queue and writes a log each time a queue item is processed.

@FunctionName("queueMonitor")
 public void logQueueItem(
    @QueueTrigger(name = "msg", queueName = "myqueue-items", connection = "AzureWebJobsStorage") 
     String message,
     final ExecutionContext context
 ) {
     context.getLogger().info("Queue message processed: " + message);
 }
public interface QueueTrigger implements Annotation
Implements
java.lang.annotation.Annotation

Methods

connection()

Defines the app setting name that contains the Azure Storage connection 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[]
name()

The variable name used in function.json.

queueName()

Defines the name of the storage queue to which to bind.

Applies to