com.microsoft.azure.functions.annotation.CosmosDBTrigger Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-functions-java-library Show documentation

This package contains all Java interfaces and annotations to interact with Microsoft Azure functions runtime.

There is a newer version: 3.1.0

Show newest version

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */

package com.microsoft.azure.functions.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * The following example shows a cosmos db trigger which logs the count of the returned items:
 *
 * {@literal @}FunctionName("cdbprocessor")
 * public void cosmosDbProcessor(
 *    {@literal @}CosmosDBTrigger(name = "items",
 *                      databaseName = "mydbname",
 *                      collectionName = "mycollname",
 *                      leaseCollectionName = "",
 *                      connectionStringSetting = "myconnvarname") MyDataItem[] items,
 *     final ExecutionContext context
 * ) {
 *     context.getLogger().info(items.length);
 * }
 *
 * @since 1.0.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER})
public @interface CosmosDBTrigger {
    String name();

    String dataType() default "";

    String databaseName();

    String collectionName();

    String leaseCollectionName();

    boolean createLeaseCollectionIfNotExists() default false;

    String connectionStringSetting();
}