QueueTrigger Interface

public interface QueueTrigger

QueueTrigger(name = "msg", queueName = "myqueue-items", connection = "AzureWebJobsStorage") String message, final ExecutionContext context ) { context.getLogger().info("Queue message processed: " + message); }

Method Summary

Modifier and Type Method and Description
String connection()

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

String dataType()

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

    <li>
    
      <p>"": get the value as a string, and try to deserialize to actual parameter type like POJO </p>
    
    </li>
    
    <li>
    
      <p>string: always get the value as a string </p>
    
    </li>
    
    <li>
    
      <p>binary: get the value as a binary data, and try to deserialize to actual parameter type byte[] </p>
    
    </li>
    

String name()

The variable name used in function.json.

String queueName()

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

Method Details

connection

public String connection() default ""

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

Returns:

The app setting name of the connection string.

dataType

public String dataType() default ""

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

    <li>
    
      <p>"": get the value as a string, and try to deserialize to actual parameter type like POJO </p>
    
    </li>
    
    <li>
    
      <p>string: always get the value as a string </p>
    
    </li>
    
    <li>
    
      <p>binary: get the value as a binary data, and try to deserialize to actual parameter type byte[] </p>
    
    </li>
    

Returns:

The dataType which will be used by the Functions runtime.

name

public String name()

The variable name used in function.json.

Returns:

The variable name used in function.json.

queueName

public String queueName()

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

Returns:

The storage queue name string.

Applies to