次の方法で共有


CosmosChangeFeedRequestOptions クラス

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

public final class CosmosChangeFeedRequestOptions

変更フィード要求内の操作に対して指定できるオプションをカプセル化します。

メソッドの概要

修飾子と型 メソッドと説明
CosmosChangeFeedRequestOptions allVersionsAndDeletes()

変更フィード モードを変更して、変更フィードに、作成、削除、および更新のすべての中間スナップショットが含まれるようにします。

static CosmosChangeFeedRequestOptions createForProcessingFromBeginning(FeedRange feedRange)

変更フィードの先頭から変更フィード項目の処理を開始する新しい CosmosChangeFeedRequestOptions インスタンスを作成します

static CosmosChangeFeedRequestOptions createForProcessingFromContinuation(String continuation)

前の継続からの変更フィード項目の処理を開始する新しい CosmosChangeFeedRequestOptions インスタンスを作成します

static CosmosChangeFeedRequestOptions createForProcessingFromNow(FeedRange feedRange)

変更フィード項目の処理を現在の時刻から開始する新しい CosmosChangeFeedRequestOptions インスタンスを作成します。そのため、将来のすべての変更のイベントのみが取得されます

static CosmosChangeFeedRequestOptions createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)

特定の時点から変更フィード項目の処理を開始する新しい CosmosChangeFeedRequestOptions インスタンスを作成します

CosmosChangeFeedRequestOptions fullFidelity()

非推奨

代わりに を使用 allVersionsAndDeletes() してください。

変更フィード モードを変更して、変更フィードに、作成、削除、および更新のすべての中間スナップショットが含まれるようにします。

List<String> getExcludedRegions()

要求/再試行に対して除外するリージョンの一覧を取得します。

FeedRange getFeedRange()

フィード範囲を取得します。

int getMaxItemCount()

列挙操作で返される項目の最大数を取得します。

int getMaxPrefetchPageCount()

バックエンドからバックグラウンドで非同期的にプリフェッチされるページの最大数を取得します。

String getThroughputControlGroupName()

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

boolean isQuotaInfoEnabled()

Azure Cosmos DB データベース サービスの変更フィード要求のクォータInfoEnabled 設定を取得します。

CosmosChangeFeedRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

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

CosmosChangeFeedRequestOptions setExcludedRegions(List<String> excludeRegions)

要求/再試行に対して除外するリージョンの一覧。

CosmosChangeFeedRequestOptions setMaxItemCount(int maxItemCount)

列挙操作で返される項目の最大数を設定します。

CosmosChangeFeedRequestOptions setMaxPrefetchPageCount(int maxPrefetchPageCount)

バックエンドからバックグラウンドで非同期的にプリフェッチされるページの最大数を設定します。

void setQuotaInfoEnabled(boolean quotaInfoEnabled)

Azure Cosmos DB データベース サービスの変更フィード要求のクォータInfoEnabled 設定を取得します。

CosmosChangeFeedRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

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

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

メソッドの詳細

allVersionsAndDeletes

public CosmosChangeFeedRequestOptions allVersionsAndDeletes()

変更フィード モードを変更して、変更フィードに、作成、削除、および更新のすべての中間スナップショットが含まれるようにします。 AllVersionsAndDeletes 変更フィード モードを有効にするには、コンテナーの変更フィード ポリシーで保持期間を構成する必要があります。 ChangeFeedPolicy

変更の中間スナップショットと削除されたドキュメントは、消失する前に 8 分間処理できます。 AllVersionsAndDeletes モードを有効にすると、コンテナーの変更フィード ポリシーで構成された保持ウィンドウ内でのみ変更フィード イベントを処理できます。 保持期間を超えた後に変更フィードを処理しようとすると、中間更新と削除のイベントが消失したため、エラー (状態コード 400) が返されます。 コンテナーで保持期間を使用して AllVersionsAndDeletes 変更フィード ポリシーを構成し、LatestVersion モードを使用する場合でも、LatestVersion モードを使用して変更を処理することは可能ですが、保持期間外であるかどうかは関係ありませんが、削除または中間更新のイベントは含まれません。 保持期間内にイベントが処理されない場合は、新しい CosmosChangeFeedRequestOptions インスタンスを使用して変更フィードにクエリを実行することで、AllVersionsAndDeletes モードで将来のイベントの処理を続行することもできます。

Returns:

CosmosChangeFeedRequestOptions AllVersionsAndDeletes モードが有効になっているインスタンス

createForProcessingFromBeginning

public static CosmosChangeFeedRequestOptions createForProcessingFromBeginning(FeedRange feedRange)

変更フィードの先頭から変更フィード項目の処理を開始する新しい CosmosChangeFeedRequestOptions インスタンスを作成します

Parameters:

feedRange - FeedRangeスコープ (コンテナー全体、論理パーティション、またはコンテナーのサブセット) を定義するために使用される 。

Returns:

CosmosChangeFeedRequestOptions しいインスタンス

createForProcessingFromContinuation

public static CosmosChangeFeedRequestOptions createForProcessingFromContinuation(String continuation)

前の継続からの変更フィード項目の処理を開始する新しい CosmosChangeFeedRequestOptions インスタンスを作成します

Parameters:

continuation - 以前に取得した FeedResponse から取得された継続

Returns:

CosmosChangeFeedRequestOptions しいインスタンス

createForProcessingFromNow

public static CosmosChangeFeedRequestOptions createForProcessingFromNow(FeedRange feedRange)

変更フィード項目の処理を現在の時刻から開始する新しい CosmosChangeFeedRequestOptions インスタンスを作成します。そのため、将来のすべての変更のイベントのみが取得されます

Parameters:

feedRange - FeedRangeスコープ (コンテナー全体、論理パーティション、またはコンテナーのサブセット) を定義するために使用される 。

Returns:

CosmosChangeFeedRequestOptions しいインスタンス

createForProcessingFromPointInTime

public static CosmosChangeFeedRequestOptions createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)

特定の時点から変更フィード項目の処理を開始する新しい CosmosChangeFeedRequestOptions インスタンスを作成します

Parameters:

pointInTime - 変更フィード イベントの処理を開始する時点
feedRange - FeedRangeスコープ (コンテナー全体、論理パーティション、またはコンテナーのサブセット) を定義するために使用される 。

Returns:

CosmosChangeFeedRequestOptions しいインスタンス

fullFidelity

@Deprecated
public CosmosChangeFeedRequestOptions fullFidelity()

非推奨

代わりに を使用 allVersionsAndDeletes() してください。

変更フィード モードを変更して、変更フィードに、作成、削除、および更新のすべての中間スナップショットが含まれるようにします。 AllVersionsAndDeletes 変更フィード モードを有効にするには、コンテナーの変更フィード ポリシーで保持期間を構成する必要があります。 ChangeFeedPolicy

変更の中間スナップショットと削除されたドキュメントは、消失する前に保持期間の処理に使用できます。 AllVersionsAndDeletes モードを有効にすると、コンテナーの変更フィード ポリシーで構成された保持ウィンドウ内でのみ変更フィード イベントを処理できます。 保持期間を超えた後に変更フィードを処理しようとすると、中間更新と削除のイベントが消失したため、エラー (状態コード 400) が返されます。 コンテナーで保持期間を使用して AllVersionsAndDeletes 変更フィード ポリシーを構成し、LatestVersion モードを使用する場合でも、LatestVersion モードを使用して変更を処理することは可能ですが、保持期間外であるかどうかは関係ありませんが、削除または中間更新のイベントは含まれません。 保持期間内にイベントが処理されない場合は、新しい CosmosChangeFeedRequestOptions インスタンスを使用して変更フィードにクエリを実行することで、AllVersionsAndDeletes モードで将来のイベントの処理を続行することもできます。

Returns:

CosmosChangeFeedRequestOptions AllVersionsAndDeletes モードが有効になっているインスタンス

getExcludedRegions

public List getExcludedRegions()

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

Returns:

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

getFeedRange

public FeedRange getFeedRange()

フィード範囲を取得します。

Returns:

フィード範囲。

getMaxItemCount

public int getMaxItemCount()

列挙操作で返される項目の最大数を取得します。

Returns:

項目の最大数。

getMaxPrefetchPageCount

public int getMaxPrefetchPageCount()

バックエンドからバックグラウンドで非同期的にプリフェッチされるページの最大数を取得します。 これらの変更を事前にフェッチすることで、変更フィード レコードを処理するスループットを向上させることができます。これは、IO 操作がバックエンドから完了する新しいページを取得するのを待機している間に処理を停止する必要がないためです。 プリフェッチ ページ (setMaxPrefetchPageCount(0) を使用) を無効にすると便利な唯一のシナリオは、呼び出し元が 1 つのページのみを取得することを計画している場合です。そのため、プリフェッチされたページは使用されません。

Returns:

変更された変更フィード要求オプション。

getThroughputControlGroupName

public String getThroughputControlGroupName()

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

Returns:

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

isQuotaInfoEnabled

public boolean isQuotaInfoEnabled()

Azure Cosmos DB データベース サービスの変更フィード要求の quotaInfoEnabled 設定を取得します。 quotaInfoEnabled は、クォータ関連の統計の取得を有効または無効にするために使用されます

Returns:

quotaInfoEnabled が有効になっている場合は true

setDiagnosticsThresholds

public CosmosChangeFeedRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

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

Parameters:

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

Returns:

CosmosQueryRequestOptions。

setExcludedRegions

public CosmosChangeFeedRequestOptions setExcludedRegions(List excludeRegions)

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

Parameters:

excludeRegions - リージョンの一覧

Returns:

setMaxItemCount

public CosmosChangeFeedRequestOptions setMaxItemCount(int maxItemCount)

列挙操作で返される項目の最大数を設定します。

Parameters:

maxItemCount - 項目の最大数。

Returns:

FeedOptionsBase。

setMaxPrefetchPageCount

public CosmosChangeFeedRequestOptions setMaxPrefetchPageCount(int maxPrefetchPageCount)

バックエンドからバックグラウンドで非同期的にプリフェッチされるページの最大数を設定します。 これらの変更を事前にフェッチすることで、変更フィード レコードを処理するスループットを向上させることができます。これは、IO 操作がバックエンドから完了する新しいページを取得するのを待機している間に処理を停止する必要がないためです。 プリフェッチ ページ (setMaxPrefetchPageCount(0) を使用) を無効にすると便利な唯一のシナリオは、呼び出し元が 1 つのページのみを取得することを計画している場合です。そのため、プリフェッチされたページは使用されません。

Parameters:

maxPrefetchPageCount - バックエンドからバックグラウンドで非同期的にプリフェッチされるページの最大数

Returns:

変更された変更フィード要求オプション。

setQuotaInfoEnabled

public void setQuotaInfoEnabled(boolean quotaInfoEnabled)

Azure Cosmos DB データベース サービスの変更フィード要求の quotaInfoEnabled 設定を取得します。 quotaInfoEnabled は、クォータ関連の統計の取得を有効または無効にするために使用されます

Parameters:

quotaInfoEnabled - quotaInfoEnabled が有効かどうかを示すブール値

setThroughputControlGroupName

public CosmosChangeFeedRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

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

Parameters:

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

Returns:

適用対象