CosmosClientBuilder Classe

public CosmosClientBuilder()

Cria uma instância de um novo construtor de clientes do Cosmos.

public CosmosClientBuilder authorizationTokenResolver(CosmosAuthorizationTokenResolver cosmosAuthorizationTokenResolver)

Define o resolvedor de token

Parameters:

Returns:

public CosmosAsyncClient buildAsyncClient()

Cria um cliente assíncrono do Cosmos com as propriedades fornecidas

Returns:

public CosmosClient buildClient()

Cria um cliente de sincronização do Cosmos com as propriedades fornecidas

Returns:

public CosmosClientBuilder clientTelemetryConfig(CosmosClientTelemetryConfig telemetryConfig)

Retorna a instância de configuração de telemetria do cliente para este construtor

Parameters:

Returns:

public CosmosClientBuilder clientTelemetryEnabled(boolean clientTelemetryEnabled)

Define o sinalizador para habilitar a telemetria do cliente, que coletará periodicamente estatísticas de agregação de operações de banco de dados, informações do sistema como cpu/memória e as enviará para o serviço de monitoramento do Cosmos, o que será útil durante a depuração.

O valor DEFAULT é false, indicando que isso é aceita no recurso, por padrão, nenhuma coleção de telemetria.

Parameters:

Returns:

public CosmosClientBuilder connectionSharingAcrossClientsEnabled(boolean connectionSharingAcrossClientsEnabled)

Habilita o compartilhamento de conexões em vários clientes do Cosmos. O padrão é false.

CosmosAsyncClient client1 = new CosmosClientBuilder()
         .endpoint(serviceEndpoint1)
         .key(key1)
         .consistencyLevel(ConsistencyLevel.SESSION)
         .connectionSharingAcrossClientsEnabled(true)
         .buildAsyncClient();

 CosmosAsyncClient client2 = new CosmosClientBuilder()
         .endpoint(serviceEndpoint2)
         .key(key2)
         .consistencyLevel(ConsistencyLevel.SESSION)
         .connectionSharingAcrossClientsEnabled(true)
         .buildAsyncClient();

 // when configured this way client1 and client2 will share connections when possible.

Quando você tem várias instâncias do cliente do Cosmos na mesma JVM interagindo com várias contas do Cosmos, habilitar isso permite o compartilhamento de conexão no modo direto, se possível, entre instâncias de cliente do Cosmos. Observe que, ao definir essa opção, a configuração da conexão (por exemplo, configuração de tempo limite do soquete, configuração de tempo limite ocioso) do primeiro cliente instanciado será usada para todas as outras instâncias de cliente.

Parameters:

Returns:

public CosmosClientBuilder consistencyLevel(ConsistencyLevel desiredConsistencyLevel)

Define o ConsistencyLevel a ser usado Por padrão, SESSION a consistência será usada.

Parameters:

Returns:

public CosmosClientBuilder contentResponseOnWriteEnabled(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 que é por padrão), o serviço não retorna 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 é falso.

Parameters:

Returns:

public CosmosClientBuilder credential(AzureKeyCredential credential)

Define o AzureKeyCredential a ser usado

Parameters:

Returns:

public CosmosClientBuilder credential(TokenCredential credential)

Define o TokenCredential usado para autorizar solicitações enviadas ao serviço. Consulte a documentação de identidade e autenticação do SDK do Azure para Java para obter mais detalhes sobre o uso adequado do TokenCredential tipo.

Parameters:

Returns:

public CosmosClientBuilder directMode()

Define a configuração de conexão DIRECT padrão a ser usada. Por padrão, o construtor é inicializado com directMode()

Returns:

public CosmosClientBuilder directMode(DirectConnectionConfig directConnectionConfig)

Define a configuração de conexão DIRECT a ser usada. Por padrão, o construtor é inicializado com directMode()

Parameters:

Returns:

public CosmosClientBuilder directMode(DirectConnectionConfig directConnectionConfig, GatewayConnectionConfig gatewayConnectionConfig)

Define a configuração de conexão DIRECT a ser usada. gatewayConnectionConfig – representa a configuração básica a ser usada para o cliente de gateway. Mesmo no modo de conexão direta, algumas das operações de metadados passam pelo cliente de gateway, a configuração da configuração de conexão de gateway nessa API não afeta o modo de conexão, que será Direct nesse caso.

Parameters:

Returns:

public CosmosClientBuilder endToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig cosmosEndToEndOperationLatencyPolicyConfig)

Define o CosmosEndToEndOperationLatencyPolicyConfig no cliente

Parameters:

Returns:

public CosmosClientBuilder endpoint(String endpoint)

Define o ponto de extremidade do Azure Cosmos DB ao qual o SDK se conectará

Parameters:

Returns:

public CosmosClientBuilder endpointDiscoveryEnabled(boolean endpointDiscoveryEnabled)

Define o sinalizador para habilitar a descoberta de ponto de extremidade para contas de banco de dados replicadas geograficamente.

Quando EnableEndpointDiscovery for true, o SDK descobrirá automaticamente as regiões de gravação e leitura atuais para garantir que as solicitações sejam enviadas para a região correta com base na capacidade da região e na preferência do usuário.

O valor padrão dessa propriedade é verdadeiro indicando que a descoberta de ponto de extremidade está habilitada.

Parameters:

Returns:

public CosmosClientBuilder excludedRegionsSupplier(Supplier excludedRegionsSupplier)

Define um Supplier que retorna uma CosmosExcludedRegions instância quando Supplier#get() é invocado. A solicitação não será roteada para regiões presentes em getExcludedRegions() para cenários de cobertura e cenários de repetição para a carga de trabalho executada por meio dessa instância do / CosmosClientCosmosAsyncClient .

Parameters:

Returns:

public CosmosClientBuilder gatewayMode()

Define a configuração de conexão GATEWAY padrão a ser usada.

Returns:

public CosmosClientBuilder gatewayMode(GatewayConnectionConfig gatewayConnectionConfig)

Define a configuração de conexão GATEWAY a ser usada.

Parameters:

Returns:

public CosmosClientBuilder key(String key)

Define uma chave master ou somente leitura usada para executar a autenticação para acessar o recurso.

Parameters:

Returns:

public CosmosClientBuilder multipleWriteRegionsEnabled(boolean multipleWriteRegionsEnabled)

Define o sinalizador para habilitar gravações em qualquer região para contas de banco de dados replicadas geograficamente no serviço do Azure Cosmos DB.

Quando o valor dessa propriedade for true, o SDK direcionará operações de gravação para regiões graváveis disponíveis da conta de banco de dados replicada geograficamente. As regiões graváveis são ordenadas pela propriedade PreferredRegions. Definir o valor da propriedade como true não terá efeito até EnableMultipleWriteRegions em DatabaseAccount também ser definido como true.

O valor DEFAULT é verdadeiro indicando que as gravações são direcionadas para regiões graváveis disponíveis da conta de banco de dados replicada geograficamente.

Parameters:

Returns:

public CosmosClientBuilder openConnectionsAndInitCaches(CosmosContainerProactiveInitConfig proactiveContainerInitConfig)

Define o que permite o CosmosContainerProactiveInitConfig aquecimento de caches e conexões associadas a contêineres obtidos de getCosmosContainerIdentities() para réplicas obtidas das primeiras k regiões preferenciais em que k é avaliado como getProactiveConnectionRegionsCount().

Usar a CosmosContainerProactiveInitConfigBuilder classe para instanciar a CosmosContainerProactiveInitConfig classe

Parameters:

Returns:

public CosmosClientBuilder permissions(List permissions)

Define a lista de permissões, que contém os tokens de recurso necessários para acessar recursos.

Parameters:

Returns:

public CosmosClientBuilder preferredRegions(List preferredRegions)

Define as regiões preferenciais para contas de banco de dados replicadas geograficamente. Por exemplo, "Leste dos EUA" como a região preferencial.

Quando EnableEndpointDiscovery for true e PreferredRegions não estiver vazio, o SDK preferirá usar as regiões no contêiner na ordem em que forem especificadas para executar operações.

Se EnableEndpointDiscovery estiver definido como false, essa propriedade será ignorada.

Parameters:

Returns:

public CosmosClientBuilder readRequestsFallbackEnabled(boolean readRequestsFallbackEnabled)

Define se as leituras devem ser permitidas para ir para várias regiões configuradas em uma conta do serviço do Azure Cosmos DB.

O valor DEFAULT é true.

Se essa propriedade não estiver definida, o padrão será true para todos os Níveis de Consistência diferentes de Desatualização Limitada, o padrão será false para Desatualização Limitada. 1. #endpointDiscoveryEnabled é true 2. a conta do Azure Cosmos DB tem mais de uma região

Parameters:

Returns:

public CosmosClientBuilder resourceToken(String resourceToken)

Define um token de recurso usado para executar a autenticação para acessar o recurso.

Parameters:

Returns:

public CosmosClientBuilder sessionCapturingOverrideEnabled(boolean sessionCapturingOverrideEnabled)

A captura de sessão está habilitada por padrão para SESSION. Para outros níveis de consistência, ele não é necessário, a menos que você precise enviar solicitações ocasionalmente com Consistência de Sessão enquanto o cliente não estiver configurado na sessão.

habilitar a captura de sessão para o modo sessão não tem efeito.

Parameters:

Returns:

public CosmosClientBuilder sessionRetryOptions(SessionRetryOptions sessionRetryOptions)

Define a SessionRetryOptions instância no cliente.

Essa configuração ajuda a otimizar o comportamento de repetição associado NOT_FOUND / READ_SESSION_NOT_AVAILABLE a cenários ou 404 / 1002 que ocorrem quando a consistência de destino usada pela solicitação é Consistência de Sessão e uma solicitação vai para uma região que não tem dados recentes o suficiente que a solicitação está procurando.

ISENÇÃO DE RESPONSABILIDADE: a configuração SessionRetryOptions modificará o comportamento de repetição para todas as operações ou cargas de trabalho executadas por meio dessa instância do cliente.

Para contas de várias gravações:

• Para uma solicitação de leitura que vai para uma região de leitura local, é possível otimizar a disponibilidade fazendo com que a solicitação seja repetida em uma região de gravação diferente, pois a outra região de gravação pode ter dados mais atualizados.
• Para uma solicitação de leitura que vai para uma região de gravação local, isso pode ajudar a mudar para uma região de gravação diferente imediatamente, desde que a região de gravação local não tenha os dados mais atualizados.
• Para uma solicitação de gravação que vai para uma região de gravação local, isso pode ajudar a alternar para uma região de gravação diferente imediatamente, desde que a região de gravação local não tenha os dados mais atualizados.

Para contas de gravação única:

• Se uma solicitação de leitura for para uma região de leitura local, ela ajudará a alternar para a região de gravação mais rapidamente.
• Se uma solicitação de leitura for para uma região de gravação, a SessionRetryOptions configuração não será importante, pois a região de gravação em uma conta de gravação única tem os dados mais atualizados.
• Para uma gravação em uma região de gravação em uma conta de gravação única, os erros não se aplicam, READ_SESSION_NOT_AVAILABLE pois a região de gravação sempre tem a versão mais recente dos dados e todas as gravações vão para o réplica primário nessa região. Portanto, os atrasos de replicação que causam erros não são aplicáveis aqui.

Sobre dicas de alternância de região:

• Para priorizar a região local para novas tentativas, use a dica LOCAL_REGION_PREFERRED
• Para mover novas tentativas para uma região diferente/remota mais rapidamente, use a dica REMOTE_REGION_PREFERRED

Operações com suporte:

• Ler
• Consulta
• Criar
• Substitua
• Upsert
• Excluir
• Patch
• Lote
• Em massa

Parameters:

Returns:

public CosmosClientBuilder throttlingRetryOptions(ThrottlingRetryOptions throttlingRetryOptions)

Define as opções de política de repetição associadas à instância do DocumentClient.

As propriedades na classe RetryOptions permitem que o aplicativo personalize as políticas de repetição internas. Essa propriedade é opcional. Quando não está definido, o SDK usa os valores padrão para configurar as políticas de repetição. Consulte Classe RetryOptions para obter mais detalhes.

Parameters:

Returns:

public CosmosClientBuilder userAgentSuffix(String userAgentSuffix)

define o valor do sufixo user-agent.

Parameters:

Returns: