CosmosQueryRequestOptions クラス

パッケージ:

com.azure.cosmos.models

Maven 成果物:

com.azure:azure-cosmos:4.54.0

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

public class CosmosQueryRequestOptions

Azure Cosmos DB データベース サービスのクエリ メソッド (列挙操作) に関連付けられているオプションを指定します。

コンストラクターの概要

コンストラクター	説明
CosmosQueryRequestOptions()	新しいクエリ要求オプションをインスタンス化します。

メソッドの概要

修飾子と型	メソッドと説明
ConsistencyLevel	getConsistencyLevel() 要求に必要な整合性レベルを取得します。
DedicatedGatewayRequestOptions	getDedicatedGatewayRequestOptions() 専用ゲートウェイ要求オプションを取得します
List<String>	getExcludedRegions() 要求/再試行に対して除外するリージョンの一覧を取得します。
FeedRange	getFeedRange() FeedRange を取得します
int	getMaxBufferedItemCount() 並列クエリの実行中にクライアント側でバッファーに格納できるアイテムの最大数を取得します。
int	getMaxDegreeOfParallelism() 並列クエリの実行中にクライアント側で実行される同時実行操作の数を取得します。
PartitionKey	getPartitionKey() 現在の要求のターゲット パーティションを識別するために使用されるパーティション キーを取得します。
int	getResponseContinuationTokenLimitInKb() Azure Cosmos DB サービスの項目クエリ要求の応答継続トークン制限InKb 要求オプションを取得します。
String	getSessionToken() セッション整合性で使用するセッション トークンを取得します。
Duration	getThresholdForDiagnosticsOnTracer() クエリ操作の待機時間がこの診断を超える場合は、エンド ツー エンド CRUD API のトレーサー スパンでイベントとしてテレメトリ エクスポーターを開くために送信される、診断OnTracer のしきい値を取得します。
String	getThroughputControlGroupName() スループット制御グループ名を取得します。
boolean	isIndexMetricsEnabled() インデックスメトリックを取得します有効。これは、クエリ エンジンが既存のインデックスをどのように使用し、潜在的な新しいインデックスを使用できるかを理解するためにインデックス メトリックを取得するために使用されます。
boolean	isQueryMetricsEnabled() クエリ メトリックの設定を有効にするオプションを取得します。
Boolean	isScanInQueryEnabled() 要求されたパスでインデックス作成がオプトアウトされたクエリでスキャンを許可するオプションを取得します。
CosmosQueryRequestOptions	setConsistencyLevel(ConsistencyLevel consistencyLevel) 要求に必要な整合性レベルを設定します。
CosmosQueryRequestOptions	setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig) 要求に CosmosEndToEndOperationLatencyPolicyConfig 使用する を設定します。
CosmosQueryRequestOptions	setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions) 専用ゲートウェイ要求オプションを設定します
CosmosQueryRequestOptions	setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds) 特定の操作の診断しきい値をオーバーライドできます。
CosmosQueryRequestOptions	setExcludedRegions(List<String> excludeRegions) 要求/再試行のために除外するリージョンの一覧。
CosmosQueryRequestOptions	setFeedRange(FeedRange feedRange) クエリを実行する を設定します。FeedRange
CosmosQueryRequestOptions	setIndexMetricsEnabled(boolean indexMetricsEnabled) インデックスメトリックの有効化を設定します。これは、クエリ エンジンが既存のインデックスをどのように使用し、潜在的な新しいインデックスを使用できるかを理解するためにインデックス メトリックを取得するために使用されます。
CosmosQueryRequestOptions	setMaxBufferedItemCount(int maxBufferedItemCount) 並列クエリの実行中にクライアント側でバッファーに格納できるアイテムの最大数を設定します。
CosmosQueryRequestOptions	setMaxDegreeOfParallelism(int maxDegreeOfParallelism) 並列クエリの実行中にクライアント側で実行される同時実行操作の数を設定します。
CosmosQueryRequestOptions	setPartitionKey(PartitionKey partitionkey) 現在の要求のターゲット パーティションを識別するために使用されるパーティション キーを設定します。
CosmosQueryRequestOptions	setQueryMetricsEnabled(boolean queryMetricsEnabled) 項目クエリ要求でのクエリ実行に関連するメトリックの取得を有効または無効にするオプションを設定します。
CosmosQueryRequestOptions	setQueryName(String queryName) 論理クエリ名を設定します。この識別子は、テレメトリ内のさまざまなクエリを区別するためにメトリックとログにのみ使用されます。
CosmosQueryRequestOptions	setResponseContinuationTokenLimitInKb(int limitInKb) Azure Cosmos DB サービスの項目クエリ要求の応答継続トークン制限InKb 要求オプションを設定します。
CosmosQueryRequestOptions	setScanInQueryEnabled(Boolean scanInQueryEnabled) 要求されたパスでインデックス作成がオプトアウトされたクエリでスキャンを許可するオプションを設定します。
CosmosQueryRequestOptions	setSessionToken(String sessionToken) セッション整合性で使用するセッション トークンを設定します。
CosmosQueryRequestOptions	setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer) クエリ操作の待機時間がこの診断を超える場合、エンド ツー エンド CRUD API のトレーサー スパンでイベントとしてテレメトリ エクスポーターを開くために送信される場合は、診断OnTracer のしきい値を設定します。
CosmosQueryRequestOptions	setThroughputControlGroupName(String throughputControlGroupName) スループット制御グループ名を設定します。

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

CosmosQueryRequestOptions

public CosmosQueryRequestOptions()

新しいクエリ要求オプションをインスタンス化します。

メソッドの詳細

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

要求に必要な整合性レベルを取得します。

Returns:

整合性レベル。

getDedicatedGatewayRequestOptions

public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()

専用ゲートウェイ要求オプションを取得します

Returns:

専用ゲートウェイ要求オプション

getExcludedRegions

public List getExcludedRegions()

要求/再試行に対して除外するリージョンの一覧を取得します。 これらのリージョンは、優先リージョンの一覧から除外されます。

Returns:

除外されたリージョンの一覧

getFeedRange

public FeedRange getFeedRange()

FeedRange を取得します

Returns:

次の値を使用 FeedRange

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:

return set ResponseContinuationTokenLimitInKb、または設定されていない場合は 0

getSessionToken

public String getSessionToken()

セッション整合性で使用するセッション トークンを取得します。

Returns:

セッション トークン。

getThresholdForDiagnosticsOnTracer

public Duration getThresholdForDiagnosticsOnTracer()

クエリ操作の待機時間がこの診断を超える場合は、end to end CRUD api のトレーサー スパンでイベントとしてテレメトリ エクスポーターを開くために送信される thresholdForDiagnosticsOnTracer を取得します。 既定値は 500 ミリ秒です。

Returns:

thresholdForDiagnosticsOnTracer トレーサーの診断の待機時間のしきい値。

getThroughputControlGroupName

public String getThroughputControlGroupName()

スループット制御グループ名を取得します。

Returns:

スループット制御グループ名。

isIndexMetricsEnabled

public boolean isIndexMetricsEnabled()

indexMetricsEnabled を取得します。これは、クエリ エンジンが既存のインデックスをどのように使用し、潜在的な新しいインデックスを使用できるかを理解するためにインデックス メトリックを取得するために使用されます。 結果は QueryMetrics に表示されます。 このオプションではオーバーヘッドが発生するため、低速クエリをデバッグするときに有効にする必要があることに注意してください。

Returns:

indexMetricsEnabled (既定値: false)

isQueryMetricsEnabled

public boolean isQueryMetricsEnabled()

クエリ メトリックの設定を有効にするオプションを取得します。 既定では、クエリ メトリックが有効になっています。

Returns:

クエリ メトリックの設定を有効にするかどうか (既定値: true)

isScanInQueryEnabled

public Boolean isScanInQueryEnabled()

要求されたパスでインデックス作成がオプトアウトされたクエリでスキャンを許可するオプションを取得します。

Returns:

クエリでスキャンを有効にするオプション。

setConsistencyLevel

public CosmosQueryRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)

要求に必要な整合性レベルを設定します。 有効な整合性レベルは、読み取り/クエリ要求に対してのみ削減できます。 そのため、アカウントの既定の整合性レベルがたとえば [セッション] である場合は、個々の要求に対して要求ごとのレベルで、最終的な整合性で十分であることを指定できます。これにより、この要求の待機時間と RU の料金が削減される可能性がありますが、セッション整合性 (読み取り独自の書き込み) は保証されません

Parameters:

consistencyLevel - 整合性レベル。

Returns:

CosmosItemRequestOptions。

setCosmosEndToEndOperationLatencyPolicyConfig

public CosmosQueryRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)

要求に CosmosEndToEndOperationLatencyPolicyConfig 使用する を設定します。 構成が既にクライアントで * に設定されている場合は、この要求のクライアント レベルの構成がオーバーライドされます

Parameters:

cosmosEndToEndOperationLatencyPolicyConfig - 次の値を使用 CosmosEndToEndOperationLatencyPolicyConfig

Returns:

CosmosQueryRequestOptions

setDedicatedGatewayRequestOptions

public CosmosQueryRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)

専用ゲートウェイ要求オプションを設定します

Parameters:

dedicatedGatewayRequestOptions - 専用ゲートウェイ要求オプション

Returns:

CosmosQueryRequestOptions

setDiagnosticsThresholds

public CosmosQueryRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

特定の操作の診断しきい値をオーバーライドできます。

Parameters:

operationSpecificThresholds - この操作の診断しきい値のオーバーライド

Returns:

CosmosQueryRequestOptions。

setExcludedRegions

public CosmosQueryRequestOptions setExcludedRegions(List excludeRegions)

要求/再試行のために除外するリージョンの一覧。 例 "米国東部" または "米国東部、米国西部" これらのリージョンは、優先リージョンの一覧から除外されます

Parameters:

excludeRegions - 除外するリージョン

Returns:

次の値を使用 CosmosQueryRequestOptions

setFeedRange

public CosmosQueryRequestOptions setFeedRange(FeedRange feedRange)

クエリを実行する を設定します。FeedRange

Parameters:

feedRange - 次の値を使用 FeedRange

Returns:

CosmosQueryRequestOptions。

setIndexMetricsEnabled

public CosmosQueryRequestOptions setIndexMetricsEnabled(boolean indexMetricsEnabled)

indexMetricsEnabled を設定します。これは、クエリ エンジンが既存のインデックスをどのように使用し、潜在的な新しいインデックスを使用できるかを理解するためにインデックス メトリックを取得するために使用されます。 結果は QueryMetrics に表示されます。 このオプションではオーバーヘッドが発生するため、低速クエリのデバッグ時に有効にする必要があることに注意してください。 既定では、indexMetrics は無効になっています。

Parameters:

indexMetricsEnabled - インデックス メトリックを取得するために使用されるブール値

Returns:

indexMetricsEnabled

setMaxBufferedItemCount

public CosmosQueryRequestOptions setMaxBufferedItemCount(int maxBufferedItemCount)

並列クエリの実行中にクライアント側でバッファーに格納できるアイテムの最大数を設定します。

Parameters:

maxBufferedItemCount - 項目の最大数。

Returns:

CosmosQueryRequestOptions。

setMaxDegreeOfParallelism

public CosmosQueryRequestOptions setMaxDegreeOfParallelism(int maxDegreeOfParallelism)

並列クエリの実行中にクライアント側で実行される同時実行操作の数を設定します。

Parameters:

maxDegreeOfParallelism - 同時操作の数。

Returns:

CosmosQueryRequestOptions。

setPartitionKey

public CosmosQueryRequestOptions setPartitionKey(PartitionKey partitionkey)

現在の要求のターゲット パーティションを識別するために使用されるパーティション キーを設定します。

Parameters:

partitionkey - パーティション キーの値。

Returns:

CosmosQueryRequestOptions。

setQueryMetricsEnabled

public CosmosQueryRequestOptions setQueryMetricsEnabled(boolean queryMetricsEnabled)

項目クエリ要求でのクエリ実行に関連するメトリックの取得を有効または無効にするオプションを設定します。 既定では、クエリ メトリックが有効になっています。

Parameters:

queryMetricsEnabled - クエリ メトリックを有効または無効にするかどうか

Returns:

CosmosQueryRequestOptions。

setQueryName

public CosmosQueryRequestOptions setQueryName(String queryName)

論理クエリ名を設定します。この識別子は、テレメトリ内のさまざまなクエリを区別するためにメトリックとログにのみ使用されます。 queryName の一意の値のカーディナリティは、100 より大幅に小さいように、かなり低くする必要があります。

Parameters:

queryName - このクエリ パターンを他のクエリ パターンと区別するための論理クエリ名

Returns:

論理クエリ名

setResponseContinuationTokenLimitInKb

public CosmosQueryRequestOptions setResponseContinuationTokenLimitInKb(int limitInKb)

Azure Cosmos DB サービスの項目クエリ要求の ResponseContinuationTokenLimitInKb 要求オプションを設定します。

ResponseContinuationTokenLimitInKb は、クエリ応答の継続トークンの長さを制限するために使用されます。 有効な値は >= 1 です。

継続トークンには、必須フィールドと省略可能フィールドの両方が含まれます。 必要なフィールドは、実行がストゥープされた場所から再開するために必要です。 省略可能なフィールドには、行われたが、まだ使用されていないシリアル化されたインデックス検索作業が含まれている場合があります。 これにより、後続の継続で作業をやり直すのが回避され、クエリのパフォーマンスが向上します。 最大継続サイズを 1 KB に設定すると、Azure Cosmos DB サービスは必須フィールドのみをシリアル化します。 2 KB 以降、Azure Cosmos DB サービスは、指定された最大サイズに達するまで収まる限りシリアル化します。

Parameters:

limitInKb - 継続トークンのサイズ制限。

Returns:

CosmosQueryRequestOptions。

setScanInQueryEnabled

public CosmosQueryRequestOptions setScanInQueryEnabled(Boolean scanInQueryEnabled)

要求されたパスでインデックス作成がオプトアウトされたクエリでスキャンを許可するオプションを設定します。

Parameters:

scanInQueryEnabled - クエリでスキャンを有効にするオプション。

Returns:

CosmosQueryRequestOptions。

setSessionToken

public CosmosQueryRequestOptions setSessionToken(String sessionToken)

セッション整合性で使用するセッション トークンを設定します。

Parameters:

sessionToken - セッション トークン。

Returns:

CosmosQueryRequestOptions。

setThresholdForDiagnosticsOnTracer

public CosmosQueryRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)

クエリ操作の待機時間がこの診断を超える場合は、end to end CRUD api のトレーサー スパンでイベントとしてテレメトリ エクスポーターを開くために送信される thresholdForDiagnosticsOnTracer を設定します。 既定値は 500 ミリ秒です

Parameters:

thresholdForDiagnosticsOnTracer - トレーサーでの診断の待機時間のしきい値。

Returns:

CosmosQueryRequestOptions

setThroughputControlGroupName

public CosmosQueryRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

スループット制御グループ名を設定します。

Parameters:

throughputControlGroupName - スループット制御グループ名。

Returns:

CosmosQueryRequestOptions。