CosmosChangeFeedRequestOptions Clase

Paquete:

com.azure.cosmos.models

Artefacto Maven:

com.azure:azure-cosmos:4.54.0

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

public final class CosmosChangeFeedRequestOptions

Encapsula las opciones que se pueden especificar para una operación dentro de una solicitud de fuente de cambios.

Resumen del método

Modificador y tipo	Método y descripción
CosmosChangeFeedRequestOptions	allVersionsAndDeletes() Cambia el modo de fuente de cambios para que la fuente de cambios contenga eventos para creaciones, eliminaciones, así como todas las instantáneas intermedias para las actualizaciones.
static CosmosChangeFeedRequestOptions	createForProcessingFromBeginning(FeedRange feedRange) Crea una nueva CosmosChangeFeedRequestOptions instancia para iniciar el procesamiento de elementos de fuente de cambios desde el principio de la fuente de cambios.
static CosmosChangeFeedRequestOptions	createForProcessingFromContinuation(String continuation) Crea una nueva CosmosChangeFeedRequestOptions instancia para iniciar el procesamiento de elementos de fuente de cambios a partir de una continuación anterior.
static CosmosChangeFeedRequestOptions	createForProcessingFromNow(FeedRange feedRange) Crea una nueva CosmosChangeFeedRequestOptions instancia para iniciar el procesamiento de elementos de fuente de cambios a partir de la hora actual, por lo que solo se recuperarán los eventos de todos los cambios futuros.
static CosmosChangeFeedRequestOptions	createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange) Crea una nueva CosmosChangeFeedRequestOptions instancia para iniciar el procesamiento de elementos de fuente de cambios desde un momento dado.
CosmosChangeFeedRequestOptions	fullFidelity() Obsoleto use allVersionsAndDeletes() en su lugar. Cambia el modo de fuente de cambios para que la fuente de cambios contenga eventos para creaciones, eliminaciones, así como todas las instantáneas intermedias para las actualizaciones.
List<String>	getExcludedRegions() Obtiene la lista de regiones que se excluirán para la solicitud o reintentos.
FeedRange	getFeedRange() Obtiene el intervalo de fuentes.
int	getMaxItemCount() Obtiene el número máximo de elementos que se van a devolver en la operación de enumeración.
int	getMaxPrefetchPageCount() Obtiene el número máximo de páginas que se capturarán previamente desde el back-end de forma asincrónica en segundo plano.
String	getThroughputControlGroupName() Obtenga el nombre del grupo de control de rendimiento.
boolean	isQuotaInfoEnabled() Obtiene la configuración de informaciónde cuotahabilitada para la solicitud de fuente de cambios en el servicio de base de datos de Azure Cosmos DB.
CosmosChangeFeedRequestOptions	setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds) Permite invalidar los umbrales de diagnóstico para una operación específica.
CosmosChangeFeedRequestOptions	setExcludedRegions(List<String> excludeRegions) Lista de regiones que se van a excluir para la solicitud o reintentos.
CosmosChangeFeedRequestOptions	setMaxItemCount(int maxItemCount) Establece el número máximo de elementos que se devolverán en la operación de enumeración.
CosmosChangeFeedRequestOptions	setMaxPrefetchPageCount(int maxPrefetchPageCount) Establece el número máximo de páginas que se capturarán previamente desde el back-end de forma asincrónica en segundo plano.
void	setQuotaInfoEnabled(boolean quotaInfoEnabled) Obtiene la configuración de informaciónde cuotahabilitada para la solicitud de fuente de cambios en el servicio de base de datos de Azure Cosmos DB.
CosmosChangeFeedRequestOptions	setThroughputControlGroupName(String throughputControlGroupName) Establezca el nombre del grupo de control de rendimiento.

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del método

allVersionsAndDeletes

public CosmosChangeFeedRequestOptions allVersionsAndDeletes()

Cambia el modo de fuente de cambios para que la fuente de cambios contenga eventos para creaciones, eliminaciones, así como todas las instantáneas intermedias para las actualizaciones. Habilitar el modo de fuente de cambios AllVersionsAndDeletes requiere configurar una duración de retención en la directiva de fuente de cambios del contenedor. ChangeFeedPolicy

Las instantáneas intermedias de los cambios y los documentos eliminados estarán disponibles para su procesamiento durante 8 minutos antes de que desaparezcan. Al habilitar el modo AllVersionsAndDeletes, solo podrá procesar los eventos de fuente de cambios dentro de la ventana de retención configurada en la directiva de fuente de cambios del contenedor. Si intenta procesar una fuente de cambios después de más de la ventana de retención, se devolverá un error (código de estado 400) porque los eventos de actualizaciones y eliminaciones intermedias han desaparecido. Todavía sería posible procesar los cambios mediante el modo LatestVersion incluso al configurar una directiva de fuente de cambios AllVersionsAndDeletes con la ventana de retención en el contenedor y cuando se usa el modo LatestVersion, no importa si está fuera de la ventana de retención o no, pero no se incluirían eventos para eliminaciones o actualizaciones intermedias. Cuando los eventos no se procesan en la ventana de retención, también es posible seguir procesando eventos futuros en el modo AllVersionsAndDeletes consultando la fuente de cambios con una nueva instancia de CosmosChangeFeedRequestOptions.

Returns:

una CosmosChangeFeedRequestOptions instancia con el modo AllVersionsAndDeletes habilitado

createForProcessingFromBeginning

public static CosmosChangeFeedRequestOptions createForProcessingFromBeginning(FeedRange feedRange)

Crea una nueva CosmosChangeFeedRequestOptions instancia para iniciar el procesamiento de elementos de fuente de cambios desde el principio de la fuente de cambios.

Parameters:

feedRange - FeedRange que se usa para definir el ámbito (contenedor completo, partición lógica o subconjunto de un contenedor)

Returns:

una nueva CosmosChangeFeedRequestOptions instancia

createForProcessingFromContinuation

public static CosmosChangeFeedRequestOptions createForProcessingFromContinuation(String continuation)

Crea una nueva CosmosChangeFeedRequestOptions instancia para iniciar el procesamiento de elementos de fuente de cambios a partir de una continuación anterior.

Parameters:

continuation - Continuación que se recuperó de una instancia de FeedResponse recuperada anteriormente

Returns:

una nueva CosmosChangeFeedRequestOptions instancia

createForProcessingFromNow

public static CosmosChangeFeedRequestOptions createForProcessingFromNow(FeedRange feedRange)

Crea una nueva CosmosChangeFeedRequestOptions instancia para iniciar el procesamiento de elementos de fuente de cambios a partir de la hora actual, por lo que solo se recuperarán los eventos de todos los cambios futuros.

Parameters:

feedRange - FeedRange que se usa para definir el ámbito (contenedor completo, partición lógica o subconjunto de un contenedor)

Returns:

una nueva CosmosChangeFeedRequestOptions instancia

createForProcessingFromPointInTime

public static CosmosChangeFeedRequestOptions createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)

Crea una nueva CosmosChangeFeedRequestOptions instancia para iniciar el procesamiento de elementos de fuente de cambios desde un momento dado.

Parameters:

pointInTime - El momento en el que se debe iniciar el procesamiento de eventos de fuente de cambios

feedRange - FeedRange que se usa para definir el ámbito (contenedor completo, partición lógica o subconjunto de un contenedor)

Returns:

una nueva CosmosChangeFeedRequestOptions instancia

fullFidelity

@Deprecated
public CosmosChangeFeedRequestOptions fullFidelity()

Obsoleto

use allVersionsAndDeletes() en su lugar.

Cambia el modo de fuente de cambios para que la fuente de cambios contenga eventos para creaciones, eliminaciones, así como todas las instantáneas intermedias para las actualizaciones. Habilitar el modo de fuente de cambios AllVersionsAndDeletes requiere configurar una duración de retención en la directiva de fuente de cambios del contenedor. ChangeFeedPolicy

Las instantáneas intermedias de los cambios, así como los documentos eliminados estarían disponibles para su procesamiento para la ventana de retención antes de desaparecer. Al habilitar el modo AllVersionsAndDeletes, solo podrá procesar los eventos de fuente de cambios dentro de la ventana de retención configurada en la directiva de fuente de cambios del contenedor. Si intenta procesar una fuente de cambios después de más de la ventana de retención, se devolverá un error (código de estado 400) porque los eventos de actualizaciones y eliminaciones intermedias han desaparecido. Todavía sería posible procesar los cambios mediante el modo LatestVersion incluso al configurar una directiva de fuente de cambios AllVersionsAndDeletes con la ventana de retención en el contenedor y cuando se usa el modo LatestVersion, no importa si está fuera de la ventana de retención o no, pero no se incluirían eventos para eliminaciones o actualizaciones intermedias. Cuando los eventos no se procesan en la ventana de retención, también es posible seguir procesando eventos futuros en el modo AllVersionsAndDeletes consultando la fuente de cambios con una nueva instancia de CosmosChangeFeedRequestOptions.

Returns:

una CosmosChangeFeedRequestOptions instancia con el modo AllVersionsAndDeletes habilitado

getExcludedRegions

public List getExcludedRegions()

Obtiene la lista de regiones que se excluirán para la solicitud o reintentos. Estas regiones se excluyen de la lista de regiones preferidas.

Returns:

una lista de regiones excluidas

getFeedRange

public FeedRange getFeedRange()

Obtiene el intervalo de fuentes.

Returns:

el intervalo de fuente.

getMaxItemCount

public int getMaxItemCount()

Obtiene el número máximo de elementos que se van a devolver en la operación de enumeración.

Returns:

número máximo de elementos.

getMaxPrefetchPageCount

public int getMaxPrefetchPageCount()

Obtiene el número máximo de páginas que se capturarán previamente desde el back-end de forma asincrónica en segundo plano. Al capturar previamente estos cambios, se puede aumentar el rendimiento del procesamiento de los registros de fuente de cambios porque el procesamiento no tiene que detenerse mientras espera a que las operaciones de E/S recuperen un nuevo formulario de página para completar el back-end. El único escenario en el que puede resultar útil deshabilitar las páginas de captura previa (con setMaxPrefetchPageCount(0)) sería cuando el autor de la llamada solo planea recuperar una sola página, por lo que las páginas capturadas previamente no se usarían de todos modos.

Returns:

las opciones de solicitud de fuente de cambios modificadas.

getThroughputControlGroupName

public String getThroughputControlGroupName()

Obtenga el nombre del grupo de control de rendimiento.

Returns:

Nombre del grupo de control de rendimiento.

isQuotaInfoEnabled

public boolean isQuotaInfoEnabled()

Obtiene la configuración quotaInfoEnabled para la solicitud de fuente de cambios en el servicio de base de datos de Azure Cosmos DB. quotaInfoEnabled se usa para habilitar o deshabilitar la obtención de estadísticas relacionadas con la cuota

Returns:

true si quotaInfoEnabled está habilitado

setDiagnosticsThresholds

public CosmosChangeFeedRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

Permite invalidar los umbrales de diagnóstico para una operación específica.

Parameters:

operationSpecificThresholds - invalidación del umbral de diagnóstico para esta operación

Returns:

CosmosQueryRequestOptions.

setExcludedRegions

public CosmosChangeFeedRequestOptions setExcludedRegions(List excludeRegions)

Lista de regiones que se van a excluir para la solicitud o reintentos. Ejemplo "Este de EE. UU." o "Este de EE. UU., Oeste de EE. UU. " Estas regiones se excluirán de la lista de regiones preferidas.

Parameters:

excludeRegions - lista de regiones

Returns:

el CosmosChangeFeedRequestOptions

setMaxItemCount

public CosmosChangeFeedRequestOptions setMaxItemCount(int maxItemCount)

Establece el número máximo de elementos que se devolverán en la operación de enumeración.

Parameters:

maxItemCount - número máximo de elementos.

Returns:

FeedOptionsBase.

setMaxPrefetchPageCount

public CosmosChangeFeedRequestOptions setMaxPrefetchPageCount(int maxPrefetchPageCount)

Establece el número máximo de páginas que se capturarán previamente desde el back-end de forma asincrónica en segundo plano. Al capturar previamente estos cambios, se puede aumentar el rendimiento del procesamiento de los registros de fuente de cambios porque el procesamiento no tiene que detenerse mientras espera a que las operaciones de E/S recuperen un nuevo formulario de página para completar el back-end. El único escenario en el que puede resultar útil deshabilitar las páginas de captura previa (con setMaxPrefetchPageCount(0)) sería cuando el autor de la llamada solo planea recuperar una sola página, por lo que las páginas capturadas previamente no se usarían de todos modos.

Parameters:

maxPrefetchPageCount - el número máximo de páginas que se capturarán previamente desde el back-end de forma asincrónica en segundo plano.

Returns:

las opciones de solicitud de fuente de cambios modificadas.

setQuotaInfoEnabled

public void setQuotaInfoEnabled(boolean quotaInfoEnabled)

Obtiene la configuración quotaInfoEnabled para la solicitud de fuente de cambios en el servicio de base de datos de Azure Cosmos DB. quotaInfoEnabled se usa para habilitar o deshabilitar la obtención de estadísticas relacionadas con la cuota

Parameters:

quotaInfoEnabled - un valor booleano que indica si quotaInfoEnabled está habilitado o no

setThroughputControlGroupName

public CosmosChangeFeedRequestOptions setThroughputControlGroupName(String throughputControlGroupName)

Establezca el nombre del grupo de control de rendimiento.

Parameters:

throughputControlGroupName - Nombre del grupo de control de rendimiento.

Returns:

Un objeto CosmosChangeFeedRequestOptions.