CosmosChangeFeedRequestOptions Classe
- java.
lang. Object - com.
azure. cosmos. models. CosmosChangeFeedRequestOptions
- com.
public final class CosmosChangeFeedRequestOptions
Encapsule les options qui peuvent être spécifiées pour une opération dans une demande de flux de modification.
Résumé de la méthode
Modificateur et type | Méthode et description |
---|---|
Cosmos |
allVersionsAndDeletes()
Modifie le mode de flux de modification afin que le flux de modification contienne des événements pour les créations, les suppressions ainsi que tous les instantanés intermédiaires pour les mises à jour. |
static
Cosmos |
createForProcessingFromBeginning(FeedRange feedRange)
Crée un CosmosChangeFeedRequestOptions instance pour commencer à traiter les éléments de flux de modification à partir du début du flux de modification |
static
Cosmos |
createForProcessingFromContinuation(String continuation)
Crée un CosmosChangeFeedRequestOptions instance pour commencer à traiter les éléments de flux de modification à partir d’une continuation précédente |
static
Cosmos |
createForProcessingFromNow(FeedRange feedRange)
Crée un CosmosChangeFeedRequestOptions instance pour commencer à traiter les éléments de flux de modification à partir de l’heure actuelle. Ainsi, seuls les événements de toutes les modifications futures seront récupérés |
static
Cosmos |
createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)
Crée un CosmosChangeFeedRequestOptions instance pour commencer à traiter les éléments de flux de modification à partir d’un certain point dans le temps |
Cosmos |
fullFidelity()
Déprécié
utilisez allVersionsAndDeletes() à la place.
Modifie le mode de flux de modification afin que le flux de modification contienne des événements pour les créations, les suppressions ainsi que tous les instantanés intermédiaires pour les mises à jour. |
List<String> |
getExcludedRegions()
Obtient la liste des régions à exclure pour la demande/les nouvelles tentatives. |
Feed |
getFeedRange()
Obtient la plage de flux. |
int |
getMaxItemCount()
Obtient le nombre maximal d’éléments à retourner dans l’opération d’énumération. |
int |
getMaxPrefetchPageCount()
Obtient le nombre maximal de pages qui seront prérécupérées à partir du back-end de manière asynchrone en arrière-plan. |
String |
getThroughputControlGroupName()
Obtenez le nom du groupe de contrôle de débit. |
boolean |
isQuotaInfoEnabled()
Obtient le paramètre Infos |
Cosmos |
setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)
Permet de remplacer les seuils de diagnostic pour une opération spécifique. |
Cosmos |
setExcludedRegions(List<String> excludeRegions)
Liste des régions à exclure pour la demande/les nouvelles tentatives. |
Cosmos |
setMaxItemCount(int maxItemCount)
Définit le nombre maximal d’éléments à retourner dans l’opération d’énumération. |
Cosmos |
setMaxPrefetchPageCount(int maxPrefetchPageCount)
Définit le nombre maximal de pages qui seront prérécupérées à partir du back-end de manière asynchrone en arrière-plan. |
void |
setQuotaInfoEnabled(boolean quotaInfoEnabled)
Obtient le paramètre Infos |
Cosmos |
setThroughputControlGroupName(String throughputControlGroupName)
Définissez le nom du groupe de contrôle de débit. |
Méthodes héritées de java.lang.Object
Détails de la méthode
allVersionsAndDeletes
public CosmosChangeFeedRequestOptions allVersionsAndDeletes()
Modifie le mode de flux de modification afin que le flux de modification contienne des événements pour les créations, les suppressions ainsi que tous les instantanés intermédiaires pour les mises à jour. L’activation du mode de flux de modification AllVersionsAndDeletes nécessite la configuration d’une durée de rétention dans la stratégie de flux de modification du conteneur. ChangeFeedPolicy
Les instantanés intermédiaires des modifications ainsi que les documents supprimés seraient disponibles pour traitement pendant 8 minutes avant leur disparaître. Lorsque vous activez le mode AllVersionsAndDeletes, vous ne pouvez traiter les événements de flux de modification que dans la fenêtre de rétention configurée dans la stratégie de flux de modification du conteneur. Si vous tentez de traiter un flux de modification après plus de la fenêtre de rétention, une erreur (code d’état 400) est retournée, car les événements des mises à jour et suppressions intermédiaires ont disparu. Il serait toujours possible de traiter les modifications à l’aide du mode LatestVersion, même lors de la configuration d’une stratégie de flux de modification AllVersionsAndDeletes avec une fenêtre de rétention sur le conteneur. Lors de l’utilisation du mode LatestVersion, il n’est pas important que vous soyez en dehors de la fenêtre de rétention ou non, mais aucun événement pour les suppressions ou les mises à jour intermédiaires ne serait inclus. Lorsque les événements ne sont pas traités dans la fenêtre de rétention, il est également possible de continuer à traiter les événements futurs en mode AllVersionsAndDeletes en interrogeant le flux de modification avec une nouvelle instance CosmosChangeFeedRequestOptions.
Returns:
createForProcessingFromBeginning
public static CosmosChangeFeedRequestOptions createForProcessingFromBeginning(FeedRange feedRange)
Crée un CosmosChangeFeedRequestOptions instance pour commencer à traiter les éléments de flux de modification à partir du début du flux de modification
Parameters:
Returns:
createForProcessingFromContinuation
public static CosmosChangeFeedRequestOptions createForProcessingFromContinuation(String continuation)
Crée un CosmosChangeFeedRequestOptions instance pour commencer à traiter les éléments de flux de modification à partir d’une continuation précédente
Parameters:
Returns:
createForProcessingFromNow
public static CosmosChangeFeedRequestOptions createForProcessingFromNow(FeedRange feedRange)
Crée un CosmosChangeFeedRequestOptions instance pour commencer à traiter les éléments de flux de modification à partir de l’heure actuelle. Ainsi, seuls les événements de toutes les modifications futures seront récupérés
Parameters:
Returns:
createForProcessingFromPointInTime
public static CosmosChangeFeedRequestOptions createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)
Crée un CosmosChangeFeedRequestOptions instance pour commencer à traiter les éléments de flux de modification à partir d’un certain point dans le temps
Parameters:
Returns:
fullFidelity
@Deprecated
public CosmosChangeFeedRequestOptions fullFidelity()
Déprécié
Modifie le mode de flux de modification afin que le flux de modification contienne des événements pour les créations, les suppressions ainsi que tous les instantanés intermédiaires pour les mises à jour. L’activation du mode de flux de modification AllVersionsAndDeletes nécessite la configuration d’une durée de rétention dans la stratégie de flux de modification du conteneur. ChangeFeedPolicy
Des instantanés intermédiaires des modifications ainsi que des documents supprimés sont disponibles pour traitement pour la fenêtre de rétention avant qu’ils ne disparaissent. Lorsque vous activez le mode AllVersionsAndDeletes, vous ne pouvez traiter les événements de flux de modification que dans la fenêtre de rétention configurée dans la stratégie de flux de modification du conteneur. Si vous tentez de traiter un flux de modification après plus de la fenêtre de rétention, une erreur (code d’état 400) est retournée, car les événements des mises à jour et suppressions intermédiaires ont disparu. Il serait toujours possible de traiter les modifications à l’aide du mode LatestVersion, même lors de la configuration d’une stratégie de flux de modification AllVersionsAndDeletes avec une fenêtre de rétention sur le conteneur. Lors de l’utilisation du mode LatestVersion, il n’est pas important que vous soyez en dehors de la fenêtre de rétention ou non, mais aucun événement pour les suppressions ou les mises à jour intermédiaires ne serait inclus. Lorsque les événements ne sont pas traités dans la fenêtre de rétention, il est également possible de continuer à traiter les événements futurs en mode AllVersionsAndDeletes en interrogeant le flux de modification avec une nouvelle instance CosmosChangeFeedRequestOptions.
Returns:
getExcludedRegions
public List
Obtient la liste des régions à exclure pour la demande/les nouvelles tentatives. Ces régions sont exclues de la liste des régions préférées.
Returns:
getFeedRange
public FeedRange getFeedRange()
Obtient la plage de flux.
Returns:
getMaxItemCount
public int getMaxItemCount()
Obtient le nombre maximal d’éléments à retourner dans l’opération d’énumération.
Returns:
getMaxPrefetchPageCount
public int getMaxPrefetchPageCount()
Obtient le nombre maximal de pages qui seront prérécupérées à partir du back-end de manière asynchrone en arrière-plan. En pré-extrayant ces modifications, le débit de traitement des enregistrements de flux de modification peut être augmenté, car le traitement n’a pas besoin de s’arrêter en attendant que les opérations d’E/S récupèrent une nouvelle page sous forme de back-end. Le seul scénario dans lequel il peut être utile de désactiver les pages de prérécupération (avec setMaxPrefetchPageCount(0)) serait lorsque l’appelant ne prévoit de récupérer qu’une seule page, de sorte que toutes les pages prérécupérées ne seraient pas utilisées de toute façon.
Returns:
getThroughputControlGroupName
public String getThroughputControlGroupName()
Obtenez le nom du groupe de contrôle de débit.
Returns:
isQuotaInfoEnabled
public boolean isQuotaInfoEnabled()
Obtient le paramètre quotaInfoEnabled pour la demande de flux de modification dans le service de base de données Azure Cosmos DB. quotaInfoEnabled est utilisé pour activer/désactiver l’obtention des statistiques relatives au quota
Returns:
setDiagnosticsThresholds
public CosmosChangeFeedRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)
Permet de remplacer les seuils de diagnostic pour une opération spécifique.
Parameters:
Returns:
setExcludedRegions
public CosmosChangeFeedRequestOptions setExcludedRegions(List
Liste des régions à exclure pour la demande/les nouvelles tentatives. Exemple « USA Est » ou « USA Est, USA Ouest » Ces régions seront exclues de la liste des régions préférées
Parameters:
Returns:
setMaxItemCount
public CosmosChangeFeedRequestOptions setMaxItemCount(int maxItemCount)
Définit le nombre maximal d’éléments à retourner dans l’opération d’énumération.
Parameters:
Returns:
setMaxPrefetchPageCount
public CosmosChangeFeedRequestOptions setMaxPrefetchPageCount(int maxPrefetchPageCount)
Définit le nombre maximal de pages qui seront prérécupérées à partir du back-end de manière asynchrone en arrière-plan. En pré-extrayant ces modifications, le débit de traitement des enregistrements de flux de modification peut être augmenté, car le traitement n’a pas besoin de s’arrêter en attendant que les opérations d’E/S récupèrent une nouvelle page sous forme de back-end. Le seul scénario dans lequel il peut être utile de désactiver les pages de prérécupération (avec setMaxPrefetchPageCount(0)) serait lorsque l’appelant ne prévoit de récupérer qu’une seule page, de sorte que toutes les pages prérécupérées ne seraient pas utilisées de toute façon.
Parameters:
Returns:
setQuotaInfoEnabled
public void setQuotaInfoEnabled(boolean quotaInfoEnabled)
Obtient le paramètre quotaInfoEnabled pour la demande de flux de modification dans le service de base de données Azure Cosmos DB. quotaInfoEnabled est utilisé pour activer/désactiver l’obtention des statistiques relatives au quota
Parameters:
setThroughputControlGroupName
public CosmosChangeFeedRequestOptions setThroughputControlGroupName(String throughputControlGroupName)
Définissez le nom du groupe de contrôle de débit.
Parameters:
Returns:
S’applique à
Azure SDK for Java