CosmosDBTrigger Interface

Paquet:

com.microsoft.azure.functions.annotation

public interface CosmosDBTrigger

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 »)); } } }

Résumé de la méthode

Modificateur et type	Méthode et description
int	checkpointDocumentCount() Personnalise la quantité de documents entre les points de contrôle de bail. La valeur par défaut est toujours après un appel de fonction.
int	checkpointInterval() Personnalise la quantité de millisecondes entre les points de contrôle de bail. La valeur par défaut est toujours après un appel de fonction.
String	collectionName() Définit le nom de la collection de CosmosDB à laquelle lier.
String	connectionStringSetting() Définit le nom du paramètre d’application qui contient la chaîne de connexion CosmosDB.
boolean	createLeaseCollectionIfNotExists() Définit s’il faut créer un regroupement de baux s’il n’existe pas.
String	databaseName() Définit le nom de la base de données cosmosDB à laquelle lier.
String	dataType() Définit comment le runtime Functions doit traiter la valeur de paramètre. Les valeurs possibles sont les suivantes : <li> <p>"": get the value as a string, and try to deserialize to actual parameter type like POJO </p> </li> <li> <p>string: always get the value as a string </p> </li> <li> <p>binary: get the value as a binary data, and try to deserialize to actual parameter type byte[] </p> </li>
int	feedPollDelay() Personnalise le délai en millisecondes entre l’interrogation d’une partition pour les nouvelles modifications sur le flux, une fois que toutes les modifications actuelles sont vidées. La valeur par défaut est 5 000 (5 secondes).
int	leaseAcquireInterval() Personnalise l’intervalle en millisecondes pour lancer une tâche de calcul si les partitions sont réparties uniformément entre les instances hôtes connues. La valeur par défaut est 13 000 (13 secondes).
String	leaseCollectionName() Définit le nom de la collection de baux de CosmosDB à laquelle lier.
String	leaseCollectionPrefix() Définit un préfixe à utiliser dans une collection Leases pour ce déclencheur. Utile lors du partage de la même collection De baux entre plusieurs déclencheurs.
String	leaseConnectionStringSetting() Définit la chaîne de connexion pour le service contenant la collection de baux.
String	leaseDatabaseName() Définit le nom de la base de données contenant la collection de baux.
int	leaseExpirationInterval() Personnalise l’intervalle en millisecondes pour lequel le bail est pris sur un bail représentant une partition. Si le bail n’est pas renouvelé dans cet intervalle, il arrive à expiration et la propriété de la partition passe à un autre instance de déclencheur. La valeur par défaut est 60 000 (60 secondes).
int	leaseRenewInterval() Personnalise l’intervalle de renouvellement en millisecondes pour tous les baux pour les partitions actuellement détenues par le déclencheur. La valeur par défaut est 17 000 (17 secondes).
int	leasesCollectionThroughput() définit le débit de la collection créée.
int	maxItemsPerInvocation() Personnalise la quantité maximale d’éléments reçus dans un appel
String	name() Nom de variable utilisé dans function.json.
String	preferredLocations() Définit les emplacements (régions) préférés pour les comptes de base de données géorépliqués dans le service Azure Cosmos DB. Les valeurs doivent être séparées par des virgules. exemple, PreferredLocations = « USA Est,USA Centre Sud,Europe Nord »
boolean	startFromBeginning() Obtient ou définit si le flux de modification dans le service Azure Cosmos DB doit commencer à partir du début (true) ou du flux actuel (false). Par défaut, elle commence à partir de current (false).

Détails de la méthode

checkpointDocumentCount

public int checkpointDocumentCount() default -1

Personnalise la quantité de documents entre les points de contrôle de bail. La valeur par défaut est toujours après un appel de fonction.

Returns:

CheckpointDocumentCount

checkpointInterval

public int checkpointInterval() default -1

Personnalise la quantité de millisecondes entre les points de contrôle de bail. La valeur par défaut est toujours après un appel de fonction.

Returns:

checkpointInterval

collectionName

public String collectionName()

Définit le nom de la collection de CosmosDB à laquelle lier.

Returns:

Chaîne de nom de collection.

connectionStringSetting

public String connectionStringSetting()

Définit le nom du paramètre d’application qui contient la chaîne de connexion CosmosDB.

Returns:

Nom du paramètre d’application de la chaîne de connexion.

createLeaseCollectionIfNotExists

public boolean createLeaseCollectionIfNotExists() default false

Définit s’il faut créer un regroupement de baux s’il n’existe pas.

Returns:

indique s’il faut créer un regroupement de baux s’il n’existe pas.

databaseName

public String databaseName()

Définit le nom de la base de données cosmosDB à laquelle lier.

Returns:

Chaîne de nom de base de données.

dataType

public String dataType() default ""

Définit comment le runtime Functions doit traiter la valeur de paramètre. Les valeurs possibles sont les suivantes :

<li>

  <p>"": get the value as a string, and try to deserialize to actual parameter type like POJO </p>

</li>

<li>

  <p>string: always get the value as a string </p>

</li>

<li>

  <p>binary: get the value as a binary data, and try to deserialize to actual parameter type byte[] </p>

</li>

Returns:

DataType qui sera utilisé par le runtime Functions.

feedPollDelay

public int feedPollDelay() default 5000

Personnalise le délai en millisecondes entre l’interrogation d’une partition pour les nouvelles modifications sur le flux, une fois que toutes les modifications actuelles sont vidées. La valeur par défaut est 5 000 (5 secondes).

Returns:

feedPollDelay

leaseAcquireInterval

public int leaseAcquireInterval() default 13000

Personnalise l’intervalle en millisecondes pour lancer une tâche de calcul si les partitions sont réparties uniformément entre les instances hôtes connues. La valeur par défaut est 13 000 (13 secondes).

Returns:

intervalle en millisecondes

leaseCollectionName

public String leaseCollectionName() default ""

Définit le nom de la collection de baux de CosmosDB à laquelle lier.

Returns:

Chaîne de nom de collection de bail.

leaseCollectionPrefix

public String leaseCollectionPrefix() default ""

Définit un préfixe à utiliser dans une collection Leases pour ce déclencheur. Utile lors du partage de la même collection De baux entre plusieurs déclencheurs.

Returns:

LeaseCollectionPrefix

leaseConnectionStringSetting

public String leaseConnectionStringSetting() default ""

Définit la chaîne de connexion pour le service contenant la collection de baux.

Returns:

Chaîne de connexion pour la collection de baux.

leaseDatabaseName

public String leaseDatabaseName() default ""

Définit le nom de la base de données contenant la collection de baux.

Returns:

Nom de la base de données pour la collecte de baux.

leaseExpirationInterval

public int leaseExpirationInterval() default 60000

Personnalise l’intervalle en millisecondes pour lequel le bail est pris sur un bail représentant une partition. Si le bail n’est pas renouvelé dans cet intervalle, il arrive à expiration et la propriété de la partition passe à un autre instance de déclencheur. La valeur par défaut est 60 000 (60 secondes).

Returns:

intervalle en millisecondes pour lequel le bail est pris

leaseRenewInterval

public int leaseRenewInterval() default 17000

Personnalise l’intervalle de renouvellement en millisecondes pour tous les baux pour les partitions actuellement détenues par le déclencheur. La valeur par défaut est 17 000 (17 secondes).

Returns:

intervalle de renouvellement en millisecondes pour tous les baux

leasesCollectionThroughput

public int leasesCollectionThroughput() default -1

définit le débit de la collection créée.

Returns:

throughput

maxItemsPerInvocation

public int maxItemsPerInvocation() default -1

Personnalise la quantité maximale d’éléments reçus dans un appel

Returns:

quantité maximale d’éléments reçus

name

public String name()

Nom de variable utilisé dans function.json.

Returns:

Nom de variable utilisé dans function.json.

preferredLocations

public String preferredLocations() default ""

Définit les emplacements (régions) préférés pour les comptes de base de données géorépliqués dans le service Azure Cosmos DB. Les valeurs doivent être séparées par des virgules. exemple, PreferredLocations = « USA Est,USA Centre Sud,Europe Nord »

Returns:

emplacements préférés (régions) pour les comptes de base de données géorépliqués

startFromBeginning

public boolean startFromBeginning() default false

Obtient ou définit si le flux de modification dans le service Azure Cosmos DB doit commencer à partir du début (true) ou du flux actuel (false). Par défaut, elle commence à partir de current (false).

Returns:

Configuration indiquant si le flux de modification doit commencer à partir du début