ConnectionPolicy Clase

Paquete:

com.microsoft.azure.cosmosdb

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

public class ConnectionPolicy

Representa la directiva de conexión asociada a un DocumentClient en el servicio de base de datos de Azure Cosmos DB.

Resumen del constructor

Constructor	Description
ConnectionPolicy()	Constructor.

Resumen del método

Modificador y tipo	Método y descripción
ConnectionMode	getConnectionMode() Obtiene el modo de conexión utilizado en el cliente.
ConnectionPolicy	GetDefault() Obtiene la directiva de conexión predeterminada.
boolean	getEnableEndpointDiscovery() Obtiene la marca para habilitar la detección de puntos de conexión para las cuentas de base de datos con replicación geográfica.
int	getIdleConnectionTimeoutInMillis() Obtiene el valor del tiempo de espera de una conexión inactiva; el valor predeterminado es 60 segundos.
int	getMaxPoolSize() Obtiene el valor del tamaño del grupo de conexiones que usa el cliente.
MediaReadMode	getMediaReadMode() Obtiene el modo de descarga de contenido adjunto (también conocido como medio).
int	getMediaRequestTimeoutInMillis() Obtiene o establece el tiempo de espera de la respuesta del mismo nivel de red para las operaciones de contenido adjunto (también conocido como medios).
List<String>	getPreferredLocations() Obtiene las ubicaciones preferidas para las cuentas de base de datos con replicación geográfica.
InetSocketAddress	getProxy() Obtiene inetSocketAddress del servidor proxy.
int	getRequestTimeoutInMillis() Obtiene el tiempo de espera de la solicitud (tiempo de espera para esperar la respuesta del mismo nivel de red) en milisegundos.
RetryOptions	getRetryOptions() Obtiene las opciones de directiva de reintento asociadas a la instancia de DocumentClient.
String	getUserAgentSuffix() Obtiene el valor del sufijo user-agent.
Boolean	isEnableReadRequestsFallback() Obtiene si se permite que las lecturas vayan a varias regiones configuradas en una cuenta del servicio Azure Cosmos DB. El valor predeterminado es null. Si no se establece esta propiedad, el valor predeterminado es true para todos los niveles de coherencia distintos de obsolescencia limitada, el valor predeterminado es false para Obsolescencia limitada. 1. enableEndpointDiscovery es true 2. la cuenta de Azure Cosmos DB tiene más de una región
boolean	isUsingMultipleWriteLocations() Obtiene la marca para habilitar las escrituras en cualquier ubicación (regiones) para las cuentas de base de datos con replicación geográfica en el servicio Azure Cosmos DB. Cuando el valor de esta propiedad es true, el SDK dirigirá las operaciones de escritura a las ubicaciones grabables disponibles de la cuenta de base de datos con replicación geográfica. Las ubicaciones grabables se ordenan por la propiedad PreferredLocations. Establecer el valor de la propiedad en true no tiene ningún efecto hasta que EnableMultipleWriteLocations en DatabaseAccount también se establece en true. El valor predeterminado es false que indica que las escrituras se dirigen a la primera región de la propiedad PreferredLocations si se trata de una región de escritura o la región de la cuenta primaria si no se especifican preferredLocations. El valor debe coincidir con la configuración de la cuenta. Durante la vigencia del cliente, las escrituras pueden cambiar el punto de conexión regional en el caso de cualquier evento descrito en . https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability
void	setConnectionMode(ConnectionMode connectionMode) Establece el modo de conexión utilizado en el cliente.
void	setEnableEndpointDiscovery(boolean enableEndpointDiscovery) Establece la marca para habilitar la detección de puntos de conexión para las cuentas de base de datos con replicación geográfica. Cuando EnableEndpointDiscovery es true, el SDK detectará automáticamente las regiones de escritura y lectura actuales para asegurarse de que las solicitudes se envían a la región correcta en función de la funcionalidad de la región y de la preferencia del usuario. El valor predeterminado de esta propiedad es true, lo que indica que la detección de puntos de conexión está habilitada.
void	setEnableReadRequestsFallback(Boolean enableReadRequestsFallback) Establece si se permite que las lecturas vayan a varias regiones configuradas en una cuenta del servicio Azure Cosmos DB. El valor predeterminado es null. Si no se establece esta propiedad, el valor predeterminado es true para todos los niveles de coherencia distintos de obsolescencia limitada, el valor predeterminado es false para Obsolescencia limitada. 1. enableEndpointDiscovery es true 2. la cuenta de Azure Cosmos DB tiene más de una región
void	setIdleConnectionTimeoutInMillis(int idleConnectionTimeoutInMillis) establece el valor del tiempo de espera de una conexión inactiva. Después de ese tiempo, la conexión se cerrará automáticamente.
void	setMaxPoolSize(int maxPoolSize) Establece el valor del tamaño del grupo de conexiones; el valor predeterminado es 1000.
void	setMediaReadMode(MediaReadMode mediaReadMode) Establece el modo de descarga de contenido adjunto (también conocido como medio).
void	setMediaRequestTimeoutInMillis(int mediaRequestTimeoutInMillis) Obtiene o establece el tiempo de espera de la respuesta del mismo nivel de red para las operaciones de contenido adjunto (también conocido como medios).
void	setPreferredLocations(List<String> preferredLocations) Establece las ubicaciones preferidas para las cuentas de base de datos con replicación geográfica. Por ejemplo, "Este de EE. UU." como ubicación preferida. Cuando EnableEndpointDiscovery es true y PreferredRegions no está vacío, el SDK prefiere usar las ubicaciones de la colección en el orden en que se especifican para realizar operaciones. Si EnableEndpointDiscovery se establece en false, esta propiedad se omite.
void	setProxy(String proxyHost, int proxyPort) Esto creará inetSocketAddress para el servidor proxy, todas las solicitudes a cosmoDB se enrutarán desde esta dirección.
void	setRequestTimeoutInMillis(int requestTimeoutInMillis) Establece el tiempo de espera de la solicitud (tiempo para esperar la respuesta del mismo nivel de red) en milisegundos. El valor predeterminado es 60 segundos.
void	setRetryOptions(RetryOptions retryOptions) Establece las opciones de directiva de reintento asociadas a la instancia de DocumentClient. Las propiedades de la clase RetryOptions permiten a la aplicación personalizar las directivas de reintento integradas. Esta propiedad es opcional. Cuando no se establece, el SDK usa los valores predeterminados para configurar las directivas de reintento. Consulte Clase RetryOptions para obtener más detalles.
void	setUserAgentSuffix(String userAgentSuffix) establece el valor del sufijo user-agent.
void	setUsingMultipleWriteLocations(boolean usingMultipleWriteLocations) Establece la marca para habilitar las escrituras en cualquier ubicación (regiones) para las cuentas de base de datos con replicación geográfica en el servicio Azure Cosmos DB. Cuando el valor de esta propiedad es true, el SDK dirigirá las operaciones de escritura a las ubicaciones grabables disponibles de la cuenta de base de datos con replicación geográfica. Las ubicaciones grabables se ordenan por la propiedad PreferredLocations. Establecer el valor de la propiedad en true no tiene ningún efecto hasta que EnableMultipleWriteLocations en DatabaseAccount también se establece en true. El valor predeterminado es false que indica que las escrituras se dirigen a la primera región de la propiedad PreferredLocations si se trata de una región de escritura o la región de la cuenta primaria si no se especifican preferredLocations. El valor debe coincidir con la configuración de la cuenta. Durante la vigencia del cliente, las escrituras pueden cambiar el punto de conexión regional en el caso de cualquier evento descrito en . https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability
String	toString()

Detalles del constructor

ConnectionPolicy

public ConnectionPolicy()

Constructor.

Detalles del método

getConnectionMode

public ConnectionMode getConnectionMode()

Obtiene el modo de conexión utilizado en el cliente.

Returns:

el modo de conexión.

GetDefault

public static ConnectionPolicy GetDefault()

Obtiene la directiva de conexión predeterminada.

Returns:

la directiva de conexión predeterminada.

getEnableEndpointDiscovery

public boolean getEnableEndpointDiscovery()

Obtiene la marca para habilitar la detección de puntos de conexión para las cuentas de base de datos con replicación geográfica.

Returns:

si la detección de puntos de conexión está habilitada.

getIdleConnectionTimeoutInMillis

public int getIdleConnectionTimeoutInMillis()

Obtiene el valor del tiempo de espera de una conexión inactiva; el valor predeterminado es 60 segundos.

Returns:

Tiempo de espera de conexión inactivo.

getMaxPoolSize

public int getMaxPoolSize()

Obtiene el valor del tamaño del grupo de conexiones que usa el cliente.

Returns:

tamaño del grupo de conexiones.

getMediaReadMode

public MediaReadMode getMediaReadMode()

Obtiene el modo de descarga de contenido adjunto (también conocido como medio).

Returns:

el modo de lectura multimedia.

getMediaRequestTimeoutInMillis

public int getMediaRequestTimeoutInMillis()

Obtiene o establece el tiempo de espera de la respuesta del mismo nivel de red para las operaciones de contenido adjunto (también conocido como medios).

Returns:

tiempo de espera de la solicitud multimedia en milisegundos.

getPreferredLocations

public List getPreferredLocations()

Obtiene las ubicaciones preferidas para las cuentas de base de datos con replicación geográfica.

Returns:

la lista de ubicaciones preferidas.

getProxy

public InetSocketAddress getProxy()

Obtiene inetSocketAddress del servidor proxy.

Returns:

el valor de proxyHost.

getRequestTimeoutInMillis

public int getRequestTimeoutInMillis()

Obtiene el tiempo de espera de la solicitud (tiempo de espera para esperar la respuesta del mismo nivel de red) en milisegundos.

Returns:

tiempo de espera de la solicitud en milisegundos.

getRetryOptions

public RetryOptions getRetryOptions()

Obtiene las opciones de directiva de reintento asociadas a la instancia de DocumentClient.

Returns:

instancia de RetryOptions.

getUserAgentSuffix

public String getUserAgentSuffix()

Obtiene el valor del sufijo user-agent.

Returns:

el valor del sufijo user-agent.

isEnableReadRequestsFallback

public Boolean isEnableReadRequestsFallback()

Obtiene si se permite que las lecturas vayan a varias regiones configuradas en una cuenta del servicio Azure Cosmos DB.

El valor predeterminado es null.

Si no se establece esta propiedad, el valor predeterminado es true para todos los niveles de coherencia distintos de obsolescencia limitada, el valor predeterminado es false para Obsolescencia limitada. 1. enableEndpointDiscovery es true 2. la cuenta de Azure Cosmos DB tiene más de una región

Returns:

marca para permitir que las lecturas vayan a varias regiones configuradas en una cuenta del servicio Azure Cosmos DB.

isUsingMultipleWriteLocations

public boolean isUsingMultipleWriteLocations()

Obtiene la marca para habilitar las escrituras en cualquier ubicación (regiones) para las cuentas de base de datos con replicación geográfica en el servicio Azure Cosmos DB.

Cuando el valor de esta propiedad es true, el SDK dirigirá las operaciones de escritura a las ubicaciones grabables disponibles de la cuenta de base de datos con replicación geográfica. Las ubicaciones grabables se ordenan por la propiedad PreferredLocations. Establecer el valor de la propiedad en true no tiene ningún efecto hasta que EnableMultipleWriteLocations en DatabaseAccount también se establece en true.

El valor predeterminado es false que indica que las escrituras se dirigen a la primera región de la propiedad PreferredLocations si se trata de una región de escritura o la región de la cuenta primaria si no se especifican preferredLocations.

El valor debe coincidir con la configuración de la cuenta.

Durante la vigencia del cliente, las escrituras pueden cambiar el punto de conexión regional en el caso de cualquier evento descrito en . https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability

Returns:

marca para habilitar las escrituras en cualquier ubicación (regiones) para las cuentas de base de datos con replicación geográfica.

setConnectionMode

public void setConnectionMode(ConnectionMode connectionMode)

Establece el modo de conexión utilizado en el cliente.

Parameters:

connectionMode - el modo de conexión.

setEnableEndpointDiscovery

public void setEnableEndpointDiscovery(boolean enableEndpointDiscovery)

Establece la marca para habilitar la detección de puntos de conexión para las cuentas de base de datos con replicación geográfica.

Cuando EnableEndpointDiscovery es true, el SDK detectará automáticamente las regiones de escritura y lectura actuales para asegurarse de que las solicitudes se envían a la región correcta en función de la funcionalidad de la región y de la preferencia del usuario.

El valor predeterminado de esta propiedad es true, lo que indica que la detección de puntos de conexión está habilitada.

Parameters:

enableEndpointDiscovery - True si EndpointDiscovery está habilitado.

setEnableReadRequestsFallback

public void setEnableReadRequestsFallback(Boolean enableReadRequestsFallback)

Establece si se permite que las lecturas vayan a varias regiones configuradas en una cuenta del servicio Azure Cosmos DB.

El valor predeterminado es null.

Si no se establece esta propiedad, el valor predeterminado es true para todos los niveles de coherencia distintos de obsolescencia limitada, el valor predeterminado es false para Obsolescencia limitada. 1. enableEndpointDiscovery es true 2. la cuenta de Azure Cosmos DB tiene más de una región

Parameters:

enableReadRequestsFallback - marca para habilitar las lecturas para ir a varias regiones configuradas en una cuenta del servicio Azure Cosmos DB.

setIdleConnectionTimeoutInMillis

public void setIdleConnectionTimeoutInMillis(int idleConnectionTimeoutInMillis)

establece el valor del tiempo de espera de una conexión inactiva. Después de ese tiempo, la conexión se cerrará automáticamente.

Parameters:

idleConnectionTimeoutInMillis - tiempo de espera de una conexión inactiva en segundos.

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize)

Establece el valor del tamaño del grupo de conexiones; el valor predeterminado es 1000.

Parameters:

maxPoolSize - Valor del tamaño del grupo de conexiones.

setMediaReadMode

public void setMediaReadMode(MediaReadMode mediaReadMode)

Establece el modo de descarga de contenido adjunto (también conocido como medio).

Parameters:

mediaReadMode - el modo de lectura multimedia.

setMediaRequestTimeoutInMillis

public void setMediaRequestTimeoutInMillis(int mediaRequestTimeoutInMillis)

Obtiene o establece el tiempo de espera de la respuesta del mismo nivel de red para las operaciones de contenido adjunto (también conocido como medios).

Parameters:

mediaRequestTimeoutInMillis - tiempo de espera de la solicitud multimedia en milisegundos.

setPreferredLocations

public void setPreferredLocations(List preferredLocations)

Establece las ubicaciones preferidas para las cuentas de base de datos con replicación geográfica. Por ejemplo, "Este de EE. UU." como ubicación preferida.

Cuando EnableEndpointDiscovery es true y PreferredRegions no está vacío, el SDK prefiere usar las ubicaciones de la colección en el orden en que se especifican para realizar operaciones.

Si EnableEndpointDiscovery se establece en false, esta propiedad se omite.

Parameters:

preferredLocations - la lista de ubicaciones preferidas.

setProxy

public void setProxy(String proxyHost, int proxyPort)

Esto creará inetSocketAddress para el servidor proxy, todas las solicitudes a cosmoDB se enrutarán desde esta dirección.

Parameters:

proxyHost - Host del servidor proxy.

proxyPort - Puerto del servidor proxy.

setRequestTimeoutInMillis

public void setRequestTimeoutInMillis(int requestTimeoutInMillis)

Establece el tiempo de espera de la solicitud (tiempo para esperar la respuesta del mismo nivel de red) en milisegundos. El valor predeterminado es 60 segundos.

Parameters:

requestTimeoutInMillis - tiempo de espera de la solicitud en milisegundos.

setRetryOptions

public void setRetryOptions(RetryOptions retryOptions)

Establece las opciones de directiva de reintento asociadas a la instancia de DocumentClient.

Las propiedades de la clase RetryOptions permiten a la aplicación personalizar las directivas de reintento integradas. Esta propiedad es opcional. Cuando no se establece, el SDK usa los valores predeterminados para configurar las directivas de reintento. Consulte Clase RetryOptions para obtener más detalles.

Parameters:

retryOptions - instancia de RetryOptions.

setUserAgentSuffix

public void setUserAgentSuffix(String userAgentSuffix)

establece el valor del sufijo user-agent.

Parameters:

userAgentSuffix - El valor que se va a anexar al encabezado user-agent, se usa con fines de supervisión.

setUsingMultipleWriteLocations

public void setUsingMultipleWriteLocations(boolean usingMultipleWriteLocations)

Establece la marca para habilitar las escrituras en cualquier ubicación (regiones) para las cuentas de base de datos con replicación geográfica en el servicio Azure Cosmos DB.

Cuando el valor de esta propiedad es true, el SDK dirigirá las operaciones de escritura a las ubicaciones grabables disponibles de la cuenta de base de datos con replicación geográfica. Las ubicaciones grabables se ordenan por la propiedad PreferredLocations. Establecer el valor de la propiedad en true no tiene ningún efecto hasta que EnableMultipleWriteLocations en DatabaseAccount también se establece en true.

El valor predeterminado es false que indica que las escrituras se dirigen a la primera región de la propiedad PreferredLocations si se trata de una región de escritura o la región de la cuenta primaria si no se especifican preferredLocations.

El valor debe coincidir con la configuración de la cuenta.

Durante la vigencia del cliente, las escrituras pueden cambiar el punto de conexión regional en el caso de cualquier evento descrito en . https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability

Parameters:

usingMultipleWriteLocations - marca para habilitar las escrituras en cualquier ubicación (regiones) para las cuentas de base de datos con replicación geográfica.

toString

public String toString()