CosmosQueryRequestOptions Clase

Paquete:

com.azure.cosmos.models

Artefacto Maven:

com.azure:azure-cosmos:4.54.0

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

public class CosmosQueryRequestOptions

Especifica las opciones asociadas a métodos de consulta (operaciones de enumeración) en el servicio de base de datos de Azure Cosmos DB.

Resumen del constructor

Constructor	Description
CosmosQueryRequestOptions()	Crea una instancia de una nueva opción de solicitud de consulta.

Resumen del método

Modificador y tipo	Método y descripción
ConsistencyLevel	getConsistencyLevel() Obtiene el nivel de coherencia necesario para la solicitud.
DedicatedGatewayRequestOptions	getDedicatedGatewayRequestOptions() Obtiene las opciones de solicitud de puerta de enlace dedicada.
List<String>	getExcludedRegions() Obtiene la lista de regiones que se van a excluir para la solicitud o reintentos.
FeedRange	getFeedRange() Obtiene el FeedRange
int	getMaxBufferedItemCount() Obtiene el número máximo de elementos que se pueden almacenar en búfer en el lado cliente durante la ejecución de consultas paralelas.
int	getMaxDegreeOfParallelism() Obtiene el número de operaciones simultáneas que ejecutan el lado cliente durante la ejecución de consultas paralelas.
PartitionKey	getPartitionKey() Obtiene la clave de partición usada para identificar la partición de destino de la solicitud actual.
int	getResponseContinuationTokenLimitInKb() Obtiene la opción de solicitud Límitede tokende continuaciónde respuestaInKb para las solicitudes de consulta de elementos en el servicio Azure Cosmos DB.
String	getSessionToken() Obtiene el token de sesión para su uso con coherencia de sesión.
Duration	getThresholdForDiagnosticsOnTracer() Obtiene el umbralparaDiagnosticsOnTracer, si la latencia en la operación de consulta es mayor que este diagnóstico se enviará para abrir el exportador de telemetría como eventos en el intervalo de seguimiento de la API CRUD de un extremo a otro.
String	getThroughputControlGroupName() Obtiene el nombre del grupo de control de rendimiento.
boolean	isIndexMetricsEnabled() Obtiene las métricas de índicehabilitadas, que se usan para obtener las métricas de índice para comprender cómo el motor de consultas usó índices existentes y podría usar posibles índices nuevos.
boolean	isQueryMetricsEnabled() Obtiene la opción para habilitar la rellenación de métricas de consulta.
Boolean	isScanInQueryEnabled() Obtiene la opción de permitir el examen en las consultas que no se pudieron servir como indexación en las rutas de acceso solicitadas.
CosmosQueryRequestOptions	setConsistencyLevel(ConsistencyLevel consistencyLevel) Establece el nivel de coherencia necesario para la solicitud.
CosmosQueryRequestOptions	setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig) Establece el objeto CosmosEndToEndOperationLatencyPolicyConfig que se va a usar para la solicitud.
CosmosQueryRequestOptions	setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions) Establece las opciones de solicitud de puerta de enlace dedicada
CosmosQueryRequestOptions	setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds) Permite invalidar los umbrales de diagnóstico para una operación específica.
CosmosQueryRequestOptions	setExcludedRegions(List<String> excludeRegions) Lista de regiones que se van a excluir para la solicitud o reintentos.
CosmosQueryRequestOptions	setFeedRange(FeedRange feedRange) Establece el FeedRange objeto que queremos consultar.
CosmosQueryRequestOptions	setIndexMetricsEnabled(boolean indexMetricsEnabled) Establece las métricas de índicehabilitadas, que se usan para obtener las métricas de índice para comprender cómo el motor de consultas usó índices existentes y podría usar posibles índices nuevos.
CosmosQueryRequestOptions	setMaxBufferedItemCount(int maxBufferedItemCount) Establece el número máximo de elementos que se pueden almacenar en búfer en el lado cliente durante la ejecución de consultas paralelas.
CosmosQueryRequestOptions	setMaxDegreeOfParallelism(int maxDegreeOfParallelism) Establece el número de operaciones simultáneas que ejecutan el lado cliente durante la ejecución de consultas paralelas.
CosmosQueryRequestOptions	setPartitionKey(PartitionKey partitionkey) Establece la clave de partición usada para identificar la partición de destino de la solicitud actual.
CosmosQueryRequestOptions	setQueryMetricsEnabled(boolean queryMetricsEnabled) Establece la opción para habilitar o deshabilitar la obtención de métricas relacionadas con la ejecución de consultas en las solicitudes de consulta de elementos.
CosmosQueryRequestOptions	setQueryName(String queryName) Establece el nombre de la consulta lógica: este identificador solo se usa para las métricas y los registros para distinguir las distintas consultas de telemetría.
CosmosQueryRequestOptions	setResponseContinuationTokenLimitInKb(int limitInKb) Establece la opción de solicitud Límitede tokende continuaciónde respuestaInKb para las solicitudes de consulta de elementos en el servicio Azure Cosmos DB.
CosmosQueryRequestOptions	setScanInQueryEnabled(Boolean scanInQueryEnabled) Establece la opción para permitir el examen en las consultas que no se pudieron servir como indexación se optó por no participar en las rutas de acceso solicitadas.
CosmosQueryRequestOptions	setSessionToken(String sessionToken) Establece el token de sesión para su uso con coherencia de sesión.
CosmosQueryRequestOptions	setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer) Establece el umbralparaDiagnosticsOnTracer, si la latencia en la operación de consulta es mayor que este diagnóstico se enviará para abrir el exportador de telemetría como eventos en el intervalo de seguimiento de la API CRUD de un extremo a otro.
CosmosQueryRequestOptions	setThroughputControlGroupName(String throughputControlGroupName) Establezca el nombre del grupo de control de rendimiento.

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del constructor

CosmosQueryRequestOptions

public CosmosQueryRequestOptions()

Crea una instancia de una nueva opción de solicitud de consulta.

Detalles del método

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Obtiene el nivel de coherencia necesario para la solicitud.

Returns:

el nivel de coherencia.

getDedicatedGatewayRequestOptions

public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()

Obtiene las opciones de solicitud de puerta de enlace dedicada.

Returns:

Las opciones de solicitud de puerta de enlace dedicada

getExcludedRegions

public List getExcludedRegions()

Obtiene la lista de regiones que se van a excluir para la solicitud o reintentos. Estas regiones se excluyen de la lista de regiones preferidas.

Returns:

una lista de regiones excluidas

getFeedRange

public FeedRange getFeedRange()

Obtiene el FeedRange

Returns:

el FeedRange

getMaxBufferedItemCount

public int getMaxBufferedItemCount()

Obtiene el número máximo de elementos que se pueden almacenar en búfer en el lado cliente durante la ejecución de consultas paralelas.

Returns:

número máximo de elementos que se pueden almacenar en búfer en el lado cliente durante la ejecución de consultas paralelas.

getMaxDegreeOfParallelism

public int getMaxDegreeOfParallelism()

Obtiene el número de operaciones simultáneas que ejecutan el lado cliente durante la ejecución de consultas paralelas.

Returns:

número de operaciones simultáneas que ejecutan el lado cliente durante la ejecución de consultas paralelas.

getPartitionKey

public PartitionKey getPartitionKey()

Obtiene la clave de partición usada para identificar la partición de destino de la solicitud actual.

Returns:

la clave de partición.

getResponseContinuationTokenLimitInKb

public int getResponseContinuationTokenLimitInKb()

Obtiene la opción de solicitud ResponseContinuationTokenLimitInKb para las solicitudes de consulta de elementos en el servicio Azure Cosmos DB. Si aún no se ha establecido, devuelve 0.

ResponseContinuationTokenLimitInKb se usa para limitar la longitud del token de continuación en la respuesta de la consulta. Los valores válidos son >= 1.

Returns:

return set ResponseContinuationTokenLimitInKb, o 0 si no se establece

getSessionToken

public String getSessionToken()

Obtiene el token de sesión para su uso con coherencia de sesión.

Returns:

token de sesión.

getThresholdForDiagnosticsOnTracer

public Duration getThresholdForDiagnosticsOnTracer()

Obtiene el umbralForDiagnosticsOnTracer, si la latencia en la operación de consulta es mayor que este diagnóstico se enviará para abrir el exportador de telemetría como eventos en el intervalo de seguimiento de la API CRUD de un extremo a otro. El valor predeterminado es 500 ms.

Returns:

thresholdForDiagnosticsOnTracer el umbral de latencia para diagnósticos en tracer.

getThroughputControlGroupName

public String getThroughputControlGroupName()

Obtiene el nombre del grupo de control de rendimiento.

Returns:

Nombre del grupo de control de rendimiento.

isIndexMetricsEnabled

public boolean isIndexMetricsEnabled()

Obtiene indexMetricsEnabled, que se usa para obtener las métricas de índice para comprender cómo el motor de consultas usó índices existentes y podría usar posibles índices nuevos. Los resultados se mostrarán en QueryMetrics. Tenga en cuenta que estas opciones incurrirán en sobrecarga, por lo que debe habilitarse al depurar consultas lentas.

Returns:

indexMetricsEnabled (valor predeterminado: false)

isQueryMetricsEnabled

public boolean isQueryMetricsEnabled()

Obtiene la opción para habilitar la rellenación de métricas de consulta. De forma predeterminada, las métricas de consulta están habilitadas.

Returns:

si se va a habilitar la rellenación de métricas de consulta (valor predeterminado: true)

isScanInQueryEnabled

public Boolean isScanInQueryEnabled()

Obtiene la opción de permitir el examen en las consultas que no se pudieron servir como indexación en las rutas de acceso solicitadas.

Returns:

la opción de habilitar el examen en la consulta.

setConsistencyLevel

public CosmosQueryRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)

Establece el nivel de coherencia necesario para la solicitud. El nivel de coherencia eficaz solo se puede reducir para las solicitudes de lectura y consulta. Por lo tanto, cuando el nivel de coherencia predeterminado de la cuenta es, por ejemplo, Sesión, puede especificar en un nivel de solicitud por solicitud para solicitudes individuales que la coherencia final es suficiente, lo que podría reducir la latencia y los cargos de RU para esta solicitud, pero ya no garantizará la coherencia de la sesión (lectura de su propia escritura).

Parameters:

consistencyLevel - el nivel de coherencia.

Returns:

CosmosItemRequestOptions.

setCosmosEndToEndOperationLatencyPolicyConfig

public CosmosQueryRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)

Establece el objeto CosmosEndToEndOperationLatencyPolicyConfig que se va a usar para la solicitud. Si la configuración ya está establecida * en el cliente, esto invalidará la configuración de nivel de cliente para esta solicitud.

Parameters:

cosmosEndToEndOperationLatencyPolicyConfig - el CosmosEndToEndOperationLatencyPolicyConfig

Returns:

CosmosQueryRequestOptions

setDedicatedGatewayRequestOptions

public CosmosQueryRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)

Establece las opciones de solicitud de puerta de enlace dedicada

Parameters:

dedicatedGatewayRequestOptions - Opciones de solicitud de puerta de enlace dedicada

Returns:

CosmosQueryRequestOptions

setDiagnosticsThresholds

public CosmosQueryRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

Permite invalidar los umbrales de diagnóstico para una operación específica.

Parameters:

operationSpecificThresholds - invalidación del umbral de diagnóstico para esta operación

Returns:

CosmosQueryRequestOptions.

setExcludedRegions

public CosmosQueryRequestOptions setExcludedRegions(List excludeRegions)

Lista de regiones que se van a excluir para la solicitud o reintentos. Ejemplo "Este de EE. UU." o "Este de EE. UU., Oeste de EE. UU." Estas regiones se excluirán de la lista de regiones preferidas.

Parameters:

excludeRegions - las regiones que se van a excluir

Returns:

el CosmosQueryRequestOptions

setFeedRange

public CosmosQueryRequestOptions setFeedRange(FeedRange feedRange)

Establece el FeedRange objeto que queremos consultar.

Parameters:

feedRange - el FeedRange

Returns:

CosmosQueryRequestOptions.

setIndexMetricsEnabled

public CosmosQueryRequestOptions setIndexMetricsEnabled(boolean indexMetricsEnabled)

Establece indexMetricsEnabled, que se usa para obtener las métricas de índice para comprender cómo el motor de consultas usó índices existentes y podría usar posibles índices nuevos. Los resultados se mostrarán en QueryMetrics. Tenga en cuenta que estas opciones incurrirán en sobrecarga, por lo que debe habilitarse al depurar consultas lentas. De forma predeterminada, indexMetrics está deshabilitado.

Parameters:

indexMetricsEnabled - un valor booleano usado para obtener las métricas de índice

Returns:

indexMetricsEnabled

setMaxBufferedItemCount

public CosmosQueryRequestOptions setMaxBufferedItemCount(int maxBufferedItemCount)

Establece el número máximo de elementos que se pueden almacenar en búfer en el lado cliente durante la ejecución de consultas paralelas.

Parameters:

maxBufferedItemCount - número máximo de elementos.

Returns:

CosmosQueryRequestOptions.

setMaxDegreeOfParallelism

public CosmosQueryRequestOptions setMaxDegreeOfParallelism(int maxDegreeOfParallelism)

Establece el número de operaciones simultáneas que ejecutan el lado cliente durante la ejecución de consultas paralelas.

Parameters:

maxDegreeOfParallelism - número de operaciones simultáneas.

Returns:

CosmosQueryRequestOptions.

setPartitionKey

public CosmosQueryRequestOptions setPartitionKey(PartitionKey partitionkey)

Establece la clave de partición usada para identificar la partición de destino de la solicitud actual.

Parameters:

partitionkey - el valor de la clave de partición.

Returns:

CosmosQueryRequestOptions.

setQueryMetricsEnabled

public CosmosQueryRequestOptions setQueryMetricsEnabled(boolean queryMetricsEnabled)

Establece la opción para habilitar o deshabilitar la obtención de métricas relacionadas con la ejecución de consultas en las solicitudes de consulta de elementos. De forma predeterminada, las métricas de consulta están habilitadas.

Parameters:

queryMetricsEnabled - si se habilitan o deshabilitan las métricas de consulta

Returns:

CosmosQueryRequestOptions.

setQueryName

public CosmosQueryRequestOptions setQueryName(String queryName)

Establece el nombre de la consulta lógica: este identificador solo se usa para las métricas y los registros para distinguir las distintas consultas de telemetría. La cardinalidad de los valores únicos para queryName debe ser razonablemente baja, como significativamente menor que 100.

Parameters:

queryName - un nombre de consulta lógico para distinguir este patrón de consulta de otros

Returns:

el nombre de la consulta lógica

setResponseContinuationTokenLimitInKb

public CosmosQueryRequestOptions setResponseContinuationTokenLimitInKb(int limitInKb)

Establece la opción de solicitud ResponseContinuationTokenLimitInKb para las solicitudes de consulta de elementos en el servicio Azure Cosmos DB.

ResponseContinuationTokenLimitInKb se usa para limitar la longitud del token de continuación en la respuesta de la consulta. Los valores válidos son >= 1.

El token de continuación contiene campos obligatorios y opcionales. Los campos obligatorios son necesarios para reanudar la ejecución desde donde se robó. Los campos opcionales pueden contener trabajos de búsqueda de índices serializados que se realizaron pero que aún no se han utilizado. Esto evita volver a poner al día el trabajo en continuaciones posteriores y, por tanto, mejorar el rendimiento de las consultas. Si se establece el tamaño máximo de continuación en 1 KB, el servicio Azure Cosmos DB solo serializará los campos necesarios. A partir de 2 KB, el servicio Azure Cosmos DB serializaría tanto como pudiera caber hasta que alcance el tamaño máximo especificado.

Parameters:

limitInKb - límite de tamaño del token de continuación.

Returns:

CosmosQueryRequestOptions.

setScanInQueryEnabled

public CosmosQueryRequestOptions setScanInQueryEnabled(Boolean scanInQueryEnabled)

Establece la opción para permitir el examen en las consultas que no se pudieron servir como indexación se optó por no participar en las rutas de acceso solicitadas.

Parameters:

scanInQueryEnabled - la opción de habilitar el examen en la consulta.

Returns:

CosmosQueryRequestOptions.

setSessionToken

public CosmosQueryRequestOptions setSessionToken(String sessionToken)

Establece el token de sesión para su uso con coherencia de sesión.

Parameters:

sessionToken - token de sesión.

Returns:

CosmosQueryRequestOptions.

setThresholdForDiagnosticsOnTracer

public CosmosQueryRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)

Establece thresholdForDiagnosticsOnTracer, si la latencia en la operación de consulta es mayor que este diagnóstico se enviará para abrir el exportador de telemetría como eventos en el intervalo de seguimiento de la API CRUD de un extremo a otro. El valor predeterminado es 500 ms

Parameters:

thresholdForDiagnosticsOnTracer - el umbral de latencia para los diagnósticos en el seguimiento.

Returns:

CosmosQueryRequestOptions

setThroughputControlGroupName

public CosmosQueryRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

Establezca el nombre del grupo de control de rendimiento.

Parameters:

throughputControlGroupName - Nombre del grupo de control de rendimiento.

Returns:

Un objeto CosmosQueryRequestOptions.