ConnectionPolicy Classe

  • java.lang.Object
    • com.microsoft.azure.cosmosdb.ConnectionPolicy

public class ConnectionPolicy

Representa a política de conexão associada a um DocumentClient no serviço de banco de dados do Azure Cosmos DB.

Resumo do Construtor

Construtor Description
ConnectionPolicy()

Construtor.

Resumo do método

Modificador e tipo Método e descrição
ConnectionMode getConnectionMode()

Obtém o modo de conexão usado no cliente.

ConnectionPolicy GetDefault()

Obtém a política de conexão padrão.

boolean getEnableEndpointDiscovery()

Obtém o sinalizador para habilitar a descoberta de ponto de extremidade para contas de banco de dados replicadas geograficamente.

int getIdleConnectionTimeoutInMillis()

Obtém o valor do tempo limite para uma conexão ociosa, o padrão é 60 segundos.

int getMaxPoolSize()

Obtém o valor do tamanho do pool de conexões que o cliente está usando.

MediaReadMode getMediaReadMode()

Obtém o modo de download do conteúdo do anexo (também conhecido como mídia).

int getMediaRequestTimeoutInMillis()

Obtém ou define o tempo de espera pela resposta do par de rede para operações de conteúdo de anexo (também conhecido como mídia).

List<String> getPreferredLocations()

Obtém os locais preferenciais para contas de banco de dados replicadas geograficamente

InetSocketAddress getProxy()

Obtém o InetSocketAddress do servidor proxy.

int getRequestTimeoutInMillis()

Obtém o tempo limite da solicitação (tempo para aguardar a resposta do par de rede) em milissegundos.

RetryOptions getRetryOptions()

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

String getUserAgentSuffix()

Obtém o valor do sufixo user-agent.

Boolean isEnableReadRequestsFallback()

Obtém se deseja permitir que as leituras acessem várias regiões configuradas em uma conta do serviço do Azure Cosmos DB.

O valor padrão é null.

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 é false para Desatualização Limitada. 1. enableEndpointDiscovery é true 2. a conta do Azure Cosmos DB tem mais de uma região

boolean isUsingMultipleWriteLocations()

Obtém o sinalizador para habilitar gravações em quaisquer locais (regiões) 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 locais graváveis disponíveis da conta de banco de dados replicada geograficamente. Locais graváveis são ordenados pela propriedade PreferredLocations. Definir o valor da propriedade como true não terá efeito até Que EnableMultipleWriteLocations em DatabaseAccount também seja definido como true.

O valor padrão é false, indicando que as gravações são direcionadas para a primeira região na propriedade PreferredLocations se for uma região de gravação ou a região da conta primária se nenhuma PreferredLocations for especificada.

O valor deve corresponder à configuração da conta.

Durante o tempo de vida do cliente, as gravações podem alterar o ponto de extremidade regional no caso de qualquer evento descrito em https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability

void setConnectionMode(ConnectionMode connectionMode)

Define o modo de conexão usado no cliente.

void setEnableEndpointDiscovery(boolean enableEndpointDiscovery)

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 atuais de gravação e leitura para garantir que as solicitações sejam enviadas para a região correta com base na funcionalidade da região e na preferência do usuário.

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

void setEnableReadRequestsFallback(Boolean enableReadRequestsFallback)

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 padrão é null.

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 é false para Desatualização Limitada. 1. enableEndpointDiscovery é true 2. a conta do Azure Cosmos DB tem mais de uma região

void setIdleConnectionTimeoutInMillis(int idleConnectionTimeoutInMillis)

define o valor do tempo limite para uma conexão ociosa. Após esse tempo, a conexão será fechada automaticamente.

void setMaxPoolSize(int maxPoolSize)

Define o valor do tamanho do pool de conexões, o padrão é 1000.

void setMediaReadMode(MediaReadMode mediaReadMode)

Define o modo de download do conteúdo do anexo (também conhecido como mídia).

void setMediaRequestTimeoutInMillis(int mediaRequestTimeoutInMillis)

Obtém ou define Tempo para aguardar a resposta do par de rede para operações de conteúdo de anexo (também conhecido como mídia).

void setPreferredLocations(List<String> preferredLocations)

Define os locais preferenciais para contas de banco de dados replicadas geograficamente. Por exemplo, "Leste dos EUA" como o local preferencial.

Quando EnableEndpointDiscovery for true e PreferredRegions não estiver vazio, o SDK preferirá usar os locais na coleção na ordem em que forem especificados para executar operações.

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

void setProxy(String proxyHost, int proxyPort)

Isso criará o InetSocketAddress para o servidor proxy, todas as solicitações para o cosmoDB serão roteada a partir desse endereço.

void setRequestTimeoutInMillis(int requestTimeoutInMillis)

Define o tempo limite da solicitação (tempo para aguardar a resposta do par de rede) em milissegundos. O padrão é 60 segundos.

void setRetryOptions(RetryOptions retryOptions)

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.

void setUserAgentSuffix(String userAgentSuffix)

define o valor do sufixo user-agent.

void setUsingMultipleWriteLocations(boolean usingMultipleWriteLocations)

Define o sinalizador para habilitar gravações em quaisquer locais (regiões) 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 locais graváveis disponíveis da conta de banco de dados replicada geograficamente. Locais graváveis são ordenados pela propriedade PreferredLocations. Definir o valor da propriedade como true não terá efeito até Que EnableMultipleWriteLocations em DatabaseAccount também seja definido como true.

O valor padrão é false, indicando que as gravações são direcionadas para a primeira região na propriedade PreferredLocations se for uma região de gravação ou a região da conta primária se nenhuma PreferredLocations for especificada.

O valor deve corresponder à configuração da conta.

Durante o tempo de vida do cliente, as gravações podem alterar o ponto de extremidade regional no caso de qualquer evento descrito em https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability

String toString()

Detalhes do construtor

ConnectionPolicy

public ConnectionPolicy()

Construtor.

Detalhes do método

getConnectionMode

public ConnectionMode getConnectionMode()

Obtém o modo de conexão usado no cliente.

Retornos:

o modo de conexão.

GetDefault

public static ConnectionPolicy GetDefault()

Obtém a política de conexão padrão.

Retornos:

a política de conexão padrão.

getEnableEndpointDiscovery

public boolean getEnableEndpointDiscovery()

Obtém o sinalizador para habilitar a descoberta de ponto de extremidade para contas de banco de dados replicadas geograficamente.

Retornos:

se a descoberta de ponto de extremidade está habilitada.

getIdleConnectionTimeoutInMillis

public int getIdleConnectionTimeoutInMillis()

Obtém o valor do tempo limite para uma conexão ociosa, o padrão é 60 segundos.

Retornos:

Tempo limite de conexão ociosa.

getMaxPoolSize

public int getMaxPoolSize()

Obtém o valor do tamanho do pool de conexões que o cliente está usando.

Retornos:

tamanho do pool de conexões.

getMediaReadMode

public MediaReadMode getMediaReadMode()

Obtém o modo de download do conteúdo do anexo (também conhecido como mídia).

Retornos:

o modo de leitura de mídia.

getMediaRequestTimeoutInMillis

public int getMediaRequestTimeoutInMillis()

Obtém ou define o tempo de espera pela resposta do par de rede para operações de conteúdo de anexo (também conhecido como mídia).

Retornos:

o tempo limite da solicitação de mídia em milissegundos.

getPreferredLocations

public List getPreferredLocations()

Obtém os locais preferenciais para contas de banco de dados replicadas geograficamente

Retornos:

a lista de locais preferenciais.

getProxy

public InetSocketAddress getProxy()

Obtém o InetSocketAddress do servidor proxy.

Retornos:

o valor de proxyHost.

getRequestTimeoutInMillis

public int getRequestTimeoutInMillis()

Obtém o tempo limite da solicitação (tempo para aguardar a resposta do par de rede) em milissegundos.

Retornos:

o tempo limite da solicitação em milissegundos.

getRetryOptions

public RetryOptions getRetryOptions()

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

Retornos:

a instância retryOptions.

getUserAgentSuffix

public String getUserAgentSuffix()

Obtém o valor do sufixo user-agent.

Retornos:

o valor do sufixo user-agent.

isEnableReadRequestsFallback

public Boolean isEnableReadRequestsFallback()

Obtém se deseja permitir que as leituras acessem várias regiões configuradas em uma conta do serviço do Azure Cosmos DB.

O valor padrão é null.

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 é false para Desatualização Limitada. 1. enableEndpointDiscovery é true 2. a conta do Azure Cosmos DB tem mais de uma região

Retornos:

sinalizador para permitir que as leituras acessem várias regiões configuradas em uma conta do serviço do Azure Cosmos DB.

isUsingMultipleWriteLocations

public boolean isUsingMultipleWriteLocations()

Obtém o sinalizador para habilitar gravações em quaisquer locais (regiões) 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 locais graváveis disponíveis da conta de banco de dados replicada geograficamente. Locais graváveis são ordenados pela propriedade PreferredLocations. Definir o valor da propriedade como true não terá efeito até Que EnableMultipleWriteLocations em DatabaseAccount também seja definido como true.

O valor padrão é false, indicando que as gravações são direcionadas para a primeira região na propriedade PreferredLocations se for uma região de gravação ou a região da conta primária se nenhuma PreferredLocations for especificada.

O valor deve corresponder à configuração da conta.

Durante o tempo de vida do cliente, as gravações podem alterar o ponto de extremidade regional no caso de qualquer evento descrito em https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability

Retornos:

sinalizador para habilitar gravações em quaisquer locais (regiões) para contas de banco de dados replicadas geograficamente.

setConnectionMode

public void setConnectionMode(ConnectionMode connectionMode)

Define o modo de conexão usado no cliente.

Parâmetros:

connectionMode - o modo de conexão.

setEnableEndpointDiscovery

public void setEnableEndpointDiscovery(boolean enableEndpointDiscovery)

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 atuais de gravação e leitura para garantir que as solicitações sejam enviadas para a região correta com base na funcionalidade da região e na preferência do usuário.

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

Parâmetros:

enableEndpointDiscovery - true se EndpointDiscovery estiver habilitado.

setEnableReadRequestsFallback

public void setEnableReadRequestsFallback(Boolean enableReadRequestsFallback)

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 padrão é null.

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 é false para Desatualização Limitada. 1. enableEndpointDiscovery é true 2. a conta do Azure Cosmos DB tem mais de uma região

Parâmetros:

enableReadRequestsFallback - sinalizador para habilitar leituras para ir para várias regiões configuradas em uma conta do serviço do Azure Cosmos DB.

setIdleConnectionTimeoutInMillis

public void setIdleConnectionTimeoutInMillis(int idleConnectionTimeoutInMillis)

define o valor do tempo limite para uma conexão ociosa. Após esse tempo, a conexão será fechada automaticamente.

Parâmetros:

idleConnectionTimeoutInMillis - o tempo limite para uma conexão ociosa em segundos.

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize)

Define o valor do tamanho do pool de conexões, o padrão é 1000.

Parâmetros:

maxPoolSize - O valor do tamanho do pool de conexões.

setMediaReadMode

public void setMediaReadMode(MediaReadMode mediaReadMode)

Define o modo de download do conteúdo do anexo (também conhecido como mídia).

Parâmetros:

mediaReadMode - o modo de leitura de mídia.

setMediaRequestTimeoutInMillis

public void setMediaRequestTimeoutInMillis(int mediaRequestTimeoutInMillis)

Obtém ou define Tempo para aguardar a resposta do par de rede para operações de conteúdo de anexo (também conhecido como mídia).

Parâmetros:

mediaRequestTimeoutInMillis - o tempo limite da solicitação de mídia em milissegundos.

setPreferredLocations

public void setPreferredLocations(List preferredLocations)

Define os locais preferenciais para contas de banco de dados replicadas geograficamente. Por exemplo, "Leste dos EUA" como o local preferencial.

Quando EnableEndpointDiscovery for true e PreferredRegions não estiver vazio, o SDK preferirá usar os locais na coleção na ordem em que forem especificados para executar operações.

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

Parâmetros:

preferredLocations - a lista de locais preferenciais.

setProxy

public void setProxy(String proxyHost, int proxyPort)

Isso criará o InetSocketAddress para o servidor proxy, todas as solicitações para o cosmoDB serão roteada a partir desse endereço.

Parâmetros:

proxyHost - O host do servidor proxy.
proxyPort - A porta do servidor proxy.

setRequestTimeoutInMillis

public void setRequestTimeoutInMillis(int requestTimeoutInMillis)

Define o tempo limite da solicitação (tempo para aguardar a resposta do par de rede) em milissegundos. O padrão é 60 segundos.

Parâmetros:

requestTimeoutInMillis - o tempo limite da solicitação em milissegundos.

setRetryOptions

public void setRetryOptions(RetryOptions retryOptions)

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.

Parâmetros:

retryOptions - a instância retryOptions.

setUserAgentSuffix

public void setUserAgentSuffix(String userAgentSuffix)

define o valor do sufixo user-agent.

Parâmetros:

userAgentSuffix - O valor a ser acrescentado ao cabeçalho user-agent, que é usado para fins de monitoramento.

setUsingMultipleWriteLocations

public void setUsingMultipleWriteLocations(boolean usingMultipleWriteLocations)

Define o sinalizador para habilitar gravações em quaisquer locais (regiões) 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 locais graváveis disponíveis da conta de banco de dados replicada geograficamente. Locais graváveis são ordenados pela propriedade PreferredLocations. Definir o valor da propriedade como true não terá efeito até Que EnableMultipleWriteLocations em DatabaseAccount também seja definido como true.

O valor padrão é false, indicando que as gravações são direcionadas para a primeira região na propriedade PreferredLocations se for uma região de gravação ou a região da conta primária se nenhuma PreferredLocations for especificada.

O valor deve corresponder à configuração da conta.

Durante o tempo de vida do cliente, as gravações podem alterar o ponto de extremidade regional no caso de qualquer evento descrito em https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability

Parâmetros:

usingMultipleWriteLocations - sinalizador para habilitar gravações em quaisquer locais (regiões) para contas de banco de dados replicadas geograficamente.

toString

public String toString()

Aplica-se a