DurableOrchestrationTrigger Interface

Package:

com.microsoft.durabletask.azurefunctions

Maven Artifact:

com.microsoft:durabletask-azure-functions:1.0.1

Implements

java.lang.annotation.Annotation

public interface DurableOrchestrationTrigger
implements java.lang.annotation.Annotation

Azure Functions attribute for binding a function parameter to a Durable Task orchestration request.

The following is an example of an orchestrator function that calls three activity functions in sequence.

@FunctionName("HelloCities")
 public String helloCitiesOrchestrator(
         @DurableOrchestrationTrigger(name = "orchestratorRequestProtoBytes") String orchestratorRequestProtoBytes) {
     return OrchestrationRunner.loadAndRun(orchestratorRequestProtoBytes, ctx -> {
         String result = "";
         result += ctx.callActivity("SayHello", "Tokyo", String.class).await() + ", ";
         result += ctx.callActivity("SayHello", "London", String.class).await() + ", ";
         result += ctx.callActivity("SayHello", "Seattle", String.class).await();
         return result;
     });
 }

Method Summary

Modifier and Type	Method and Description
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	orchestration() The name of the orchestrator function.

Method Details

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.

name

public abstract String name()

The variable name used in function.json.

Returns:

The variable name used in function.json.

orchestration

public abstract String orchestration()

The name of the orchestrator function.

If not specified, the function name is used as the name of the orchestration.

This property supports binding parameters.

Returns:

The name of the orchestrator function.