QueueOutput Interface

Implements

java.lang.annotation.Annotation

public interface QueueOutput
implements java.lang.annotation.Annotation

Place this on a parameter whose value would be written to a storage queue. 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 creates a queue message for each HTTP request received.

@FunctionName("httpToQueue")
@QueueOutput(name = "item", queueName = "myqueue-items", connection = "AzureWebJobsStorage")
 public String pushToQueue(
    @HttpTrigger(name = "request", methods = {HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS)
     final String message,
    @HttpOutput(name = "response") final OutputBinding<String> result
 ) {
     result.setValue(message + " has been added.");
     return message;
 }

Method Summary

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

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

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.

abstract java.lang.String queueName()

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

Method Details

connection

public abstract String connection()

Defines the app setting name that contains the Azure Storage 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.

name

public abstract String name()

The variable name used in function.json.

Returns:

The variable name used in function.json.

queueName

public abstract String queueName()

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

Returns:

The queue name string.

Applies to