Annotation Type QueueTrigger


  • @Retention(RUNTIME)
    @Target(PARAMETER)
    public @interface QueueTrigger

    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<T>
    • 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);
     }
    Since:
    1.0.0
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      The variable name used in function.json.
      java.lang.String queueName
      Defines the name of the storage queue to which to bind.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String connection
      Defines the app setting name that contains the Azure Storage connection string.
      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.
      • queueName

        java.lang.String queueName
        Defines the name of the storage queue to which to bind.
        Returns:
        The storage queue name string.
      • dataType

        java.lang.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.
        Default:
        ""
      • connection

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