ServiceBusTopicTrigger 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 ServiceBusTopicTrigger
implements java.lang.annotation.Annotation

Place this on a parameter whose value would come from Service Bus topic, and causing the method to run when a new item is published. 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 service bus topic trigger which logs the message:

@FunctionName("sbprocessor")
 public void serviceBusProcess(
    @ServiceBusTopicTrigger(name = "msg",
                             topicName = "mytopicname",
                             subscriptionName = "mysubname",
                             connection = "myconnvarname") String message,
     final ExecutionContext context
 ) {
     context.getLogger().info(message);
 }

Method Summary

Modifier and Type Method and Description
abstract AccessRights access()

Defines the permission of the Service Bus topic to which to bind.
abstract java.lang.String connection()

Defines the app setting name that contains the Service Bus connection string.
abstract java.lang.String dataType()

Defines how Functions runtime should treat the parameter value.
abstract boolean isSessionsEnabled()

Defines the value indicating whether the sessions are enabled.
abstract java.lang.String name()

The variable name used in function.json.
abstract java.lang.String subscriptionName()

Defines the subscription name of the Service Bus topic to which to bind.
abstract java.lang.String topicName()

Defines the name of the Service Bus topic to which to bind.

Method Details

access

public abstract AccessRights access()

Defines the permission of the Service Bus topic to which to bind.

Returns:

The Service Bus topic permission.

connection

public abstract String connection()

Defines the app setting name that contains the Service Bus 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:

  • "": 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.

isSessionsEnabled

public abstract boolean isSessionsEnabled()

Defines the value indicating whether the sessions are enabled.

Returns:

The value indicating whether the sessions are enabled.

name

public abstract String name()

The variable name used in function.json.

Returns:

The variable name used in function.json.

subscriptionName

public abstract String subscriptionName()

Defines the subscription name of the Service Bus topic to which to bind.

Returns:

The Service Bus topic subscription name string.

topicName

public abstract String topicName()

Defines the name of the Service Bus topic to which to bind.

Returns:

The Service Bus topic name string.

Applies to