你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
CosmosQueryRequestOptions 类
- java.
lang. Object - com.
azure. cosmos. models. CosmosQueryRequestOptions
- com.
public class CosmosQueryRequestOptions
指定与 azure Cosmos DB 数据库服务中) (枚举操作的查询方法关联的选项。
构造函数摘要
| 构造函数 | 说明 |
|---|---|
| CosmosQueryRequestOptions() |
实例化新的查询请求选项。 |
方法摘要
方法继承自 java.lang.Object
构造函数详细信息
CosmosQueryRequestOptions
public CosmosQueryRequestOptions()
实例化新的查询请求选项。
方法详细信息
getConsistencyLevel
public ConsistencyLevel getConsistencyLevel()
获取请求所需的一致性级别。
Returns:
getDedicatedGatewayRequestOptions
public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()
获取专用网关请求选项
Returns:
getExcludedRegions
public List
获取要为请求/重试排除的区域列表。 这些区域从首选区域列表中排除。
Returns:
getMaxBufferedItemCount
public int getMaxBufferedItemCount()
获取并行查询执行期间客户端可以缓冲的最大项数。
Returns:
getMaxDegreeOfParallelism
public int getMaxDegreeOfParallelism()
获取并行查询执行期间运行客户端的并发操作数。
Returns:
getPartitionKey
public PartitionKey getPartitionKey()
获取用于标识当前请求的目标分区的分区键。
Returns:
getResponseContinuationTokenLimitInKb
public int getResponseContinuationTokenLimitInKb()
获取 Azure Cosmos DB 服务中项查询请求的 ResponseContinuationTokenLimitInKb 请求选项。 如果尚未设置 ，则返回 0。
ResponseContinuationTokenLimitInKb 用于限制查询响应中继续标记的长度。 有效值为 >= 1。
Returns:
getSessionToken
public String getSessionToken()
获取用于会话一致性的会话令牌。
Returns:
getThresholdForDiagnosticsOnTracer
public Duration getThresholdForDiagnosticsOnTracer()
获取 thresholdForDiagnosticsOnTracer，如果查询操作的延迟大于此诊断将作为端到端 CRUD API 的跟踪器范围中的事件发送到打开遥测导出程序。 默认值为 500 毫秒。
Returns:
getThroughputControlGroupName
public String getThroughputControlGroupName()
获取吞吐量控制组名称。
Returns:
isIndexMetricsEnabled
public boolean isIndexMetricsEnabled()
获取 indexMetricsEnabled，用于获取索引指标，以了解查询引擎如何使用现有索引，以及如何使用潜在的新索引。 结果将显示在 QueryMetrics 中。 请注意，此选项会产生开销，因此在调试慢速查询时应启用此选项。
Returns:
isQueryMetricsEnabled
public boolean isQueryMetricsEnabled()
获取用于启用填充查询指标的选项。 默认情况下，查询指标处于启用状态。
Returns:
isScanInQueryEnabled
public Boolean isScanInQueryEnabled()
获取选项，该选项允许扫描在请求的路径上无法用作索引的查询。
Returns:
setConsistencyLevel
public CosmosQueryRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)
设置请求所需的一致性级别。 只能降低读取/查询请求的有效一致性级别。 因此，当帐户的默认一致性级别为例如“会话”时，可以在单个请求的逐个请求级别上指定“最终一致性已足够”，这可以减少此请求的延迟和 RU 费用，但不保证会话一致性 (读写)
Parameters:
Returns:
setCosmosEndToEndOperationLatencyPolicyConfig
public CosmosQueryRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)
CosmosEndToEndOperationLatencyPolicyConfig设置要用于请求的 。 如果已在客户端上设置配置 * ，则这将替代此请求的客户端级别配置
Parameters:
Returns:
setDedicatedGatewayRequestOptions
public CosmosQueryRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)
设置专用网关请求选项
Parameters:
Returns:
setDiagnosticsThresholds
public CosmosQueryRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)
允许替代特定操作的诊断阈值。
Parameters:
Returns:
setExcludedRegions
public CosmosQueryRequestOptions setExcludedRegions(List
要排除请求/重试的区域列表。 示例“美国东部”或“美国东部，美国西部”这些区域将从首选区域列表中排除
Parameters:
Returns:
setFeedRange
setIndexMetricsEnabled
public CosmosQueryRequestOptions setIndexMetricsEnabled(boolean indexMetricsEnabled)
设置 indexMetricsEnabled，用于获取索引指标，以了解查询引擎如何使用现有索引以及如何使用潜在的新索引。 结果将显示在 QueryMetrics 中。 请注意，此选项会产生开销，因此在调试慢速查询时应启用此选项。 默认情况下，indexMetrics 处于禁用状态。
Parameters:
Returns:
setMaxBufferedItemCount
public CosmosQueryRequestOptions setMaxBufferedItemCount(int maxBufferedItemCount)
设置并行查询执行期间客户端可以缓冲的最大项数。
Parameters:
Returns:
setMaxDegreeOfParallelism
public CosmosQueryRequestOptions setMaxDegreeOfParallelism(int maxDegreeOfParallelism)
设置并行查询执行期间运行客户端的并发操作数。
Parameters:
Returns:
setPartitionKey
public CosmosQueryRequestOptions setPartitionKey(PartitionKey partitionkey)
设置用于标识当前请求的目标分区的分区键。
Parameters:
Returns:
setQueryMetricsEnabled
public CosmosQueryRequestOptions setQueryMetricsEnabled(boolean queryMetricsEnabled)
设置选项以启用/禁止获取与项查询请求的查询执行相关的指标。 默认情况下，查询指标处于启用状态。
Parameters:
Returns:
setQueryName
public CosmosQueryRequestOptions setQueryName(String queryName)
设置逻辑查询名称 - 此标识符仅用于指标和日志，以区分遥测中的不同查询。 queryName 的唯一值的基数应相当低 ，例如明显小于 100。
Parameters:
Returns:
setResponseContinuationTokenLimitInKb
public CosmosQueryRequestOptions setResponseContinuationTokenLimitInKb(int limitInKb)
为 Azure Cosmos DB 服务中的项查询请求设置 ResponseContinuationTokenLimitInKb 请求选项。
ResponseContinuationTokenLimitInKb 用于限制查询响应中继续标记的长度。 有效值为 >= 1。
继续标记包含必填字段和可选字段。 必填字段是恢复从其被弯腰处执行所必需的。 可选字段可能包含已完成但尚未利用的序列化索引查找工作。 这可避免在后续延续中再次重做工作，从而提高查询性能。 将最大延续大小设置为 1KB，Azure Cosmos DB 服务将仅序列化必填字段。 从 2KB 开始，Azure Cosmos DB 服务将尽可能多地序列化，直到达到指定的最大大小。
Parameters:
Returns:
setScanInQueryEnabled
public CosmosQueryRequestOptions setScanInQueryEnabled(Boolean scanInQueryEnabled)
设置选项以允许对无法作为索引的查询进行扫描，这些查询在请求的路径上已选择退出。
Parameters:
Returns:
setSessionToken
public CosmosQueryRequestOptions setSessionToken(String sessionToken)
设置用于会话一致性的会话令牌。
Parameters:
Returns:
setThresholdForDiagnosticsOnTracer
public CosmosQueryRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)
设置 thresholdForDiagnosticsOnTracer，如果查询操作的延迟大于此诊断将作为端到端 CRUD API 的跟踪器范围中的事件发送到打开遥测导出程序。 默认值为 500 毫秒
Parameters:
Returns:
setThroughputControlGroupName
public CosmosQueryRequestOptions setThroughputControlGroupName(String throughputControlGroupName)
设置吞吐量控制组名称。
Parameters:
Returns:
