你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CosmosChangeFeedRequestOptions 类

包:

com.azure.cosmos.models

Maven 项目:

com.azure:azure-cosmos:4.54.0

• 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 数据库服务中更改源请求的配额信息启用设置。
CosmosChangeFeedRequestOptions	setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds) 允许替代特定操作的诊断阈值。
CosmosChangeFeedRequestOptions	setExcludedRegions(List<String> excludeRegions) 要为请求/重试排除的区域列表。
CosmosChangeFeedRequestOptions	setMaxItemCount(int maxItemCount) 设置枚举操作中要返回的最大项数。
CosmosChangeFeedRequestOptions	setMaxPrefetchPageCount(int maxPrefetchPageCount) 设置将在后台异步从后端预提取的最大页数。
void	setQuotaInfoEnabled(boolean quotaInfoEnabled) 获取 Azure Cosmos DB 数据库服务中更改源请求的配额信息启用设置。
CosmosChangeFeedRequestOptions	setThroughputControlGroupName(String throughputControlGroupName) 设置吞吐量控制组名称。

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

方法详细信息

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) ) 禁用预提取页面 (的唯一方案是调用方仅计划只检索一个页面 ，因此无论如何都不会使用任何预提取的页面。

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:

CosmosChangeFeedRequestOptions

setMaxItemCount

public CosmosChangeFeedRequestOptions setMaxItemCount(int maxItemCount)

设置枚举操作中要返回的最大项数。

Parameters:

maxItemCount - 最大项数。

Returns:

FeedOptionsBase。

setMaxPrefetchPageCount

public CosmosChangeFeedRequestOptions setMaxPrefetchPageCount(int maxPrefetchPageCount)

设置将在后台异步从后端预提取的最大页数。 通过预提取这些更改，可以增加处理更改源记录的吞吐量，因为处理不必在等待 IO 操作从后端检索新页面来完成时停止。 使用 setMaxPrefetchPageCount (0) ) 禁用预提取页面 (的唯一方案是调用方仅计划只检索一个页面 ，因此无论如何都不会使用任何预提取的页面。

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:

一个 CosmosChangeFeedRequestOptions。