CosmosDBTrigger (Microsoft Azure Functions Java Core Types 2.2.0 API)

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface CosmosDBTrigger

Place this on a parameter whose value would come from CosmosDB, and causing the method to run when CosmosDB data is changed. The parameter type can be one of the following:

Some native Java types such as String
Nullable values using Optional<T>
Any POJO type

The following example shows a Java function that is invoked when there are inserts or updates in the specified database and collection.

  @FunctionName("cosmosDBMonitor")
 public void cosmosDbLog(
     @CosmosDBTrigger(name = "database",
                      databaseName = "ToDoList",
                      collectionName = "Items",
                      leaseCollectionName = "leases",
                      createLeaseCollectionIfNotExists = true,
                      connectionStringSetting = "AzureCosmosDBConnection") 
                      List<Map<String, String>> items,
     final ExecutionContext context
 ) {
     context.getLogger().info(items.size() + " item(s) is/are inserted.");
     if (!items.isEmpty()) {
         context.getLogger().info("The ID of the first item is: " + items.get(0).get("id"));
     }
 }

Since:: 1.0.0

Required Element Summary

Required Elements
Modifier and Type	Required Element and Description
`String`	`collectionName` Defines the collection name of the CosmosDB to which to bind.
`String`	`connectionStringSetting` Defines the app setting name that contains the CosmosDB connection string.
`String`	`databaseName` Defines the database name of the CosmosDB to which to bind.
`String`	`name` The variable name used in function.json.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`int`	`checkpointDocumentCount` Customizes the amount of documents between lease checkpoints.
`int`	`checkpointInterval` Customizes the amount of milliseconds between lease checkpoints.
`boolean`	`createLeaseCollectionIfNotExists` Defines whether to create a new lease collection if not exists.
`String`	`dataType` Defines how Functions runtime should treat the parameter value.
`int`	`feedPollDelay` Customizes the delay in milliseconds in between polling a partition for new changes on the feed, after all current changes are drained.
`int`	`leaseAcquireInterval` Customizes the interval in milliseconds to kick off a task to compute if partitions are distributed evenly among known host instances.
`String`	`leaseCollectionName` Defines the lease collection name of the CosmosDB to which to bind.
`String`	`leaseCollectionPrefix` Defines a prefix to be used within a Leases collection for this Trigger.
`String`	`leaseConnectionStringSetting` Defines Connection string for the service containing the lease collection.
`String`	`leaseDatabaseName` Defines Name of the database containing the lease collection.
`int`	`leaseExpirationInterval` Customizes the interval in milliseconds for which the lease is taken on a lease representing a partition.
`int`	`leaseRenewInterval` Customizes the renew interval in milliseconds for all leases for partitions currently held by the Trigger.
`int`	`leasesCollectionThroughput` defines the throughput of the created collection..
`int`	`maxItemsPerInvocation` Customizes the maximum amount of items received in an invocation
`String`	`preferredLocations` Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service.
`boolean`	`startFromBeginning` Gets or sets whether change feed in the Azure Cosmos DB service should start from beginning (true) or from current (false).

- Element Detail
  - name
```
public abstract String name
```
    The variable name used in function.json.
    
    Returns:
    
    The variable name used in function.json.
- - databaseName
```
public abstract String databaseName
```
    Defines the database name of the CosmosDB to which to bind.
    
    Returns:
    
    The database name string.
- - collectionName
```
public abstract String collectionName
```
    Defines the collection name of the CosmosDB to which to bind.
    
    Returns:
    
    The collection name string.
- - connectionStringSetting
```
public abstract String connectionStringSetting
```
    Defines the app setting name that contains the CosmosDB 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.
    
    Default:
    
    ""
- - leaseConnectionStringSetting
```
public abstract String leaseConnectionStringSetting
```
    Defines Connection string for the service containing the lease collection.
    
    Returns:
    
    Connection string for the lease collection.
    
    Default:
    
    ""
- - leaseCollectionName
```
public abstract String leaseCollectionName
```
    Defines the lease collection name of the CosmosDB to which to bind.
    
    Returns:
    
    The lease collection name string.
    
    Default:
    
    ""
- - leaseDatabaseName
```
public abstract String leaseDatabaseName
```
    Defines Name of the database containing the lease collection.
    
    Returns:
    
    Name of the database for lease collection.
    
    Default:
    
    ""
- - createLeaseCollectionIfNotExists
```
public abstract boolean createLeaseCollectionIfNotExists
```
    Defines whether to create a new lease collection if not exists.
    
    Returns:
    
    configuration whether to create a new lease collection if not exists.
    
    Default:
    
    false
- - leasesCollectionThroughput
```
public abstract int leasesCollectionThroughput
```
    defines the throughput of the created collection..
    
    Returns:
    
    throughput
    
    Default:
    
    -1
- - leaseCollectionPrefix
```
public abstract String leaseCollectionPrefix
```
    Defines a prefix to be used within a Leases collection for this Trigger. Useful when sharing the same Lease collection among multiple Triggers.
    
    Returns:
    
    LeaseCollectionPrefix
    
    Default:
    
    ""
- - checkpointInterval
```
public abstract int checkpointInterval
```
    Customizes the amount of milliseconds between lease checkpoints. Default is always after a Function call.
    
    Returns:
    
    checkpointInterval
    
    Default:
    
    -1
- - checkpointDocumentCount
```
public abstract int checkpointDocumentCount
```
    Customizes the amount of documents between lease checkpoints. Default is always after a Function call.
    
    Returns:
    
    CheckpointDocumentCount
    
    Default:
    
    -1
- - feedPollDelay
```
public abstract int feedPollDelay
```
    Customizes the delay in milliseconds in between polling a partition for new changes on the feed, after all current changes are drained. Default is 5000 (5 seconds).
    
    Returns:
    
    feedPollDelay
    
    Default:
    
    5000
- - leaseRenewInterval
```
public abstract int leaseRenewInterval
```
    Customizes the renew interval in milliseconds for all leases for partitions currently held by the Trigger. Default is 17000 (17 seconds).
    
    Returns:
    
    renew interval in milliseconds for all leases
    
    Default:
    
    17000
- - leaseAcquireInterval
```
public abstract int leaseAcquireInterval
```
    Customizes the interval in milliseconds to kick off a task to compute if partitions are distributed evenly among known host instances. Default is 13000 (13 seconds).
    
    Returns:
    
    interval in milliseconds
    
    Default:
    
    13000
- - leaseExpirationInterval
```
public abstract int leaseExpirationInterval
```
    Customizes the interval in milliseconds for which the lease is taken on a lease representing a partition. If the lease is not renewed within this interval, it will cause it to expire and ownership of the partition will move to another Trigger instance. Default is 60000 (60 seconds).
    
    Returns:
    
    interval in milliseconds for which the lease is taken
    
    Default:
    
    60000
- - maxItemsPerInvocation
```
public abstract int maxItemsPerInvocation
```
    Customizes the maximum amount of items received in an invocation
    
    Returns:
    
    maximum amount of items received
    
    Default:
    
    -1
- - startFromBeginning
```
public abstract boolean startFromBeginning
```
    Gets or sets whether change feed in the Azure Cosmos DB service should start from beginning (true) or from current (false). By default it's start from current (false).
    
    Returns:
    
    Configuration whether change feed should start from beginning
    
    Default:
    
    false
- - preferredLocations
```
public abstract String preferredLocations
```
    Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service. Values should be comma-separated. example, PreferredLocations = "East US,South Central US,North Europe"
    
    Returns:
    
    preferred locations (regions) for geo-replicated database accounts
    
    Default:
    
    ""

Annotation Type CosmosDBTrigger

Required Element Summary

Optional Element Summary

Element Detail

name

databaseName

collectionName

connectionStringSetting

dataType

leaseConnectionStringSetting

leaseCollectionName

leaseDatabaseName

createLeaseCollectionIfNotExists

leasesCollectionThroughput

leaseCollectionPrefix

checkpointInterval

checkpointDocumentCount

feedPollDelay

leaseRenewInterval

leaseAcquireInterval

leaseExpirationInterval

maxItemsPerInvocation

startFromBeginning

preferredLocations