你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
CosmosChangeFeedRequestOptions 类
- java.
lang. Object - com.
azure. cosmos. models. CosmosChangeFeedRequestOptions
- com.
public final class CosmosChangeFeedRequestOptions
封装可为更改源请求中的操作指定的选项。
方法摘要
方法继承自 java.lang.Object
方法详细信息
allVersionsAndDeletes
public CosmosChangeFeedRequestOptions allVersionsAndDeletes()
更改更改源模式,以便更改源将包含用于创建、删除的事件以及更新的所有中间快照。 启用 AllVersionsAndDeletes 更改源模式需要在容器的更改源策略中配置保留持续时间。 ChangeFeedPolicy
更改和已删除文档的中间快照可在 8 分钟内进行处理,然后才会消失。 启用 AllVersionsAndDeletes 模式时,只能在容器的更改源策略中配置的保留时段内处理更改源事件。 如果尝试在超过保留时段后处理更改源,将返回错误 (状态代码 400) ,因为中间更新和删除的事件已消失。 即使对容器使用保留时段配置 AllVersionsAndDeletes 更改源策略,并且使用 LatestVersion 模式时,也仍可使用 LatestVersion 模式处理更改-但不会包含删除或中间更新的事件。 如果未在保留时段内处理事件,还可以通过使用新的 CosmosChangeFeedRequestOptions 实例查询更改源,在 AllVersionsAndDeletes 模式下继续处理未来的事件。
Returns:
createForProcessingFromBeginning
public static CosmosChangeFeedRequestOptions createForProcessingFromBeginning(FeedRange feedRange)
创建一个新 CosmosChangeFeedRequestOptions 实例,以从更改源的开头开始处理更改源项
Parameters:
Returns:
createForProcessingFromContinuation
public static CosmosChangeFeedRequestOptions createForProcessingFromContinuation(String continuation)
创建一个新 CosmosChangeFeedRequestOptions 实例,以开始处理上一个延续中的更改源项
Parameters:
Returns:
createForProcessingFromNow
public static CosmosChangeFeedRequestOptions createForProcessingFromNow(FeedRange feedRange)
创建一个新 CosmosChangeFeedRequestOptions 实例以开始处理当前时间的更改源项 - 因此将仅检索所有未来更改的事件
Parameters:
Returns:
createForProcessingFromPointInTime
public static CosmosChangeFeedRequestOptions createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)
创建一个新 CosmosChangeFeedRequestOptions 实例以开始处理特定时间点的更改源项
Parameters:
Returns:
fullFidelity
@Deprecated
public CosmosChangeFeedRequestOptions fullFidelity()
已放弃
更改更改源模式,以便更改源将包含用于创建、删除的事件以及更新的所有中间快照。 启用 AllVersionsAndDeletes 更改源模式需要在容器的更改源策略中配置保留持续时间。 ChangeFeedPolicy
更改和已删除文档的中间快照可在保留期消失之前进行处理。 启用 AllVersionsAndDeletes 模式时,只能在容器的更改源策略中配置的保留时段内处理更改源事件。 如果尝试在超过保留时段后处理更改源,将返回错误 (状态代码 400) ,因为中间更新和删除的事件已消失。 即使对容器使用保留时段配置 AllVersionsAndDeletes 更改源策略,并且使用 LatestVersion 模式时,也仍可使用 LatestVersion 模式处理更改-但不会包含删除或中间更新的事件。 如果未在保留时段内处理事件,还可以通过使用新的 CosmosChangeFeedRequestOptions 实例查询更改源,在 AllVersionsAndDeletes 模式下继续处理未来的事件。
Returns:
getExcludedRegions
public List
获取要为请求/重试排除的区域的列表。 这些区域从首选区域列表中排除。
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:
setDiagnosticsThresholds
public CosmosChangeFeedRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)
允许替代特定操作的诊断阈值。
Parameters:
Returns:
setExcludedRegions
public CosmosChangeFeedRequestOptions setExcludedRegions(List
要为请求/重试排除的区域列表。 示例“美国东部”或“美国东部,美国西部”这些区域将从首选区域列表中排除
Parameters:
Returns:
setMaxItemCount
public CosmosChangeFeedRequestOptions setMaxItemCount(int maxItemCount)
设置枚举操作中要返回的最大项数。
Parameters:
Returns:
setMaxPrefetchPageCount
public CosmosChangeFeedRequestOptions setMaxPrefetchPageCount(int maxPrefetchPageCount)
设置将在后台异步从后端预提取的最大页数。 通过预提取这些更改,可以增加处理更改源记录的吞吐量,因为处理不必在等待 IO 操作从后端检索新页面来完成时停止。 使用 setMaxPrefetchPageCount (0) ) 禁用预提取页面 (的唯一方案是调用方仅计划只检索一个页面 ,因此无论如何都不会使用任何预提取的页面。
Parameters:
Returns:
setQuotaInfoEnabled
public void setQuotaInfoEnabled(boolean quotaInfoEnabled)
获取 Azure Cosmos DB 数据库服务中更改源请求的 quotaInfoEnabled 设置。 quotaInfoEnabled 用于启用/禁用获取与配额相关的统计信息
Parameters:
setThroughputControlGroupName
public CosmosChangeFeedRequestOptions setThroughputControlGroupName(String throughputControlGroupName)
设置吞吐量控制组名称。
Parameters:
Returns: