CosmosDBTrigger Schnittstelle

Paket:

com.microsoft.azure.functions.annotation

public interface CosmosDBTrigger

CosmosDBTrigger(name = "database", databaseName = "ToDoList", collectionName = "Items", leaseCollectionName = "leases", createLeaseCollectionIfNotExists = true, connectionStringSetting = "AzureCosmosDBConnection") Listenzuordnungszeichenfolge<<, Zeichenfolgenelemente>>, abschließender ExecutionContext-Kontext ) { context.getLogger().info(items.size() + " item(s) is/are inserted."); if (!items.isEmpty()) { context.getLogger().info("Die ID des ersten Elements ist: " + items.get(0).get("id")); } }

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
int	checkpointDocumentCount() Passt die Anzahl der Dokumente zwischen Lease-Prüfpunkten an. Der Standardwert ist immer nach einem Funktionsaufruf.
int	checkpointInterval() Passt die Anzahl von Millisekunden zwischen Lease-Prüfpunkten an. Der Standardwert ist immer nach einem Funktionsaufruf.
String	collectionName() Definiert den Auflistungsnamen der CosmosDB, an die gebunden werden soll.
String	connectionStringSetting() Definiert den App-Einstellungsnamen, der die CosmosDB-Verbindungszeichenfolge enthält.
boolean	createLeaseCollectionIfNotExists() Definiert, ob eine neue Leaseauflistung erstellt werden soll, falls nicht vorhanden ist.
String	databaseName() Definiert den Datenbanknamen der CosmosDB, an die gebunden werden soll.
String	dataType() Definiert, wie die Functions-Runtime den Parameterwert behandeln soll. Mögliche Werte: <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() Passt die Verzögerung in Millisekunden zwischen dem Abfragen einer Partition nach neuen Änderungen im Feed an, nachdem alle aktuellen Änderungen entfernt wurden. Der Standardwert ist 5000 (5 Sekunden).
int	leaseAcquireInterval() Passt das Intervall in Millisekunden an, um eine Aufgabe zu starten, die berechnet werden soll, wenn Partitionen gleichmäßig auf bekannte Hostinstanzen verteilt sind. Der Standardwert ist 13000 (13 Sekunden).
String	leaseCollectionName() Definiert den Leaseauflistungsnamen der CosmosDB, an die gebunden werden soll.
String	leaseCollectionPrefix() Definiert ein Präfix, das in einer Leases-Auflistung für diesen Trigger verwendet werden soll. Nützlich, wenn sie dieselbe Lease-Auflistung für mehrere Trigger freigeben.
String	leaseConnectionStringSetting() Definiert die Verbindungszeichenfolge für den Dienst, der die Leaseauflistung enthält.
String	leaseDatabaseName() Definiert den Namen der Datenbank, die die Leaseauflistung enthält.
int	leaseExpirationInterval() Passt das Intervall in Millisekunden an, für das die Lease für eine Lease verwendet wird, die eine Partition darstellt. Wenn die Lease innerhalb dieses Intervalls nicht verlängert wird, läuft sie ab, und der Besitz der Partition wechselt in eine andere Trigger-instance. Der Standardwert ist 60000 (60 Sekunden).
int	leaseRenewInterval() Passt das Verlängerungsintervall in Millisekunden für alle Leases für Partitionen an, die derzeit vom Trigger gehalten werden. Der Standardwert ist 17000 (17 Sekunden).
int	leasesCollectionThroughput() definiert den Durchsatz der erstellten Auflistung.
int	maxItemsPerInvocation() Passt die maximale Anzahl von Elementen an, die bei einem Aufruf empfangen werden
String	name() Der in function.json verwendete Variablenname.
String	preferredLocations() Definiert bevorzugte Standorte (Regionen) für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst. Werte sollten durch Trennzeichen getrennt sein. Beispiel: PreferredLocations = "USA, Osten", "USA, Süden-Mitte", "Europa, Norden"
boolean	startFromBeginning() Ruft ab oder legt fest, ob der Änderungsfeed im Azure Cosmos DB-Dienst von anfang (true) oder von aktuell (false) gestartet werden soll. Standardmäßig wird der Start von aktuell (false) verwendet.

Details zur Methode

checkpointDocumentCount

public int checkpointDocumentCount() default -1

Passt die Anzahl der Dokumente zwischen Lease-Prüfpunkten an. Der Standardwert ist immer nach einem Funktionsaufruf.

Returns:

CheckpointDocumentCount

checkpointInterval

public int checkpointInterval() default -1

Passt die Anzahl von Millisekunden zwischen Lease-Prüfpunkten an. Der Standardwert ist immer nach einem Funktionsaufruf.

Returns:

checkpointInterval

collectionName

public String collectionName()

Definiert den Auflistungsnamen der CosmosDB, an die gebunden werden soll.

Returns:

Die Zeichenfolge des Auflistungsnamens.

connectionStringSetting

public String connectionStringSetting()

Definiert den App-Einstellungsnamen, der die CosmosDB-Verbindungszeichenfolge enthält.

Returns:

Der App-Einstellungsname der Verbindungszeichenfolge.

createLeaseCollectionIfNotExists

public boolean createLeaseCollectionIfNotExists() default false

Definiert, ob eine neue Leaseauflistung erstellt werden soll, falls nicht vorhanden ist.

Returns:

Konfiguration, ob eine neue Leaseauflistung erstellt werden soll, falls nicht vorhanden.

databaseName

public String databaseName()

Definiert den Datenbanknamen der CosmosDB, an die gebunden werden soll.

Returns:

Die Datenbanknamenzeichenfolge.

dataType

public String dataType() default ""

Definiert, wie die Functions-Runtime den Parameterwert behandeln soll. Mögliche Werte:

<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:

Der dataType, der von der Functions-Runtime verwendet wird.

feedPollDelay

public int feedPollDelay() default 5000

Passt die Verzögerung in Millisekunden zwischen dem Abfragen einer Partition nach neuen Änderungen im Feed an, nachdem alle aktuellen Änderungen entfernt wurden. Der Standardwert ist 5000 (5 Sekunden).

Returns:

feedPollDelay

leaseAcquireInterval

public int leaseAcquireInterval() default 13000

Passt das Intervall in Millisekunden an, um eine Aufgabe zu starten, die berechnet werden soll, wenn Partitionen gleichmäßig auf bekannte Hostinstanzen verteilt sind. Der Standardwert ist 13000 (13 Sekunden).

Returns:

Intervall in Millisekunden

leaseCollectionName

public String leaseCollectionName() default ""

Definiert den Leaseauflistungsnamen der CosmosDB, an die gebunden werden soll.

Returns:

Die Zeichenfolge des Leaseauflistungsnamens.

leaseCollectionPrefix

public String leaseCollectionPrefix() default ""

Definiert ein Präfix, das in einer Leases-Auflistung für diesen Trigger verwendet werden soll. Nützlich, wenn sie dieselbe Lease-Auflistung für mehrere Trigger freigeben.

Returns:

LeaseCollectionPrefix

leaseConnectionStringSetting

public String leaseConnectionStringSetting() default ""

Definiert die Verbindungszeichenfolge für den Dienst, der die Leaseauflistung enthält.

Returns:

Verbindungszeichenfolge für die Leaseauflistung.

leaseDatabaseName

public String leaseDatabaseName() default ""

Definiert den Namen der Datenbank, die die Leaseauflistung enthält.

Returns:

Name der Datenbank für die Leasesammlung.

leaseExpirationInterval

public int leaseExpirationInterval() default 60000

Passt das Intervall in Millisekunden an, für das die Lease für eine Lease verwendet wird, die eine Partition darstellt. Wenn die Lease innerhalb dieses Intervalls nicht verlängert wird, läuft sie ab, und der Besitz der Partition wechselt in eine andere Trigger-instance. Der Standardwert ist 60000 (60 Sekunden).

Returns:

Intervall in Millisekunden, für das die Lease verwendet wird

leaseRenewInterval

public int leaseRenewInterval() default 17000

Passt das Verlängerungsintervall in Millisekunden für alle Leases für Partitionen an, die derzeit vom Trigger gehalten werden. Der Standardwert ist 17000 (17 Sekunden).

Returns:

Verlängerungsintervall in Millisekunden für alle Leases

leasesCollectionThroughput

public int leasesCollectionThroughput() default -1

definiert den Durchsatz der erstellten Auflistung.

Returns:

throughput

maxItemsPerInvocation

public int maxItemsPerInvocation() default -1

Passt die maximale Anzahl von Elementen an, die bei einem Aufruf empfangen werden

Returns:

Maximale Anzahl empfangener Elemente

name

public String name()

Der in function.json verwendete Variablenname.

Returns:

Der in function.json verwendete Variablenname.

preferredLocations

public String preferredLocations() default ""

Definiert bevorzugte Standorte (Regionen) für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst. Werte sollten durch Trennzeichen getrennt sein. Beispiel: PreferredLocations = "USA, Osten", "USA, Süden-Mitte", "Europa, Norden"

Returns:

bevorzugte Standorte (Regionen) für georeplizierte Datenbankkonten

startFromBeginning

public boolean startFromBeginning() default false

Ruft ab oder legt fest, ob der Änderungsfeed im Azure Cosmos DB-Dienst von anfang (true) oder von aktuell (false) gestartet werden soll. Standardmäßig wird der Start von aktuell (false) verwendet.

Returns:

Konfiguration, ob der Änderungsfeed von Anfang an beginnen soll