Freigeben über

CosmosChangeFeedRequestOptions Klasse

  • Referenz
Paket:
com.azure.cosmos.models
Maven-Artefakt:
com.azure:azure-cosmos:4.54.0
  • java.lang.Object
    • com.azure.cosmos.models.CosmosChangeFeedRequestOptions

public final class CosmosChangeFeedRequestOptions

Kapselt Optionen, die für einen Vorgang in einer Änderungsfeedanforderung angegeben werden können.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
CosmosChangeFeedRequestOptions allVersionsAndDeletes()

Ändert den Änderungsfeedmodus, sodass der Änderungsfeed Ereignisse für Erstellungen, Löschvorgänge sowie alle zwischengeschalteten Momentaufnahmen für Updates enthält.
static CosmosChangeFeedRequestOptions createForProcessingFromBeginning(FeedRange feedRange)

Erstellt eine neue CosmosChangeFeedRequestOptions instance, um mit der Verarbeitung von Änderungsfeedelementen am Anfang des Änderungsfeeds zu beginnen.
static CosmosChangeFeedRequestOptions createForProcessingFromContinuation(String continuation)

Erstellt eine neue CosmosChangeFeedRequestOptions instance zum Starten der Verarbeitung von Änderungsfeedelementen aus einer vorherigen Fortsetzung
static CosmosChangeFeedRequestOptions createForProcessingFromNow(FeedRange feedRange)

Erstellt eine neue CosmosChangeFeedRequestOptions instance, um mit der Verarbeitung von Änderungsfeedelementen ab der aktuellen Zeit zu beginnen, sodass nur Ereignisse für alle zukünftigen Änderungen abgerufen werden.
static CosmosChangeFeedRequestOptions createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)

Erstellt eine neue CosmosChangeFeedRequestOptions instance, um mit der Verarbeitung von Änderungsfeedelementen ab einem bestimmten Zeitpunkt zu beginnen
CosmosChangeFeedRequestOptions fullFidelity()

Als veraltet markiert

stattdessen verwenden allVersionsAndDeletes() .

Ändert den Änderungsfeedmodus, sodass der Änderungsfeed Ereignisse für Erstellungen, Löschvorgänge sowie alle zwischengeschalteten Momentaufnahmen für Updates enthält.
List<String> getExcludedRegions()

Ruft die Liste der Regionen ab, die für die Anforderung/Wiederholung ausgeschlossen werden sollen.
FeedRange getFeedRange()

Ruft den Feedbereich ab.
int getMaxItemCount()

Ruft die maximale Anzahl von Elementen ab, die im Enumerationsvorgang zurückgegeben werden sollen.
int getMaxPrefetchPageCount()

Ruft die maximale Anzahl von Seiten ab, die aus dem Back-End asynchron im Hintergrund vorab abgerufen werden.
String getThroughputControlGroupName()

Rufen Sie den Namen der Durchsatzsteuerungsgruppe ab.
boolean isQuotaInfoEnabled()

Ruft die Einstellung Kontingentinformationenaktiviert für Änderungsfeedanforderung im Azure Cosmos DB-Datenbankdienst ab.
CosmosChangeFeedRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

Ermöglicht das Überschreiben der Diagnoseschwellenwerte für einen bestimmten Vorgang.
CosmosChangeFeedRequestOptions setExcludedRegions(List<String> excludeRegions)

Liste der Regionen, die für die Anforderung/Wiederholung ausgeschlossen werden sollen.
CosmosChangeFeedRequestOptions setMaxItemCount(int maxItemCount)

Legt die maximale Anzahl von Elementen fest, die im Enumerationsvorgang zurückgegeben werden sollen.
CosmosChangeFeedRequestOptions setMaxPrefetchPageCount(int maxPrefetchPageCount)

Legt die maximale Anzahl von Seiten fest, die vom Back-End asynchron im Hintergrund vorab abgerufen werden.
void setQuotaInfoEnabled(boolean quotaInfoEnabled)

Ruft die Einstellung Kontingentinformationenaktiviert für die Änderungsfeedanforderung im Azure Cosmos DB-Datenbankdienst ab.
CosmosChangeFeedRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

Legen Sie den Namen der Durchsatzsteuerungsgruppe fest.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zur Methode

allVersionsAndDeletes

public CosmosChangeFeedRequestOptions allVersionsAndDeletes()

Ändert den Änderungsfeedmodus, sodass der Änderungsfeed Ereignisse für Erstellungen, Löschvorgänge sowie alle zwischengeschalteten Momentaufnahmen für Updates enthält. Zum Aktivieren des AllVersionsAndDeletes-Änderungsfeedmodus muss eine Aufbewahrungsdauer in der Änderungsfeedrichtlinie des Containers konfiguriert werden. ChangeFeedPolicy

Zwischenmomentaufnahmen von Änderungen sowie gelöschte Dokumente stehen für 8 Minuten zur Verarbeitung zur Verfügung, bevor sie verschwinden. Beim Aktivieren des AllVersionsAndDeletes-Modus können Sie Änderungsfeedereignisse nur innerhalb des Aufbewahrungsfensters verarbeiten, das in der Änderungsfeedrichtlinie des Containers konfiguriert ist. Wenn Sie versuchen, einen Änderungsfeed nach mehr als dem Aufbewahrungsfenster zu verarbeiten, wird ein Fehler (Statuscode 400) zurückgegeben, da die Ereignisse für zwischengeschaltete Updates und Löschvorgänge verschwunden sind. Es wäre weiterhin möglich, Änderungen im LatestVersion-Modus zu verarbeiten, auch wenn sie eine Änderungsfeedrichtlinie für AllVersionsAndDeletes mit Aufbewahrungsfenster im Container konfigurieren, und wenn sie den LatestVersion-Modus verwenden, spielt es keine Rolle, ob Sie sich außerhalb des Aufbewahrungsfensters befinden oder nicht . Es wären jedoch keine Ereignisse für Löschvorgänge oder zwischengeschaltete Updates enthalten. Wenn Ereignisse nicht innerhalb des Aufbewahrungsfensters verarbeitet werden, ist es auch möglich, die Verarbeitung zukünftiger Ereignisse im AllVersionsAndDeletes-Modus fortzusetzen, indem Sie den Änderungsfeed mit einer neuen CosmosChangeFeedRequestOptions-instance abfragen.

Returns:

ein CosmosChangeFeedRequestOptions instance mit aktiviertem AllVersionsAndDeletes-Modus

createForProcessingFromBeginning

public static CosmosChangeFeedRequestOptions createForProcessingFromBeginning(FeedRange feedRange)

Erstellt eine neue CosmosChangeFeedRequestOptions instance, um mit der Verarbeitung von Änderungsfeedelementen am Anfang des Änderungsfeeds zu beginnen.

Parameters:

feedRange - Der FeedRange , der zum Definieren des Bereichs verwendet wird (der gesamte Container, die logische Partition oder die Teilmenge eines Containers).

Returns:

createForProcessingFromContinuation

public static CosmosChangeFeedRequestOptions createForProcessingFromContinuation(String continuation)

Erstellt eine neue CosmosChangeFeedRequestOptions instance zum Starten der Verarbeitung von Änderungsfeedelementen aus einer vorherigen Fortsetzung

Parameters:

continuation - Die Fortsetzung, die aus einem zuvor abgerufenen FeedResponse abgerufen wurde

Returns:

createForProcessingFromNow

public static CosmosChangeFeedRequestOptions createForProcessingFromNow(FeedRange feedRange)

Erstellt eine neue CosmosChangeFeedRequestOptions instance, um mit der Verarbeitung von Änderungsfeedelementen ab der aktuellen Zeit zu beginnen, sodass nur Ereignisse für alle zukünftigen Änderungen abgerufen werden.

Parameters:

feedRange - Der FeedRange , der zum Definieren des Bereichs verwendet wird (der gesamte Container, die logische Partition oder die Teilmenge eines Containers).

Returns:

createForProcessingFromPointInTime

public static CosmosChangeFeedRequestOptions createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)

Erstellt eine neue CosmosChangeFeedRequestOptions instance, um mit der Verarbeitung von Änderungsfeedelementen ab einem bestimmten Zeitpunkt zu beginnen

Parameters:

pointInTime - Der Zeitpunkt, ab dem die Verarbeitung von Änderungsfeedereignissen beginnen soll
feedRange - Der FeedRange , der zum Definieren des Bereichs verwendet wird (der gesamte Container, die logische Partition oder die Teilmenge eines Containers).

Returns:

fullFidelity

@Deprecated
public CosmosChangeFeedRequestOptions fullFidelity()

Als veraltet markiert

stattdessen verwenden allVersionsAndDeletes() .

Ändert den Änderungsfeedmodus, sodass der Änderungsfeed Ereignisse für Erstellungen, Löschvorgänge sowie alle zwischengeschalteten Momentaufnahmen für Updates enthält. Zum Aktivieren des AllVersionsAndDeletes-Änderungsfeedmodus muss eine Aufbewahrungsdauer in der Änderungsfeedrichtlinie des Containers konfiguriert werden. ChangeFeedPolicy

Zwischenmomentaufnahmen von Änderungen sowie gelöschte Dokumente stehen für die Verarbeitung für das Aufbewahrungsfenster zur Verfügung, bevor sie verschwinden. Beim Aktivieren des AllVersionsAndDeletes-Modus können Sie Änderungsfeedereignisse nur innerhalb des Aufbewahrungsfensters verarbeiten, das in der Änderungsfeedrichtlinie des Containers konfiguriert ist. Wenn Sie versuchen, einen Änderungsfeed nach mehr als dem Aufbewahrungsfenster zu verarbeiten, wird ein Fehler (Statuscode 400) zurückgegeben, da die Ereignisse für zwischengeschaltete Updates und Löschvorgänge verschwunden sind. Es wäre weiterhin möglich, Änderungen im LatestVersion-Modus zu verarbeiten, auch wenn sie eine Änderungsfeedrichtlinie für AllVersionsAndDeletes mit Aufbewahrungsfenster im Container konfigurieren, und wenn sie den LatestVersion-Modus verwenden, spielt es keine Rolle, ob Sie sich außerhalb des Aufbewahrungsfensters befinden oder nicht . Es wären jedoch keine Ereignisse für Löschvorgänge oder zwischengeschaltete Updates enthalten. Wenn Ereignisse nicht innerhalb des Aufbewahrungsfensters verarbeitet werden, ist es auch möglich, die Verarbeitung zukünftiger Ereignisse im AllVersionsAndDeletes-Modus fortzusetzen, indem Sie den Änderungsfeed mit einer neuen CosmosChangeFeedRequestOptions-instance abfragen.

Returns:

ein CosmosChangeFeedRequestOptions instance mit aktiviertem AllVersionsAndDeletes-Modus

getExcludedRegions

public List getExcludedRegions()

Ruft die Liste der Regionen ab, die für die Anforderung/Wiederholung ausgeschlossen werden sollen. Diese Regionen werden aus der Liste der bevorzugten Regionen ausgeschlossen.

Returns:

Liste der ausgeschlossenen Regionen

getFeedRange

public FeedRange getFeedRange()

Ruft den Feedbereich ab.

Returns:

der Einzugsbereich.

getMaxItemCount

public int getMaxItemCount()

Ruft die maximale Anzahl von Elementen ab, die im Enumerationsvorgang zurückgegeben werden sollen.

Returns:

die maximale Anzahl von Elementen.

getMaxPrefetchPageCount

public int getMaxPrefetchPageCount()

Ruft die maximale Anzahl von Seiten ab, die aus dem Back-End asynchron im Hintergrund vorab abgerufen werden. Durch das Vorababrufen dieser Änderungen kann der Durchsatz der Verarbeitung der Änderungsfeeddatensätze erhöht werden, da die Verarbeitung nicht beendet werden muss, während die E/A-Vorgänge darauf warten, dass eine neue Seite aus dem Back-End abgerufen wird. Das einzige Szenario, in dem es nützlich sein kann, Vorabfetching-Seiten (mit setMaxPrefetchPageCount(0)) zu deaktivieren, wäre, wenn der Aufrufer nur eine Seite abrufen möchte , sodass alle vorab bereitgestellten Seiten sowieso nicht verwendet werden.

Returns:

die geänderten Änderungsfeedanforderungsoptionen.

getThroughputControlGroupName

public String getThroughputControlGroupName()

Rufen Sie den Namen der Durchsatzsteuerungsgruppe ab.

Returns:

Der Name der Durchsatzsteuerungsgruppe.

isQuotaInfoEnabled

public boolean isQuotaInfoEnabled()

Ruft die Einstellung quotaInfoEnabled für die Änderungsfeedanforderung im Azure Cosmos DB-Datenbankdienst ab. quotaInfoEnabled wird zum Aktivieren/Deaktivieren des Abrufens kontingentbezogener Statistiken verwendet.

Returns:

true, wenn quotaInfoEnabled aktiviert ist

setDiagnosticsThresholds

public CosmosChangeFeedRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

Ermöglicht das Überschreiben der Diagnoseschwellenwerte für einen bestimmten Vorgang.

Parameters:

operationSpecificThresholds - Die Außerkraftsetzung des Diagnoseschwellenwerts für diesen Vorgang

Returns:

cosmosQueryRequestOptions.

setExcludedRegions

public CosmosChangeFeedRequestOptions setExcludedRegions(List excludeRegions)

Liste der Regionen, die für die Anforderung/Wiederholung ausgeschlossen werden sollen. Beispiel "USA, Osten" oder "USA, Osten, USA, Westen" Diese Regionen werden aus der Liste der bevorzugten Regionen ausgeschlossen.

Parameters:

excludeRegions - Liste der Regionen

Returns:

setMaxItemCount

public CosmosChangeFeedRequestOptions setMaxItemCount(int maxItemCount)

Legt die maximale Anzahl von Elementen fest, die im Enumerationsvorgang zurückgegeben werden sollen.

Parameters:

maxItemCount - die maximale Anzahl von Elementen.

Returns:

FeedOptionsBase.

setMaxPrefetchPageCount

public CosmosChangeFeedRequestOptions setMaxPrefetchPageCount(int maxPrefetchPageCount)

Legt die maximale Anzahl von Seiten fest, die vom Back-End asynchron im Hintergrund vorab abgerufen werden. Durch das Vorababrufen dieser Änderungen kann der Durchsatz der Verarbeitung der Änderungsfeeddatensätze erhöht werden, da die Verarbeitung nicht beendet werden muss, während die E/A-Vorgänge darauf warten, dass eine neue Seite aus dem Back-End abgerufen wird. Das einzige Szenario, in dem es sinnvoll sein kann, Vorabrufseiten (mit setMaxPrefetchPageCount(0)) zu deaktivieren, wäre, wenn der Aufrufer nur eine Seite abrufen möchte, sodass alle vorab abgerufenen Seiten sowieso nicht verwendet würden.

Parameters:

maxPrefetchPageCount - Die maximale Anzahl von Seiten, die asynchron im Hintergrund aus dem Back-End abgerufen werden

Returns:

die geänderten Änderungsfeedanforderungsoptionen.

setQuotaInfoEnabled

public void setQuotaInfoEnabled(boolean quotaInfoEnabled)

Ruft die Einstellung quotaInfoEnabled für die Änderungsfeedanforderung im Azure Cosmos DB-Datenbankdienst ab. quotaInfoEnabled wird verwendet, um das Abrufen von kontingentbezogenen Statistiken zu aktivieren/zu deaktivieren.

Parameters:

quotaInfoEnabled - ein boolescher Wert, der angibt, ob quotaInfoEnabled aktiviert ist oder nicht

setThroughputControlGroupName

public CosmosChangeFeedRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

Legen Sie den Namen der Durchsatzsteuerungsgruppe fest.

Parameters:

throughputControlGroupName - Der Name der Durchsatzsteuerungsgruppe.

Returns:

Gilt für: