CosmosItemRequestOptions Clase
- java.
lang. Object - com.
azure. cosmos. models. CosmosItemRequestOptions
- com.
public class CosmosItemRequestOptions
Encapsula las opciones que se pueden especificar para una solicitud emitida a cosmos Item.
Resumen del constructor
Constructor | Description |
---|---|
CosmosItemRequestOptions() |
Constructor |
Resumen del método
Modificador y tipo | Método y descripción |
---|---|
Consistency |
getConsistencyLevel()
Obtiene el nivel de coherencia necesario para la solicitud. |
Dedicated |
getDedicatedGatewayRequestOptions()
Obtiene las opciones de solicitud de puerta de enlace dedicada. |
List<String> |
getExcludedRegions()
Obtiene la lista de regiones que se excluirán para la solicitud o reintentos. |
String |
getIfMatchETag()
Obtiene el If-Match (ETag) asociado a la solicitud en el servicio Azure Cosmos DB. |
String |
getIfNoneMatchETag()
Obtiene el if-none-match (ETag) asociado a la solicitud en el servicio Azure Cosmos DB. |
Indexing |
getIndexingDirective()
Obtiene la directiva de indexación (indexación, no indexar, etc.). |
List<String> |
getPostTriggerInclude()
Obtiene los desencadenadores que se invocarán después de la operación. |
List<String> |
getPreTriggerInclude()
Obtiene los desencadenadores que se invocarán antes de la operación. |
String |
getSessionToken()
Obtiene el token para su uso con la coherencia de la sesión. |
Duration |
getThresholdForDiagnosticsOnTracer()
Obtiene el umbral |
String |
getThroughputControlGroupName()
Obtiene el nombre del grupo de control de rendimiento. |
Boolean |
isContentResponseOnWriteEnabled()
Obtiene el valor booleano para devolver solo los encabezados y el código de estado en la respuesta de Cosmos DB en el caso de las operaciones Crear, Actualizar y Eliminar en Cosmos |
Cosmos |
setConsistencyLevel(ConsistencyLevel consistencyLevel)
Establece el nivel de coherencia necesario para la solicitud. |
Cosmos |
setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)
Establece el valor booleano para que solo devuelva los encabezados y el código de estado en la respuesta de Cosmos DB en el caso de las operaciones Crear, Actualizar y Eliminar en Cosmos |
Cosmos |
setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig endToEndOperationLatencyPolicyConfig)
Establece el objeto CosmosEndToEndOperationLatencyPolicyConfig que se va a usar para la solicitud. |
Cosmos |
setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)
Establece las opciones de solicitud de puerta de enlace dedicada |
Cosmos |
setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)
Permite invalidar los umbrales de diagnóstico para una operación específica. |
Cosmos |
setExcludedRegions(List<String> excludeRegions)
Lista de regiones que se van a excluir para la solicitud o reintentos. |
Cosmos |
setIfMatchETag(String ifMatchETag)
Establece el If-Match (ETag) asociado a la solicitud en el servicio Azure Cosmos DB. |
Cosmos |
setIfNoneMatchETag(String ifNoneMatchETag)
Establece if-none-match (ETag) asociado a la solicitud en el servicio Azure Cosmos DB. |
Cosmos |
setIndexingDirective(IndexingDirective indexingDirective)
Establece la directiva de indexación (índice, no indexar, etc.). |
Cosmos |
setNonIdempotentWriteRetryPolicy(boolean nonIdempotentWriteRetriesEnabled, boolean useTrackingIdPropertyForCreateAndReplace)
Habilita reintentos automáticos para operaciones de escritura incluso cuando el SDK no puede garantizar que sean idempotentes. |
Cosmos |
setPostTriggerInclude(List<String> postTriggerInclude)
Establece los desencadenadores que se invocarán después de la operación. |
Cosmos |
setPreTriggerInclude(List<String> preTriggerInclude)
Establece los desencadenadores que se invocarán antes de la operación. |
Cosmos |
setSessionToken(String sessionToken)
Establece el token para su uso con coherencia de sesión. |
Cosmos |
setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)
Establece el umbral |
void |
setThroughputControlGroupName(String throughputControlGroupName)
Establece el nombre del grupo de control de rendimiento. |
Métodos heredados de java.lang.Object
Detalles del constructor
CosmosItemRequestOptions
public CosmosItemRequestOptions()
Constructor
Detalles del método
getConsistencyLevel
public ConsistencyLevel getConsistencyLevel()
Obtiene el nivel de coherencia necesario para la solicitud.
Returns:
getDedicatedGatewayRequestOptions
public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()
Obtiene las opciones de solicitud de puerta de enlace dedicada.
Returns:
getExcludedRegions
public List
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:
getIfMatchETag
public String getIfMatchETag()
Obtiene el If-Match (ETag) asociado a la solicitud en el servicio Azure Cosmos DB.
Returns:
getIfNoneMatchETag
public String getIfNoneMatchETag()
Obtiene el if-none-match (ETag) asociado a la solicitud en el servicio Azure Cosmos DB.
Returns:
getIndexingDirective
public IndexingDirective getIndexingDirective()
Obtiene la directiva de indexación (indexación, no indexar, etc.).
Returns:
getPostTriggerInclude
public List
Obtiene los desencadenadores que se invocarán después de la operación.
Returns:
getPreTriggerInclude
public List
Obtiene los desencadenadores que se invocarán antes de la operación.
Returns:
getSessionToken
public String getSessionToken()
Obtiene el token para su uso con la coherencia de la sesión.
Returns:
getThresholdForDiagnosticsOnTracer
public Duration getThresholdForDiagnosticsOnTracer()
Obtiene el thresholdForDiagnosticsOnTracer, si la latencia en la operación CRUD es mayor que este diagnóstico se enviará para abrir el exportador de telemetría como eventos en el intervalo de seguimiento de la API CRUD de un extremo a otro. El valor predeterminado es 100 ms.
Returns:
getThroughputControlGroupName
public String getThroughputControlGroupName()
Obtiene el nombre del grupo de control de rendimiento.
Returns:
isContentResponseOnWriteEnabled
public Boolean isContentResponseOnWriteEnabled()
Obtiene el valor booleano para devolver solo los encabezados y el código de estado en la respuesta de Cosmos DB en el caso de las operaciones Crear, Actualizar y Eliminar en CosmosItem. Si se establece en false, el servicio no devuelve una carga en la respuesta. Reduce la carga de red y CPU al no enviar la carga a través de la red y serializarla en el cliente. Esta característica no afecta al uso de RU para las operaciones de lectura o escritura. NOTA: Esta marca también está presente en CosmosClientBuilder, pero si se especifica en CosmosItemRequestOptions, invalidará el valor especificado en CosmosClientBuilder para esta solicitud. De forma predeterminada, es null.
Returns:
setConsistencyLevel
public CosmosItemRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)
Establece el nivel de coherencia necesario para la solicitud. El nivel de coherencia eficaz solo se puede reducir para las solicitudes de lectura y consulta. Por lo tanto, cuando el nivel de coherencia predeterminado de la cuenta es, por ejemplo, Sesión, puede especificar en un nivel de solicitud por solicitud para solicitudes individuales que la coherencia final es suficiente, lo que podría reducir la latencia y los cargos de RU para esta solicitud, pero no garantizará la coherencia de la sesión (lectura de su propia escritura) más NOTA: Si el nivel de coherencia establecido en un nivel de solicitud aquí es SESSION y el nivel de coherencia predeterminado especificado al construir la instancia de CosmosClient a través de . CosmosClientBuilder.consistencyLevel no es SESSION; la captura de tokens de sesión también debe habilitarse llamando explícitamente a CosmosClientBuilder:sessionCapturingOverrideEnabled(true).
Parameters:
Returns:
setContentResponseOnWriteEnabled
public CosmosItemRequestOptions setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)
Establece el valor booleano para devolver solo los encabezados y el código de estado en la respuesta de Cosmos DB en el caso de las operaciones Crear, Actualizar y Eliminar en CosmosItem. Si se establece en false, el servicio no devuelve la carga en la respuesta. Reduce la carga de red y CPU al no enviar la carga a través de la red y serializarla en el cliente. Esta característica no afecta al uso de RU para las operaciones de lectura o escritura. De forma predeterminada, es null. NOTA: Esta marca también está presente en CosmosClientBuilder, pero si se especifica en CosmosItemRequestOptions, invalidará el valor especificado en CosmosClientBuilder para esta solicitud.
Parameters:
Returns:
setCosmosEndToEndOperationLatencyPolicyConfig
public CosmosItemRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig endToEndOperationLatencyPolicyConfig)
Establece el objeto CosmosEndToEndOperationLatencyPolicyConfig que se va a usar para la solicitud. Si la configuración ya está establecida en el cliente, esto invalidará la configuración de nivel de cliente para esta solicitud.
Parameters:
Returns:
setDedicatedGatewayRequestOptions
public CosmosItemRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)
Establece las opciones de solicitud de puerta de enlace dedicada
Parameters:
Returns:
setDiagnosticsThresholds
public CosmosItemRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)
Permite invalidar los umbrales de diagnóstico para una operación específica.
Parameters:
Returns:
setExcludedRegions
public CosmosItemRequestOptions setExcludedRegions(List
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:
Returns:
setIfMatchETag
public CosmosItemRequestOptions setIfMatchETag(String ifMatchETag)
Establece el If-Match (ETag) asociado a la solicitud en el servicio Azure Cosmos DB.
Parameters:
Returns:
setIfNoneMatchETag
public CosmosItemRequestOptions setIfNoneMatchETag(String ifNoneMatchETag)
Establece if-none-match (ETag) asociado a la solicitud en el servicio Azure Cosmos DB.
Parameters:
Returns:
setIndexingDirective
public CosmosItemRequestOptions setIndexingDirective(IndexingDirective indexingDirective)
Establece la directiva de indexación (índice, no indexar, etc.).
Parameters:
Returns:
setNonIdempotentWriteRetryPolicy
public CosmosItemRequestOptions setNonIdempotentWriteRetryPolicy(boolean nonIdempotentWriteRetriesEnabled, boolean useTrackingIdPropertyForCreateAndReplace)
Habilita reintentos automáticos para operaciones de escritura incluso cuando el SDK no puede garantizar que sean idempotentes. Se trata de una invalidación del CosmosClientBuilder#setNonIdempotentWriteRetryPolicy(boolean, boolean) comportamiento de una solicitud o operación específica. NOTA: La configuración de CosmosClientBuilder determinará el comportamiento predeterminado para las operaciones Create, Replace, Upsert y Delete. Se puede invalidar en la base por solicitud en las opciones de solicitud. Para las operaciones de revisión de forma predeterminada (a menos que se invaliden en las opciones de solicitud) los reintentos siempre estén deshabilitados de forma predeterminada. - Crear: los reintentos pueden dar lugar a solicitudes de 409 conflictos (más) a la aplicación cuando un reintento intenta crear un documento que el intento inicial creó correctamente. Al habilitar useTrackingIdPropertyForCreateAndReplace, esto se puede evitar para el conflicto 409 causado por reintentos. - Reemplazar: los reintentos pueden dar lugar a solicitudes de error 412-Condición previa a la aplicación cuando una operación de reemplazo usa una comprobación de condición previa (etag) y un reintento intenta actualizar un documento que el intento inicial se actualizó correctamente (lo que provoca que la etiqueta electrónica cambie). Al habilitar useTrackingIdPropertyForCreateAndReplace, esto se puede evitar en caso de errores de condición previa 412 causados por reintentos. - Delete: los reintentos pueden dar lugar a solicitudes 404-NotFound que se después de reintentar una operación de eliminación y el intento inicial se realizó correctamente. Lo ideal es que los reintentos de escritura solo se habiliten cuando las aplicaciones puedan controlar correctamente 404 - No encontrado. - Upsert: los reintentos pueden dar lugar a que se muestra un 200 , con un aspecto similar al que se actualizó el documento cuando realmente el documento se ha creado mediante el intento inicial, por lo que lógicamente dentro de la misma operación. Esto solo afectará a las aplicaciones que tienen mayúsculas y minúsculas especiales para 201 frente a 200 para operaciones upsert. Revisión: los reintentos de revisión pueden pero no siempre serán idempotentes; depende completamente de las operaciones de revisión que se ejecutan y de los filtros de condición previa que se usan. Antes de habilitar los reintentos de escritura para la revisión, debe revisarse cuidadosamente y realizar pruebas, que es un reintentos de revisión solo se puede habilitar en las opciones de solicitud; se omitirá cualquier configuración de CosmosClient ancho. Procesamiento masivo/eliminación por lotes transaccionales/ejecución de procedimiento estrodado: no se admiten reintentos automáticos.
Parameters:
Returns:
setPostTriggerInclude
public CosmosItemRequestOptions setPostTriggerInclude(List
Establece los desencadenadores que se invocarán después de la operación.
Parameters:
Returns:
setPreTriggerInclude
public CosmosItemRequestOptions setPreTriggerInclude(List
Establece los desencadenadores que se invocarán antes de la operación.
Parameters:
Returns:
setSessionToken
public CosmosItemRequestOptions setSessionToken(String sessionToken)
Establece el token para su uso con coherencia de sesión.
Parameters:
Returns:
setThresholdForDiagnosticsOnTracer
public CosmosItemRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)
Establece thresholdForDiagnosticsOnTracer, si la latencia en la operación CRUD es mayor que este diagnóstico se enviará para abrir el exportador de telemetría como eventos en el intervalo de seguimiento de la API CRUD de un extremo a otro. El valor predeterminado es 100 ms.
Parameters:
Returns:
setThroughputControlGroupName
public void setThroughputControlGroupName(String throughputControlGroupName)
Establece el nombre del grupo de control de rendimiento.
Parameters:
Se aplica a
Azure SDK for Java