CosmosQueryRequestOptions Classe

Paquet:

com.azure.cosmos.models

Artefact Maven:

com.azure:azure-cosmos:4.54.0

• java.lang.Object
• • com.azure.cosmos.models.CosmosQueryRequestOptions

public class CosmosQueryRequestOptions

Spécifie les options associées aux méthodes de requête (opérations d’énumération) dans le service de base de données Azure Cosmos DB.

Récapitulatif du constructeur

Constructeur	Description
CosmosQueryRequestOptions()	Instancie une nouvelle option de requête.

Résumé de la méthode

Modificateur et type	Méthode et description
ConsistencyLevel	getConsistencyLevel() Obtient le niveau de cohérence requis pour la demande.
DedicatedGatewayRequestOptions	getDedicatedGatewayRequestOptions() Obtient les options de demande de passerelle dédiée
List<String>	getExcludedRegions() Obtient la liste des régions à exclure pour la requête/les nouvelles tentatives.
FeedRange	getFeedRange() Obtient le FeedRange
int	getMaxBufferedItemCount() Obtient le nombre maximal d’éléments qui peuvent être mis en mémoire tampon côté client pendant l’exécution d’une requête parallèle.
int	getMaxDegreeOfParallelism() Obtient le nombre d’opérations simultanées exécutées côté client pendant l’exécution d’une requête parallèle.
PartitionKey	getPartitionKey() Obtient la clé de partition utilisée pour identifier la partition cible de la requête actuelle.
int	getResponseContinuationTokenLimitInKb() Obtient l’option de requête InKb limitede jetonde continuationde réponsepour les demandes de requête d’élément dans le service Azure Cosmos DB.
String	getSessionToken() Obtient le jeton de session à utiliser avec la cohérence de session.
Duration	getThresholdForDiagnosticsOnTracer() Obtient le seuilPourDiagnosticsOnTracer, si la latence sur l’opération de requête est supérieure à ce diagnostics sera envoyé à l’exportateur de télémétrie ouvert en tant qu’événements dans l’étendue de suivi de l’API CRUD de bout en bout.
String	getThroughputControlGroupName() Obtenir le nom du groupe de contrôle de débit.
boolean	isIndexMetricsEnabled() Obtient les métriques d’indexActivées, qui est utilisée pour obtenir les métriques d’index afin de comprendre comment le moteur de requête a utilisé les index existants et peut utiliser de nouveaux index potentiels.
boolean	isQueryMetricsEnabled() Obtient l’option permettant d’activer le remplissage des métriques de requête.
Boolean	isScanInQueryEnabled() Obtient l’option permettant d’autoriser l’analyse sur les requêtes qui n’ont pas pu être servies comme l’indexation a été désactivée sur les chemins demandés.
CosmosQueryRequestOptions	setConsistencyLevel(ConsistencyLevel consistencyLevel) Définit le niveau de cohérence requis pour la demande.
CosmosQueryRequestOptions	setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig) Définit le CosmosEndToEndOperationLatencyPolicyConfig à utiliser pour la demande.
CosmosQueryRequestOptions	setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions) Définit les options de demande de passerelle dédiée
CosmosQueryRequestOptions	setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds) Permet de remplacer les seuils de diagnostic pour une opération spécifique.
CosmosQueryRequestOptions	setExcludedRegions(List<String> excludeRegions) Liste des régions à exclure pour la demande/les nouvelles tentatives.
CosmosQueryRequestOptions	setFeedRange(FeedRange feedRange) Définit le FeedRange que nous voulons interroger
CosmosQueryRequestOptions	setIndexMetricsEnabled(boolean indexMetricsEnabled) Définit les métriquesd’indexActivées, qui permet d’obtenir les métriques d’index afin de comprendre comment le moteur de requête a utilisé les index existants et peut utiliser de nouveaux index potentiels.
CosmosQueryRequestOptions	setMaxBufferedItemCount(int maxBufferedItemCount) Définit le nombre maximal d’éléments qui peuvent être mis en mémoire tampon côté client pendant l’exécution d’une requête parallèle.
CosmosQueryRequestOptions	setMaxDegreeOfParallelism(int maxDegreeOfParallelism) Définit le nombre d’opérations simultanées exécutées côté client pendant l’exécution d’une requête parallèle.
CosmosQueryRequestOptions	setPartitionKey(PartitionKey partitionkey) Définit la clé de partition utilisée pour identifier la partition cible de la requête actuelle.
CosmosQueryRequestOptions	setQueryMetricsEnabled(boolean queryMetricsEnabled) Définit l’option permettant d’activer/désactiver l’obtention de métriques relatives à l’exécution de requête sur les demandes de requête d’élément.
CosmosQueryRequestOptions	setQueryName(String queryName) Définit le nom de la requête logique : cet identificateur est utilisé uniquement pour les métriques et les journaux afin de distinguer différentes requêtes dans les données de télémétrie.
CosmosQueryRequestOptions	setResponseContinuationTokenLimitInKb(int limitInKb) Définit l’optionde demande De limitede jetonsde continuationde réponse en ko pour les demandes de requête d’élément dans le service Azure Cosmos DB.
CosmosQueryRequestOptions	setScanInQueryEnabled(Boolean scanInQueryEnabled) Définit l’option permettant d’autoriser l’analyse sur les requêtes qui n’ont pas pu être servies comme l’indexation a été désactivée sur les chemins d’accès demandés.
CosmosQueryRequestOptions	setSessionToken(String sessionToken) Définit le jeton de session à utiliser avec la cohérence de session.
CosmosQueryRequestOptions	setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer) Définit le seuilPourDiagnosticsOnTracer, si la latence sur l’opération de requête est supérieure à ce diagnostics sera envoyé à l’exportateur de télémétrie ouvert en tant qu’événements dans l’étendue de suivi de l’API CRUD de bout en bout.
CosmosQueryRequestOptions	setThroughputControlGroupName(String throughputControlGroupName) Définissez le nom du groupe de contrôle de débit.

Méthodes héritées de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails du constructeur

CosmosQueryRequestOptions

public CosmosQueryRequestOptions()

Instancie une nouvelle option de requête.

Détails de la méthode

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Obtient le niveau de cohérence requis pour la demande.

Returns:

niveau de cohérence.

getDedicatedGatewayRequestOptions

public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()

Obtient les options de demande de passerelle dédiée

Returns:

options de demande de passerelle dédiée

getExcludedRegions

public List getExcludedRegions()

Obtient la liste des régions à exclure pour la requête/les nouvelles tentatives. Ces régions sont exclues de la liste des régions par défaut.

Returns:

liste des régions exclues

getFeedRange

public FeedRange getFeedRange()

Obtient le FeedRange

Returns:

Lla FeedRange

getMaxBufferedItemCount

public int getMaxBufferedItemCount()

Obtient le nombre maximal d’éléments qui peuvent être mis en mémoire tampon côté client pendant l’exécution d’une requête parallèle.

Returns:

nombre maximal d’éléments qui peuvent être mis en mémoire tampon côté client pendant l’exécution d’une requête parallèle.

getMaxDegreeOfParallelism

public int getMaxDegreeOfParallelism()

Obtient le nombre d’opérations simultanées exécutées côté client pendant l’exécution d’une requête parallèle.

Returns:

nombre d’opérations simultanées exécutées côté client pendant l’exécution d’une requête parallèle.

getPartitionKey

public PartitionKey getPartitionKey()

Obtient la clé de partition utilisée pour identifier la partition cible de la requête actuelle.

Returns:

clé de partition.

getResponseContinuationTokenLimitInKb

public int getResponseContinuationTokenLimitInKb()

Obtient l’option de requête ResponseContinuationTokenLimitInKb pour les demandes de requête d’élément dans le service Azure Cosmos DB. Si ce n’est pas déjà défini, retourne 0.

ResponseContinuationTokenLimitInKb est utilisé pour limiter la longueur du jeton de continuation dans la réponse de requête. Les valeurs valides sont >= 1.

Returns:

jeu de retour ResponseContinuationTokenLimitInKb, ou 0 si ce n’est pas défini

getSessionToken

public String getSessionToken()

Obtient le jeton de session à utiliser avec la cohérence de session.

Returns:

jeton de session.

getThresholdForDiagnosticsOnTracer

public Duration getThresholdForDiagnosticsOnTracer()

Obtient le thresholdForDiagnosticsOnTracer, si la latence sur l’opération de requête est supérieure à ce diagnostics sera envoyé à l’exportateur de télémétrie ouvert en tant qu’événements dans l’étendue de suivi de l’API CRUD de bout en bout. La valeur par défaut est de 500 ms.

Returns:

thresholdForDiagnosticsOnTracer le seuil de latence pour diagnostics sur le traceur.

getThroughputControlGroupName

public String getThroughputControlGroupName()

Obtenir le nom du groupe de contrôle de débit.

Returns:

Nom du groupe de contrôle de débit.

isIndexMetricsEnabled

public boolean isIndexMetricsEnabled()

Obtient indexMetricsEnabled, qui est utilisé pour obtenir les métriques d’index afin de comprendre comment le moteur de requête a utilisé des index existants et peut utiliser de nouveaux index potentiels. Les résultats s’affichent dans QueryMetrics. Notez que ces options entraînent une surcharge. Elles doivent donc être activées lors du débogage des requêtes lentes.

Returns:

indexMetricsEnabled (valeur par défaut : false)

isQueryMetricsEnabled

public boolean isQueryMetricsEnabled()

Obtient l’option permettant d’activer le remplissage des métriques de requête. Par défaut, les métriques de requête sont activées.

Returns:

indique s’il faut activer les métriques de requête de remplissage (valeur par défaut : true)

isScanInQueryEnabled

public Boolean isScanInQueryEnabled()

Obtient l’option permettant d’autoriser l’analyse sur les requêtes qui n’ont pas pu être servies comme l’indexation a été désactivée sur les chemins demandés.

Returns:

l’option d’activer l’analyse dans la requête.

setConsistencyLevel

public CosmosQueryRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)

Définit le niveau de cohérence requis pour la demande. Le niveau de cohérence effectif ne peut être réduit que pour les demandes de lecture/requête. Ainsi, lorsque le niveau de cohérence par défaut du compte est par exemple session, vous pouvez spécifier sur un niveau requête par demande pour les requêtes individuelles que la cohérence éventuelle est suffisante, ce qui peut réduire les frais de latence et de RU pour cette demande, mais ne garantit plus la cohérence de session (lecture de votre propre écriture)

Parameters:

consistencyLevel - niveau de cohérence.

Returns:

CosmosItemRequestOptions.

setCosmosEndToEndOperationLatencyPolicyConfig

public CosmosQueryRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)

Définit le CosmosEndToEndOperationLatencyPolicyConfig à utiliser pour la demande. Si la configuration est déjà définie * sur le client, cela remplacera la configuration au niveau du client pour cette demande

Parameters:

cosmosEndToEndOperationLatencyPolicyConfig - Lla CosmosEndToEndOperationLatencyPolicyConfig

Returns:

CosmosQueryRequestOptions

setDedicatedGatewayRequestOptions

public CosmosQueryRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)

Définit les options de demande de passerelle dédiée

Parameters:

dedicatedGatewayRequestOptions - Options de demande de passerelle dédiée

Returns:

CosmosQueryRequestOptions

setDiagnosticsThresholds

public CosmosQueryRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

Permet de remplacer les seuils de diagnostic pour une opération spécifique.

Parameters:

operationSpecificThresholds - Remplacement du seuil de diagnostic pour cette opération

Returns:

CosmosQueryRequestOptions.

setExcludedRegions

public CosmosQueryRequestOptions setExcludedRegions(List excludeRegions)

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:

excludeRegions - régions à exclure

Returns:

Lla CosmosQueryRequestOptions

setFeedRange

public CosmosQueryRequestOptions setFeedRange(FeedRange feedRange)

Définit le FeedRange que nous voulons interroger

Parameters:

feedRange - Lla FeedRange

Returns:

CosmosQueryRequestOptions.

setIndexMetricsEnabled

public CosmosQueryRequestOptions setIndexMetricsEnabled(boolean indexMetricsEnabled)

Définit indexMetricsEnabled, qui est utilisé pour obtenir les métriques d’index afin de comprendre comment le moteur de requête a utilisé des index existants et peut utiliser de nouveaux index potentiels. Les résultats s’affichent dans QueryMetrics. Notez que ces options entraînent une surcharge. Elles doivent donc être activées lors du débogage de requêtes lentes. Par défaut, indexMetrics est désactivé.

Parameters:

indexMetricsEnabled - booléen utilisé pour obtenir les métriques d’index

Returns:

indexMetricsEnabled

setMaxBufferedItemCount

public CosmosQueryRequestOptions setMaxBufferedItemCount(int maxBufferedItemCount)

Définit le nombre maximal d’éléments qui peuvent être mis en mémoire tampon côté client pendant l’exécution d’une requête parallèle.

Parameters:

maxBufferedItemCount - nombre maximal d’éléments.

Returns:

CosmosQueryRequestOptions.

setMaxDegreeOfParallelism

public CosmosQueryRequestOptions setMaxDegreeOfParallelism(int maxDegreeOfParallelism)

Définit le nombre d’opérations simultanées exécutées côté client pendant l’exécution d’une requête parallèle.

Parameters:

maxDegreeOfParallelism - nombre d’opérations simultanées.

Returns:

CosmosQueryRequestOptions.

setPartitionKey

public CosmosQueryRequestOptions setPartitionKey(PartitionKey partitionkey)

Définit la clé de partition utilisée pour identifier la partition cible de la requête actuelle.

Parameters:

partitionkey - valeur de clé de partition.

Returns:

CosmosQueryRequestOptions.

setQueryMetricsEnabled

public CosmosQueryRequestOptions setQueryMetricsEnabled(boolean queryMetricsEnabled)

Définit l’option permettant d’activer/désactiver l’obtention de métriques relatives à l’exécution de requête sur les demandes de requête d’élément. Par défaut, les métriques de requête sont activées.

Parameters:

queryMetricsEnabled - si vous souhaitez activer ou désactiver les métriques de requête

Returns:

CosmosQueryRequestOptions.

setQueryName

public CosmosQueryRequestOptions setQueryName(String queryName)

Définit le nom de la requête logique : cet identificateur est utilisé uniquement pour les métriques et les journaux afin de distinguer différentes requêtes dans les données de télémétrie. La cardinalité des valeurs uniques pour queryName doit être raisonnablement faible, comme beaucoup plus petite que 100.

Parameters:

queryName - un nom de requête logique pour distinguer ce modèle de requête des autres

Returns:

nom de la requête logique

setResponseContinuationTokenLimitInKb

public CosmosQueryRequestOptions setResponseContinuationTokenLimitInKb(int limitInKb)

Définit l’option de requête ResponseContinuationTokenLimitInKb pour les demandes de requête d’élément dans le service Azure Cosmos DB.

ResponseContinuationTokenLimitInKb est utilisé pour limiter la longueur du jeton de continuation dans la réponse à la requête. Les valeurs valides sont >= 1.

Le jeton de continuation contient à la fois les champs obligatoires et facultatifs. Les champs obligatoires sont nécessaires pour reprendre l’exécution à partir de laquelle elle a été mise en place. Les champs facultatifs peuvent contenir un travail de recherche d’index sérialisé qui a été effectué mais qui n’a pas encore été utilisé. Cela évite de refaire le travail dans les continuations suivantes et, par conséquent, améliore les performances des requêtes. Si vous définissez la taille de continuation maximale sur 1 Ko, le service Azure Cosmos DB sérialise uniquement les champs obligatoires. À partir de 2 Ko, le service Azure Cosmos DB sérialise autant qu’il peut le faire jusqu’à ce qu’il atteigne la taille maximale spécifiée.

Parameters:

limitInKb - limite de taille de jeton de continuation.

Returns:

CosmosQueryRequestOptions.

setScanInQueryEnabled

public CosmosQueryRequestOptions setScanInQueryEnabled(Boolean scanInQueryEnabled)

Définit l’option permettant d’autoriser l’analyse sur les requêtes qui n’ont pas pu être servies comme l’indexation a été désactivée sur les chemins d’accès demandés.

Parameters:

scanInQueryEnabled - l’option d’activer l’analyse dans la requête.

Returns:

CosmosQueryRequestOptions.

setSessionToken

public CosmosQueryRequestOptions setSessionToken(String sessionToken)

Définit le jeton de session à utiliser avec la cohérence de session.

Parameters:

sessionToken - jeton de session.

Returns:

CosmosQueryRequestOptions.

setThresholdForDiagnosticsOnTracer

public CosmosQueryRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)

Définit le paramètre thresholdForDiagnosticsOnTracer, si la latence sur l’opération de requête est supérieure à ce diagnostics sera envoyé à l’exportateur de télémétrie ouvert en tant qu’événements dans l’étendue de suivi de l’API CRUD de bout en bout. La valeur par défaut est 500 ms

Parameters:

thresholdForDiagnosticsOnTracer - le seuil de latence pour diagnostics sur le traceur.

Returns:

CosmosQueryRequestOptions

setThroughputControlGroupName

public CosmosQueryRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

Définissez le nom du groupe de contrôle de débit.

Parameters:

throughputControlGroupName - Nom du groupe de contrôle de débit.

Returns:

Un CosmosQueryRequestOptions.