CosmosItemRequestOptions Classe

Pacote:

com.azure.cosmos.models

Artefato Maven:

com.azure:azure-cosmos:4.54.0

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

public class CosmosItemRequestOptions

Encapsula as opções que podem ser especificadas para uma solicitação emitida para o Cosmos Item.

Resumo do Construtor

Construtor	Description
CosmosItemRequestOptions()	Construtor

Resumo do método

Modificador e tipo	Método e descrição
ConsistencyLevel	getConsistencyLevel() Obtém o nível de consistência necessário para a solicitação.
DedicatedGatewayRequestOptions	getDedicatedGatewayRequestOptions() Obtém as opções de solicitação de gateway dedicado
List<String>	getExcludedRegions() Obtém a lista de regiões a serem excluídas para a solicitação/repetições.
String	getIfMatchETag() Obtém o If-Match (ETag) associado à solicitação no serviço do Azure Cosmos DB.
String	getIfNoneMatchETag() Obtém a ETag (If-None-Match) associada à solicitação no serviço do Azure Cosmos DB.
IndexingDirective	getIndexingDirective() Obtém a diretiva de indexação (índice, não indexar etc).
List<String>	getPostTriggerInclude() Obtém os gatilhos a serem invocados após a operação.
List<String>	getPreTriggerInclude() Obtém os gatilhos a serem invocados antes da operação.
String	getSessionToken() Obtém o token para uso com consistência de sessão.
Duration	getThresholdForDiagnosticsOnTracer() Obtém o limiteparao OnTracer de Diagnóstico, se a latência na operação CRUD for maior do que essa diagnóstico será enviada para abrir o exportador de telemetria como eventos no intervalo de rastreamento da api CRUD de ponta a ponta.
String	getThroughputControlGroupName() Obtém o nome do grupo de controle de taxa de transferência.
Boolean	isContentResponseOnWriteEnabled() Obtém o booliano para retornar apenas os cabeçalhos e o código status na resposta do Cosmos DB no caso das operações Criar, Atualizar e Excluir no CosmosItem.
CosmosItemRequestOptions	setConsistencyLevel(ConsistencyLevel consistencyLevel) Define o nível de consistência necessário para a solicitação.
CosmosItemRequestOptions	setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled) Define o booliano para retornar apenas os cabeçalhos e status código na resposta do Cosmos DB no caso das operações Criar, Atualizar e Excluir no Item do Cosmos.
CosmosItemRequestOptions	setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig endToEndOperationLatencyPolicyConfig) Define o CosmosEndToEndOperationLatencyPolicyConfig a ser usado para a solicitação.
CosmosItemRequestOptions	setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions) Define as opções de solicitação de gateway dedicado
CosmosItemRequestOptions	setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds) Permite substituir os limites de diagnóstico para uma operação específica.
CosmosItemRequestOptions	setExcludedRegions(List<String> excludeRegions) Lista de regiões a serem excluídas para a solicitação/repetições.
CosmosItemRequestOptions	setIfMatchETag(String ifMatchETag) Define o If-Match (ETag) associado à solicitação no serviço do Azure Cosmos DB.
CosmosItemRequestOptions	setIfNoneMatchETag(String ifNoneMatchETag) Define a ETag (If-None-Match) associada à solicitação no serviço do Azure Cosmos DB.
CosmosItemRequestOptions	setIndexingDirective(IndexingDirective indexingDirective) Define a diretiva de indexação (índice, não indexar etc).
CosmosItemRequestOptions	setNonIdempotentWriteRetryPolicy(boolean nonIdempotentWriteRetriesEnabled, boolean useTrackingIdPropertyForCreateAndReplace) Habilita novas tentativas automáticas para operações de gravação mesmo quando o SDK não pode garantir que elas sejam idempotentes.
CosmosItemRequestOptions	setPostTriggerInclude(List<String> postTriggerInclude) Define os gatilhos a serem invocados após a operação.
CosmosItemRequestOptions	setPreTriggerInclude(List<String> preTriggerInclude) Define os gatilhos a serem invocados antes da operação.
CosmosItemRequestOptions	setSessionToken(String sessionToken) Define o token para uso com consistência de sessão.
CosmosItemRequestOptions	setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer) Define o limiteparao OnTracer de Diagnóstico, se a latência na operação CRUD for maior do que essa diagnóstico será enviada para abrir o exportador de telemetria como eventos no intervalo de rastreamento da api CRUD de ponta a ponta.
void	setThroughputControlGroupName(String throughputControlGroupName) Define 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 construtor

CosmosItemRequestOptions

public CosmosItemRequestOptions()

Construtor

Detalhes do método

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Obtém o nível de consistência necessário para a solicitação.

Returns:

o nível de consistência.

getDedicatedGatewayRequestOptions

public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()

Obtém as opções de solicitação de gateway dedicado

Returns:

as opções de solicitação de gateway dedicado

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

getIfMatchETag

public String getIfMatchETag()

Obtém o If-Match (ETag) associado à solicitação no serviço do Azure Cosmos DB.

Returns:

o ifMatchETag associado à solicitação.

getIfNoneMatchETag

public String getIfNoneMatchETag()

Obtém a ETag (If-None-Match) associada à solicitação no serviço do Azure Cosmos DB.

Returns:

o ifNoneMatchETag associado à solicitação.

getIndexingDirective

public IndexingDirective getIndexingDirective()

Obtém a diretiva de indexação (índice, não indexar etc).

Returns:

a diretiva de indexação.

getPostTriggerInclude

public List getPostTriggerInclude()

Obtém os gatilhos a serem invocados após a operação.

Returns:

os gatilhos a serem invocados após a operação.

getPreTriggerInclude

public List getPreTriggerInclude()

Obtém os gatilhos a serem invocados antes da operação.

Returns:

os gatilhos a serem invocados antes da operação.

getSessionToken

public String getSessionToken()

Obtém o token para uso com consistência de sessão.

Returns:

o token de sessão.

getThresholdForDiagnosticsOnTracer

public Duration getThresholdForDiagnosticsOnTracer()

Obtém o thresholdForDiagnosticsOnTracer, se a latência na operação CRUD for maior que essa diagnóstico será enviada para abrir o exportador de telemetria como eventos no intervalo de rastreamento da api CRUD de ponta a ponta. O padrão é 100 ms.

Returns:

thresholdForDiagnosticsOnTracerInMS o limite de latência para diagnóstico no rastreador.

getThroughputControlGroupName

public String getThroughputControlGroupName()

Obtém o nome do grupo de controle de taxa de transferência.

Returns:

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

isContentResponseOnWriteEnabled

public Boolean isContentResponseOnWriteEnabled()

Obtém o booliano para retornar apenas os cabeçalhos e status código na resposta do Cosmos DB no caso das operações Criar, Atualizar e Excluir no CosmosItem. Se definido como false, o serviço não retornará uma carga na resposta. Ele reduz a rede e a carga da CPU, não enviando a carga de volta pela rede e serializando-a no cliente. Esse recurso não afeta o uso de RU para operações de leitura ou gravação. OBSERVAÇÃO: esse sinalizador também está presente em CosmosClientBuilder, no entanto, se especificado em CosmosItemRequestOptions, ele substituirá o valor especificado em CosmosClientBuilder para essa solicitação. Por padrão, isso é nulo.

Returns:

um booliano que indica se a carga será incluída na resposta ou não para essa solicitação.

setConsistencyLevel

public CosmosItemRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)

Define o nível de consistência necessário para a solicitação. O nível de consistência efetivo só pode ser reduzido para solicitações de leitura/consulta. Portanto, quando o nível de consistência padrão da Conta é, por exemplo, Sessão, você pode especificar em um nível de solicitação por solicitação para solicitações individuais que a consistência eventual é suficiente , o que poderia reduzir a latência e os encargos de RU para essa solicitação, mas não garantirá mais a consistência da sessão (leitura-sua-própria gravação) OBSERVAÇÃO: se o nível de consistência definido em um nível de solicitação aqui for SESSION e o nível de consistência padrão especificado ao construir a instância do CosmosClient por meio de CosmosClientBuilder.consistencyLevel não é SESSION, então a captura de token de sessão também precisa ser habilitada chamando CosmosClientBuilder:sessionCapturingOverrideEnabled(true) explicitamente.

Parameters:

consistencyLevel - o nível de consistência.

Returns:

o CosmosItemRequestOptions.

setContentResponseOnWriteEnabled

public CosmosItemRequestOptions setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)

Define o booliano para retornar apenas os cabeçalhos e status código na resposta do Cosmos DB no caso das operações Criar, Atualizar e Excluir no CosmosItem. Se definido como false, o serviço não retornará a carga na resposta. Ele reduz a rede e a carga da CPU, não enviando a carga de volta pela rede e serializando-a no cliente. Esse recurso não afeta o uso de RU para operações de leitura ou gravação. Por padrão, isso é nulo. OBSERVAÇÃO: esse sinalizador também está presente em CosmosClientBuilder, no entanto, se especificado em CosmosItemRequestOptions, ele substituirá o valor especificado em CosmosClientBuilder para essa solicitação.

Parameters:

contentResponseOnWriteEnabled - um booliano que indica se o conteúdo será incluído na resposta ou não para essa solicitação

Returns:

o CosmosItemRequestOptions.

setCosmosEndToEndOperationLatencyPolicyConfig

public CosmosItemRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig endToEndOperationLatencyPolicyConfig)

Define o CosmosEndToEndOperationLatencyPolicyConfig a ser usado para a solicitação. Se a configuração já estiver definida no cliente, isso substituirá a configuração no nível do cliente para essa solicitação

Parameters:

endToEndOperationLatencyPolicyConfig - O CosmosEndToEndOperationLatencyPolicyConfig

Returns:

CosmosItemRequestOptions

setDedicatedGatewayRequestOptions

public CosmosItemRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)

Define as opções de solicitação de gateway dedicado

Parameters:

dedicatedGatewayRequestOptions - Opções de solicitação de gateway dedicado

Returns:

o CosmosItemRequestOptions

setDiagnosticsThresholds

public CosmosItemRequestOptions 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 CosmosItemRequestOptions.

setExcludedRegions

public CosmosItemRequestOptions setExcludedRegions(List excludeRegions)

Lista de regiões a serem excluídas para a solicitação/repetições. 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 CosmosItemRequestOptions

setIfMatchETag

public CosmosItemRequestOptions setIfMatchETag(String ifMatchETag)

Define o If-Match (ETag) associado à solicitação no serviço do Azure Cosmos DB.

Parameters:

ifMatchETag - o ifMatchETag associado à solicitação.

Returns:

as opções de solicitação atuais

setIfNoneMatchETag

public CosmosItemRequestOptions setIfNoneMatchETag(String ifNoneMatchETag)

Define a ETag (If-None-Match) associada à solicitação no serviço do Azure Cosmos DB.

Parameters:

ifNoneMatchETag - o ifNoneMatchETag associado à solicitação.

Returns:

as opções de solicitação atuais

setIndexingDirective

public CosmosItemRequestOptions setIndexingDirective(IndexingDirective indexingDirective)

Define a diretiva de indexação (índice, não indexar etc).

Parameters:

indexingDirective - a diretiva de indexação.

Returns:

o CosmosItemRequestOptions.

setNonIdempotentWriteRetryPolicy

public CosmosItemRequestOptions setNonIdempotentWriteRetryPolicy(boolean nonIdempotentWriteRetriesEnabled, boolean useTrackingIdPropertyForCreateAndReplace)

Habilita novas tentativas automáticas para operações de gravação mesmo quando o SDK não pode garantir que elas sejam idempotentes. Essa é uma substituição do CosmosClientBuilder#setNonIdempotentWriteRetryPolicy(boolean, boolean) comportamento de uma solicitação/operação específica. OBSERVAÇÃO: a configuração no CosmosClientBuilder determinará o comportamento padrão das operações Criar, Substituir, Upsert e Excluir. Ele pode ser substituído na base por solicitação nas opções de solicitação. Para operações de patch por padrão (a menos que sejam substituídas nas opções de solicitação), as tentativas sempre são desabilitadas por padrão. - Criar: novas tentativas podem resultar em solicitações de 409 conflitos (mais) para o aplicativo quando uma nova tentativa tenta criar um documento que a tentativa inicial criou com êxito. Ao habilitar useTrackingIdPropertyForCreateAndReplace, isso pode ser evitado para 409-Conflict causado por novas tentativas. - Substitua: as novas tentativas podem resultar em solicitações de falha de pré-condição (mais) 412 para o aplicativo quando uma operação de substituição estiver usando uma marcar (etag) pré-condição e uma nova tentativa tentar atualizar um documento que a tentativa inicial foi atualizada com êxito (fazendo com que a etag seja alterada). Ao habilitar useTrackingIdPropertyForCreateAndReplace, isso pode ser evitado para falhas de pré-condição 412 causadas por repetições. – Excluir: novas tentativas podem resultar em solicitações de 404 solicitações de 404-NotFound quando uma operação de exclusão é repetida e a tentativa inicial foi bem-sucedida. O ideal é que as repetições de gravação só sejam habilitadas quando os aplicativos puderem lidar normalmente com o 404 – Não Encontrado. - Upsert: as tentativas podem resultar na exibição de um 200 - parecendo que o documento foi atualizado quando, na verdade, o documento foi criado pela tentativa inicial - portanto, logicamente dentro da mesma operação. Isso só afetará os aplicativos que têm maiúsculas e minúsculas especiais para 201 versus 200 para operações upsert. Patch: as novas tentativas de patch podem, mas nem sempre serão idempotentes , dependendo completamente das operações de patch que estão sendo executadas e dos filtros de pré-condição que estão sendo usados. Antes de habilitar novas tentativas de gravação para patch, isso precisa ser cuidadosamente revisado e os testes – que são repetições de wht para patch só podem ser habilitados nas opções de solicitação – qualquer configuração de todo o CosmosClient será ignorada. Execução em massa/exclusão por PK/Lote Transacional/Procedimento Stroed: não há suporte para novas tentativas automáticas.

Parameters:

nonIdempotentWriteRetriesEnabled - um sinalizador que indica se o SDK deve habilitar novas tentativas automáticas para uma operação quando a idempotency não pode ser garantida porque, para a tentativa anterior, uma solicitação foi enviada na rede.

useTrackingIdPropertyForCreateAndReplace - um sinalizador que indica se as operações de gravação podem usar a propriedade do sistema trackingId '/_trackingId' para permitir a identificação de conflitos e falhas de pré-condição devido a novas tentativas. Se habilitado, cada documento sendo criado ou substituído terá uma propriedade "/_trackingId" adicional para a qual o valor será atualizado pelo SDK. Se não for desejado adicionar essa nova propriedade json (por exemplo, devido ao aumento de RU com base no tamanho da carga ou porque faz com que os documentos excedam o limite máximo de tamanho de carga), o uso dessa propriedade do sistema pode ser desabilitado definindo esse parâmetro como false. Isso significa que pode haver um nível mais alto de 409/312 devido a novas tentativas - e os aplicativos precisariam lidar com eles normalmente por conta própria.

Returns:

o CosmosItemRequestOptions

setPostTriggerInclude

public CosmosItemRequestOptions setPostTriggerInclude(List postTriggerInclude)

Define os gatilhos a serem invocados após a operação.

Parameters:

postTriggerInclude - os gatilhos a serem invocados após a operação.

Returns:

o CosmosItemRequestOptions.

setPreTriggerInclude

public CosmosItemRequestOptions setPreTriggerInclude(List preTriggerInclude)

Define os gatilhos a serem invocados antes da operação.

Parameters:

preTriggerInclude - os gatilhos a serem invocados antes da operação.

Returns:

o CosmosItemRequestOptions.

setSessionToken

public CosmosItemRequestOptions setSessionToken(String sessionToken)

Define o token para uso com consistência de sessão.

Parameters:

sessionToken - o token de sessão.

Returns:

o CosmosItemRequestOptions.

setThresholdForDiagnosticsOnTracer

public CosmosItemRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)

Define o thresholdForDiagnosticsOnTracer, se a latência na operação CRUD for maior do que essa diagnóstico será enviada para abrir o exportador de telemetria como eventos no intervalo de rastreamento da api CRUD de ponta a ponta. O padrão é 100 ms.

Parameters:

thresholdForDiagnosticsOnTracer - o limite de latência para diagnóstico no rastreamento.

Returns:

o CosmosItemRequestOptions

setThroughputControlGroupName

public void setThroughputControlGroupName(String throughputControlGroupName)

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

Parameters:

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