CosmosChangeFeedRequestOptions Classe

Pacote:

com.azure.cosmos.models

Artefato Maven:

com.azure:azure-cosmos:4.54.0

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

public final class CosmosChangeFeedRequestOptions

Encapsula as opções que podem ser especificadas para uma operação dentro de uma solicitação de feed de alterações.

Resumo do método

Modificador e tipo	Método e descrição
CosmosChangeFeedRequestOptions	allVersionsAndDeletes() Altera o modo de feed de alterações para que o feed de alterações contenha eventos para criações, exclusões e todos os instantâneos intermediários para atualizações.
static CosmosChangeFeedRequestOptions	createForProcessingFromBeginning(FeedRange feedRange) Cria uma nova CosmosChangeFeedRequestOptions instância para iniciar o processamento de itens do feed de alterações desde o início do feed de alterações
static CosmosChangeFeedRequestOptions	createForProcessingFromContinuation(String continuation) Cria uma nova CosmosChangeFeedRequestOptions instância para começar a processar itens do feed de alterações de uma continuação anterior
static CosmosChangeFeedRequestOptions	createForProcessingFromNow(FeedRange feedRange) Cria uma nova CosmosChangeFeedRequestOptions instância para iniciar o processamento de itens do feed de alterações a partir do momento atual– portanto, somente os eventos para todas as alterações futuras serão recuperados
static CosmosChangeFeedRequestOptions	createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange) Cria uma nova CosmosChangeFeedRequestOptions instância para começar a processar itens do feed de alterações de um determinado ponto no tempo
CosmosChangeFeedRequestOptions	fullFidelity() Preterido use allVersionsAndDeletes() em vez disso. Altera o modo de feed de alterações para que o feed de alterações contenha eventos para criações, exclusões e todos os instantâneos intermediários para atualizações.
List<String>	getExcludedRegions() Obtém a lista de regiões a serem excluídas para a solicitação/repetições.
FeedRange	getFeedRange() Obtém o intervalo de feed.
int	getMaxItemCount() Obtém o número máximo de itens a serem retornados na operação de enumeração.
int	getMaxPrefetchPageCount() Obtém o número máximo de páginas que serão pré-buscadas do back-end de forma assíncrona em segundo plano.
String	getThroughputControlGroupName() Obtenha o nome do grupo de controle de taxa de transferência.
boolean	isQuotaInfoEnabled() Obtém a configuração informaçõesde cotahabilitadas para solicitação de feed de alterações no serviço de banco de dados do Azure Cosmos DB.
CosmosChangeFeedRequestOptions	setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds) Permite substituir os limites de diagnóstico para uma operação específica.
CosmosChangeFeedRequestOptions	setExcludedRegions(List<String> excludeRegions) Lista de regiões a serem excluídas para a solicitação/novas tentativas.
CosmosChangeFeedRequestOptions	setMaxItemCount(int maxItemCount) Define o número máximo de itens a serem retornados na operação de enumeração.
CosmosChangeFeedRequestOptions	setMaxPrefetchPageCount(int maxPrefetchPageCount) Define o número máximo de páginas que serão pré-buscadas do back-end de forma assíncrona em segundo plano.
void	setQuotaInfoEnabled(boolean quotaInfoEnabled) Obtém a configuração informaçõesde cotahabilitadas para solicitação de feed de alterações no serviço de banco de dados do Azure Cosmos DB.
CosmosChangeFeedRequestOptions	setThroughputControlGroupName(String throughputControlGroupName) Defina o nome do grupo de controle de taxa de transferência.

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do método

allVersionsAndDeletes

public CosmosChangeFeedRequestOptions allVersionsAndDeletes()

Altera o modo de feed de alterações para que o feed de alterações contenha eventos para criações, exclusões e todos os instantâneos intermediários para atualizações. Habilitar o modo de feed de alterações AllVersionsAndDeletes requer a configuração de uma duração de retenção na política de feed de alterações do contêiner. ChangeFeedPolicy

Instantâneos intermediários de alterações, bem como documentos excluídos, estariam disponíveis para processamento por 8 minutos antes de desaparecerem. Ao habilitar o modo AllVersionsAndDeletes, você só poderá processar eventos de feed de alterações na janela de retenção configurada na política de feed de alterações do contêiner. Se você tentar processar um feed de alterações após mais do que a janela de retenção, um erro (Código de Status 400) será retornado porque os eventos para atualizações e exclusões intermediárias desapareceram. Ainda seria possível processar alterações usando o modo LatestVersion mesmo ao configurar uma política de feed de alterações AllVersionsAndDeletes com a janela de retenção no contêiner e, ao usar o modo LatestVersion, não importa se você está fora da janela de retenção ou não , mas nenhum evento para exclusões ou atualizações intermediárias seria incluído. Quando os eventos não estão sendo processados dentro da janela de retenção, também é possível continuar processando eventos futuros no modo AllVersionsAndDeletes consultando o feed de alterações com uma nova instância do CosmosChangeFeedRequestOptions.

Returns:

uma CosmosChangeFeedRequestOptions instância com o modo AllVersionsAndDeletes habilitado

createForProcessingFromBeginning

public static CosmosChangeFeedRequestOptions createForProcessingFromBeginning(FeedRange feedRange)

Cria uma nova CosmosChangeFeedRequestOptions instância para iniciar o processamento de itens do feed de alterações desde o início do feed de alterações

Parameters:

feedRange - O FeedRange usado para definir o escopo (contêiner inteiro, partição lógica ou subconjunto de um contêiner)

Returns:

uma nova CosmosChangeFeedRequestOptions instância

createForProcessingFromContinuation

public static CosmosChangeFeedRequestOptions createForProcessingFromContinuation(String continuation)

Cria uma nova CosmosChangeFeedRequestOptions instância para começar a processar itens do feed de alterações de uma continuação anterior

Parameters:

continuation - A continuação que foi recuperada de um FeedResponse recuperado anteriormente

Returns:

uma nova CosmosChangeFeedRequestOptions instância

createForProcessingFromNow

public static CosmosChangeFeedRequestOptions createForProcessingFromNow(FeedRange feedRange)

Cria uma nova CosmosChangeFeedRequestOptions instância para iniciar o processamento de itens do feed de alterações a partir do momento atual– portanto, somente os eventos para todas as alterações futuras serão recuperados

Parameters:

feedRange - O FeedRange usado para definir o escopo (contêiner inteiro, partição lógica ou subconjunto de um contêiner)

Returns:

uma nova CosmosChangeFeedRequestOptions instância

createForProcessingFromPointInTime

public static CosmosChangeFeedRequestOptions createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)

Cria uma nova CosmosChangeFeedRequestOptions instância para começar a processar itens do feed de alterações de um determinado ponto no tempo

Parameters:

pointInTime - O ponto no tempo a partir do qual o processamento de eventos de feed de alterações deve iniciar

feedRange - O FeedRange usado para definir o escopo (contêiner inteiro, partição lógica ou subconjunto de um contêiner)

Returns:

uma nova CosmosChangeFeedRequestOptions instância

fullFidelity

@Deprecated
public CosmosChangeFeedRequestOptions fullFidelity()

Preterido

use allVersionsAndDeletes() em vez disso.

Altera o modo de feed de alterações para que o feed de alterações contenha eventos para criações, exclusões e todos os instantâneos intermediários para atualizações. Habilitar o modo de feed de alterações AllVersionsAndDeletes requer a configuração de uma duração de retenção na política de feed de alterações do contêiner. ChangeFeedPolicy

Instantâneos intermediários de alterações, bem como documentos excluídos, estariam disponíveis para processamento para janela de retenção antes de desaparecerem. Ao habilitar o modo AllVersionsAndDeletes, você só poderá processar eventos de feed de alterações na janela de retenção configurada na política de feed de alterações do contêiner. Se você tentar processar um feed de alterações após mais do que a janela de retenção, um erro (Código de Status 400) será retornado porque os eventos para atualizações e exclusões intermediárias desapareceram. Ainda seria possível processar alterações usando o modo LatestVersion mesmo ao configurar uma política de feed de alterações AllVersionsAndDeletes com a janela de retenção no contêiner e, ao usar o modo LatestVersion, não importa se você está fora da janela de retenção ou não , mas nenhum evento para exclusões ou atualizações intermediárias seria incluído. Quando os eventos não estão sendo processados dentro da janela de retenção, também é possível continuar processando eventos futuros no modo AllVersionsAndDeletes consultando o feed de alterações com uma nova instância do CosmosChangeFeedRequestOptions.

Returns:

uma CosmosChangeFeedRequestOptions instância com o modo AllVersionsAndDeletes habilitado

getExcludedRegions

public List getExcludedRegions()

Obtém a lista de regiões a serem excluídas para a solicitação/repetições. Essas regiões são excluídas da lista de regiões preferenciais.

Returns:

uma lista de regiões excluídas

getFeedRange

public FeedRange getFeedRange()

Obtém o intervalo de feed.

Returns:

o intervalo de feeds.

getMaxItemCount

public int getMaxItemCount()

Obtém o número máximo de itens a serem retornados na operação de enumeração.

Returns:

o número máximo de itens.

getMaxPrefetchPageCount

public int getMaxPrefetchPageCount()

Obtém o número máximo de páginas que serão pré-buscadas do back-end de forma assíncrona em segundo plano. Ao buscar essas alterações, a taxa de transferência do processamento dos registros do feed de alterações pode ser aumentada porque o processamento não precisa parar enquanto aguarda as operações de E/S recuperarem uma nova página formando o back-end para ser concluído. O único cenário em que pode ser útil desabilitar páginas de pré-busca (com setMaxPrefetchPageCount(0)) seria quando o chamador planeja apenas recuperar apenas uma página , portanto, qualquer página pré-buscada não seria usada de qualquer maneira.

Returns:

as opções de solicitação de feed de alterações modificadas.

getThroughputControlGroupName

public String getThroughputControlGroupName()

Obtenha o nome do grupo de controle de taxa de transferência.

Returns:

O nome do grupo de controle de taxa de transferência.

isQuotaInfoEnabled

public boolean isQuotaInfoEnabled()

Obtém a configuração quotaInfoEnabled para solicitação de feed de alterações no serviço de banco de dados do Azure Cosmos DB. quotaInfoEnabled é usado para habilitar/desabilitar a obtenção de estatísticas relacionadas à cota

Returns:

true se quotaInfoEnabled estiver habilitado

setDiagnosticsThresholds

public CosmosChangeFeedRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

Permite substituir os limites de diagnóstico para uma operação específica.

Parameters:

operationSpecificThresholds - a substituição do limite de diagnóstico para esta operação

Returns:

o CosmosQueryRequestOptions.

setExcludedRegions

public CosmosChangeFeedRequestOptions setExcludedRegions(List excludeRegions)

Lista de regiões a serem excluídas para a solicitação/novas tentativas. Exemplo de "Leste dos EUA" ou "Leste dos EUA, Oeste dos EUA" Essas regiões serão excluídas da lista de regiões preferenciais

Parameters:

excludeRegions - lista de regiões

Returns:

O CosmosChangeFeedRequestOptions

setMaxItemCount

public CosmosChangeFeedRequestOptions setMaxItemCount(int maxItemCount)

Define o número máximo de itens a serem retornados na operação de enumeração.

Parameters:

maxItemCount - o número máximo de itens.

Returns:

o FeedOptionsBase.

setMaxPrefetchPageCount

public CosmosChangeFeedRequestOptions setMaxPrefetchPageCount(int maxPrefetchPageCount)

Define o número máximo de páginas que serão pré-buscadas do back-end de forma assíncrona em segundo plano. Ao buscar previamente essas alterações, a taxa de transferência do processamento dos registros do feed de alterações pode ser aumentada porque o processamento não precisa parar enquanto aguarda que as operações de E/S recuperem uma nova página do back-end para concluir. O único cenário em que pode ser útil desabilitar páginas de pré-busca (com setMaxPrefetchPageCount(0)) seria quando o chamador planeja apenas recuperar apenas uma página, portanto, todas as páginas pré-buscadas não seriam usadas de qualquer maneira.

Parameters:

maxPrefetchPageCount - o número máximo de páginas que serão pré-buscadas do back-end de forma assíncrona em segundo plano

Returns:

as opções de solicitação do feed de alterações modificadas.

setQuotaInfoEnabled

public void setQuotaInfoEnabled(boolean quotaInfoEnabled)

Obtém a configuração quotaInfoEnabled para solicitação de feed de alterações no serviço de banco de dados do Azure Cosmos DB. quotaInfoEnabled é usado para habilitar/desabilitar a obtenção de estatísticas relacionadas à cota

Parameters:

quotaInfoEnabled - um valor booliano que indica se quotaInfoEnabled está habilitado ou não

setThroughputControlGroupName

public CosmosChangeFeedRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

Defina o nome do grupo de controle de taxa de transferência.

Parameters:

throughputControlGroupName - O nome do grupo de controle de taxa de transferência.

Returns:

Uma CosmosChangeFeedRequestOptions.