CosmosQueryRequestOptions Classe

Pacote:

com.azure.cosmos.models

Artefato Maven:

com.azure:azure-cosmos:4.54.0

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

public class CosmosQueryRequestOptions

Especifica as opções associadas aos métodos de consulta (operações de enumeração) no serviço de banco de dados do Azure Cosmos DB.

Resumo do Construtor

Construtor	Description
CosmosQueryRequestOptions()	Cria uma instância de novas opções de solicitação de consulta.

Resumo do método

Modificador e tipo	Método e descrição
ConsistencyLevel	getConsistencyLevel() Obtém o nível de consistência necessário para a solicitação.
DedicatedGatewayRequestOptions	getDedicatedGatewayRequestOptions() Obtém as opções de solicitação de gateway dedicado
List<String>	getExcludedRegions() Obtém a lista de regiões a serem excluídas para a solicitação/novas tentativas.
FeedRange	getFeedRange() Obtém FeedRange
int	getMaxBufferedItemCount() Obtém o número máximo de itens que podem ser armazenados em buffer no lado do cliente durante a execução de consulta paralela.
int	getMaxDegreeOfParallelism() Obtém o número de operações simultâneas executadas no lado do cliente durante a execução de consulta paralela.
PartitionKey	getPartitionKey() Obtém a chave de partição usada para identificar a partição de destino da solicitação atual.
int	getResponseContinuationTokenLimitInKb() Obtém a opção de solicitação InKb limitede tokende continuaçãode respostapara solicitações de consulta de item no serviço do Azure Cosmos DB.
String	getSessionToken() Obtém o token de sessão para uso com consistência de sessão.
Duration	getThresholdForDiagnosticsOnTracer() Obtém o limiteparao OnTracer de Diagnóstico, se a latência na operação de consulta for maior do que essa diagnóstico será enviada para abrir o exportador de telemetria como eventos no intervalo de rastreamento da api CRUD de ponta a ponta.
String	getThroughputControlGroupName() Obter o nome do grupo de controle de taxa de transferência.
boolean	isIndexMetricsEnabled() Obtém as métricasde índiceHabilitadas, que é usada para obter as métricas de índice para entender como o mecanismo de consulta usava índices existentes e poderia usar possíveis novos índices.
boolean	isQueryMetricsEnabled() Obtém a opção de habilitar o preenchimento de métricas de consulta.
Boolean	isScanInQueryEnabled() Obtém a opção de permitir a verificação nas consultas que não puderam ser atendidas, pois a indexação foi recusada nos caminhos solicitados.
CosmosQueryRequestOptions	setConsistencyLevel(ConsistencyLevel consistencyLevel) Define o nível de consistência necessário para a solicitação.
CosmosQueryRequestOptions	setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig) Define o CosmosEndToEndOperationLatencyPolicyConfig a ser usado para a solicitação.
CosmosQueryRequestOptions	setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions) Define as opções de solicitação de gateway dedicado
CosmosQueryRequestOptions	setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds) Permite substituir os limites de diagnóstico para uma operação específica.
CosmosQueryRequestOptions	setExcludedRegions(List<String> excludeRegions) Lista de regiões a serem excluídas para a solicitação/repetições.
CosmosQueryRequestOptions	setFeedRange(FeedRange feedRange) Define o FeedRange que queremos consultar
CosmosQueryRequestOptions	setIndexMetricsEnabled(boolean indexMetricsEnabled) Define o índiceMétricasHabilitadas, que é usado para obter as métricas de índice para entender como o mecanismo de consulta usava índices existentes e poderia usar possíveis novos índices.
CosmosQueryRequestOptions	setMaxBufferedItemCount(int maxBufferedItemCount) Define o número máximo de itens que podem ser armazenados em buffer no lado do cliente durante a execução de consulta paralela.
CosmosQueryRequestOptions	setMaxDegreeOfParallelism(int maxDegreeOfParallelism) Define o número de operações simultâneas que executam o lado do cliente durante a execução de consulta paralela.
CosmosQueryRequestOptions	setPartitionKey(PartitionKey partitionkey) Define a chave de partição usada para identificar a partição de destino da solicitação atual.
CosmosQueryRequestOptions	setQueryMetricsEnabled(boolean queryMetricsEnabled) Define a opção para habilitar/desabilitar a obtenção de métricas relacionadas à execução da consulta em solicitações de consulta de item.
CosmosQueryRequestOptions	setQueryName(String queryName) Define o nome da consulta lógica – esse identificador só é usado para métricas e logs para distinguir consultas diferentes na telemetria.
CosmosQueryRequestOptions	setResponseContinuationTokenLimitInKb(int limitInKb) Define a opção de solicitação InKb Limitede Tokende Continuaçãode Respostapara solicitações de consulta de item no serviço do Azure Cosmos DB.
CosmosQueryRequestOptions	setScanInQueryEnabled(Boolean scanInQueryEnabled) Define a opção para permitir a verificação nas consultas que não puderam ser atendidas, pois a indexação foi recusada nos caminhos solicitados.
CosmosQueryRequestOptions	setSessionToken(String sessionToken) Define o token de sessão para uso com consistência de sessão.
CosmosQueryRequestOptions	setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer) Define o limiteparao OnTracer de Diagnóstico, se a latência na operação de consulta for maior do que essa diagnóstico será enviada para abrir o exportador de telemetria como eventos no intervalo de rastreamento da API CRUD de ponta a ponta.
CosmosQueryRequestOptions	setThroughputControlGroupName(String throughputControlGroupName) Defina o nome do grupo de controle de taxa de transferência.

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do construtor

CosmosQueryRequestOptions

public CosmosQueryRequestOptions()

Cria uma instância de novas opções de solicitação de consulta.

Detalhes do método

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Obtém o nível de consistência necessário para a solicitação.

Returns:

o nível de consistência.

getDedicatedGatewayRequestOptions

public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()

Obtém as opções de solicitação de gateway dedicado

Returns:

as Opções de Solicitação de Gateway Dedicado

getExcludedRegions

public List getExcludedRegions()

Obtém a lista de regiões a serem excluídas para a solicitação/novas tentativas. Essas regiões são excluídas da lista de regiões preferenciais.

Returns:

uma lista de regiões excluídas

getFeedRange

public FeedRange getFeedRange()

Obtém FeedRange

Returns:

O FeedRange

getMaxBufferedItemCount

public int getMaxBufferedItemCount()

Obtém o número máximo de itens que podem ser armazenados em buffer no lado do cliente durante a execução de consulta paralela.

Returns:

número máximo de itens que podem ser armazenados em buffer no lado do cliente durante a execução de consulta paralela.

getMaxDegreeOfParallelism

public int getMaxDegreeOfParallelism()

Obtém o número de operações simultâneas executadas no lado do cliente durante a execução de consulta paralela.

Returns:

número de operações simultâneas que executam o lado do cliente durante a execução de consulta paralela.

getPartitionKey

public PartitionKey getPartitionKey()

Obtém a chave de partição usada para identificar a partição de destino da solicitação atual.

Returns:

a chave de partição.

getResponseContinuationTokenLimitInKb

public int getResponseContinuationTokenLimitInKb()

Obtém a opção de solicitação ResponseContinuationTokenLimitInKb para solicitações de consulta de item no serviço do Azure Cosmos DB. Se ainda não estiver definido, retornará 0.

ResponseContinuationTokenLimitInKb é usado para limitar o comprimento do token de continuação na resposta da consulta. Os valores válidos são >= 1.

Returns:

return set ResponseContinuationTokenLimitInKb ou 0 se não estiver definido

getSessionToken

public String getSessionToken()

Obtém o token de sessão para uso com consistência de sessão.

Returns:

o token de sessão.

getThresholdForDiagnosticsOnTracer

public Duration getThresholdForDiagnosticsOnTracer()

Obtém o thresholdForDiagnosticsOnTracer, se a latência na operação de consulta for maior do que essa diagnóstico será enviada para abrir o exportador de telemetria como eventos no intervalo de rastreamento da api CRUD de ponta a ponta. O padrão é 500 ms.

Returns:

thresholdForDiagnosticsOnTracer o limite de latência para diagnóstico no rastreador.

getThroughputControlGroupName

public String getThroughputControlGroupName()

Obter o nome do grupo de controle de taxa de transferência.

Returns:

O nome do grupo de controle de taxa de transferência.

isIndexMetricsEnabled

public boolean isIndexMetricsEnabled()

Obtém indexMetricsEnabled, que é usado para obter as métricas de índice para entender como o mecanismo de consulta usava índices existentes e poderia usar possíveis novos índices. Os resultados serão exibidos em QueryMetrics. Observe que essas opções causarão sobrecarga, portanto, elas devem ser habilitadas ao depurar consultas lentas.

Returns:

indexMetricsEnabled (padrão: false)

isQueryMetricsEnabled

public boolean isQueryMetricsEnabled()

Obtém a opção de habilitar o preenchimento de métricas de consulta. Por padrão, as métricas de consulta estão habilitadas.

Returns:

se deseja habilitar o preenchimento de métricas de consulta (padrão: true)

isScanInQueryEnabled

public Boolean isScanInQueryEnabled()

Obtém a opção de permitir a verificação nas consultas que não puderam ser atendidas, pois a indexação foi recusada nos caminhos solicitados.

Returns:

a opção de habilitar a verificação na consulta.

setConsistencyLevel

public CosmosQueryRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)

Define o nível de consistência necessário para a solicitação. O nível de consistência eficaz só pode ser reduzido para solicitações de leitura/consulta. Portanto, quando o nível de consistência padrão da Conta é, por exemplo, Sessão, você pode especificar em um nível de solicitação por solicitação para solicitações individuais que a consistência eventual é suficiente , o que poderia reduzir a latência e os encargos de RU para essa solicitação, mas não garantirá mais a consistência da sessão (leitura-sua-própria gravação)

Parameters:

consistencyLevel - o nível de consistência.

Returns:

o CosmosItemRequestOptions.

setCosmosEndToEndOperationLatencyPolicyConfig

public CosmosQueryRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)

Define o CosmosEndToEndOperationLatencyPolicyConfig a ser usado para a solicitação. Se a configuração já estiver definida * no cliente, isso substituirá a configuração no nível do cliente para essa solicitação

Parameters:

cosmosEndToEndOperationLatencyPolicyConfig - O CosmosEndToEndOperationLatencyPolicyConfig

Returns:

o CosmosQueryRequestOptions

setDedicatedGatewayRequestOptions

public CosmosQueryRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)

Define as opções de solicitação de gateway dedicado

Parameters:

dedicatedGatewayRequestOptions - Opções de solicitação de gateway dedicado

Returns:

o CosmosQueryRequestOptions

setDiagnosticsThresholds

public CosmosQueryRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

Permite substituir os limites de diagnóstico para uma operação específica.

Parameters:

operationSpecificThresholds - a substituição do limite de diagnóstico para esta operação

Returns:

o CosmosQueryRequestOptions.

setExcludedRegions

public CosmosQueryRequestOptions setExcludedRegions(List excludeRegions)

Lista de regiões a serem excluídas para a solicitação/repetições. Exemplo de "Leste dos EUA" ou "Leste dos EUA, Oeste dos EUA" Essas regiões serão excluídas da lista de regiões preferenciais

Parameters:

excludeRegions - as regiões a serem excluídas

Returns:

O CosmosQueryRequestOptions

setFeedRange

public CosmosQueryRequestOptions setFeedRange(FeedRange feedRange)

Define o FeedRange que queremos consultar

Parameters:

feedRange - O FeedRange

Returns:

o CosmosQueryRequestOptions.

setIndexMetricsEnabled

public CosmosQueryRequestOptions setIndexMetricsEnabled(boolean indexMetricsEnabled)

Define indexMetricsEnabled, que é usado para obter as métricas de índice para entender como o mecanismo de consulta usava índices existentes e poderia usar possíveis novos índices. Os resultados serão exibidos em QueryMetrics. Observe que essas opções causarão sobrecarga, portanto, elas devem ser habilitadas ao depurar consultas lentas. Por padrão, o indexMetrics está desabilitado.

Parameters:

indexMetricsEnabled - um booliano usado para obter as métricas de índice

Returns:

indexMetricsEnabled

setMaxBufferedItemCount

public CosmosQueryRequestOptions setMaxBufferedItemCount(int maxBufferedItemCount)

Define o número máximo de itens que podem ser armazenados em buffer no lado do cliente durante a execução de consulta paralela.

Parameters:

maxBufferedItemCount - número máximo de itens.

Returns:

o CosmosQueryRequestOptions.

setMaxDegreeOfParallelism

public CosmosQueryRequestOptions setMaxDegreeOfParallelism(int maxDegreeOfParallelism)

Define o número de operações simultâneas que executam o lado do cliente durante a execução de consulta paralela.

Parameters:

maxDegreeOfParallelism - número de operações simultâneas.

Returns:

o CosmosQueryRequestOptions.

setPartitionKey

public CosmosQueryRequestOptions setPartitionKey(PartitionKey partitionkey)

Define a chave de partição usada para identificar a partição de destino da solicitação atual.

Parameters:

partitionkey - o valor da chave de partição.

Returns:

o CosmosQueryRequestOptions.

setQueryMetricsEnabled

public CosmosQueryRequestOptions setQueryMetricsEnabled(boolean queryMetricsEnabled)

Define a opção para habilitar/desabilitar a obtenção de métricas relacionadas à execução da consulta em solicitações de consulta de item. Por padrão, as métricas de consulta estão habilitadas.

Parameters:

queryMetricsEnabled - se deseja habilitar ou desabilitar métricas de consulta

Returns:

o CosmosQueryRequestOptions.

setQueryName

public CosmosQueryRequestOptions setQueryName(String queryName)

Define o nome da consulta lógica – esse identificador só é usado para métricas e logs para distinguir consultas diferentes na telemetria. A cardinalidade de valores exclusivos para queryName deve ser razoavelmente baixa - como significativamente menor que 100.

Parameters:

queryName - um nome de consulta lógica para distinguir esse padrão de consulta de outras pessoas

Returns:

o nome da consulta lógica

setResponseContinuationTokenLimitInKb

public CosmosQueryRequestOptions setResponseContinuationTokenLimitInKb(int limitInKb)

Define a opção de solicitação ResponseContinuationTokenLimitInKb para solicitações de consulta de item no serviço do Azure Cosmos DB.

ResponseContinuationTokenLimitInKb é usado para limitar o comprimento do token de continuação na resposta da consulta. Os valores válidos são >= 1.

O token de continuação contém campos obrigatórios e opcionais. Os campos necessários são necessários para retomar a execução de onde ela foi rebaixada. Os campos opcionais podem conter o trabalho de pesquisa de índice serializado que foi feito, mas ainda não utilizado. Isso evita refazer o trabalho novamente em continuações subsequentes e, portanto, melhorar o desempenho da consulta. Definindo o tamanho máximo de continuação como 1KB, o serviço do Azure Cosmos DB só serializará os campos necessários. A partir de 2KB, o serviço do Azure Cosmos DB seria serializado o máximo que pudesse caber até atingir o tamanho máximo especificado.

Parameters:

limitInKb - limite de tamanho do token de continuação.

Returns:

o CosmosQueryRequestOptions.

setScanInQueryEnabled

public CosmosQueryRequestOptions setScanInQueryEnabled(Boolean scanInQueryEnabled)

Define a opção para permitir a verificação nas consultas que não puderam ser atendidas, pois a indexação foi recusada nos caminhos solicitados.

Parameters:

scanInQueryEnabled - a opção de habilitar a verificação na consulta.

Returns:

o CosmosQueryRequestOptions.

setSessionToken

public CosmosQueryRequestOptions setSessionToken(String sessionToken)

Define o token de sessão para uso com consistência de sessão.

Parameters:

sessionToken - o token de sessão.

Returns:

o CosmosQueryRequestOptions.

setThresholdForDiagnosticsOnTracer

public CosmosQueryRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)

Define o thresholdForDiagnosticsOnTracer, se a latência na operação de consulta for maior que essa diagnóstico será enviada para abrir o exportador de telemetria como eventos no intervalo de rastreamento da api CRUD de ponta a ponta. O padrão é 500 ms

Parameters:

thresholdForDiagnosticsOnTracer - o limite de latência para diagnóstico no rastreamento.

Returns:

o CosmosQueryRequestOptions

setThroughputControlGroupName

public CosmosQueryRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

Defina o nome do grupo de controle de taxa de transferência.

Parameters:

throughputControlGroupName - O nome do grupo de controle de taxa de transferência.

Returns:

Uma CosmosQueryRequestOptions.