通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ConnectionPolicy 类

  • 参考
包:
com.microsoft.azure.cosmosdb
  • java.lang.Object
    • com.microsoft.azure.cosmosdb.ConnectionPolicy

public class ConnectionPolicy

表示与 Azure Cosmos DB 数据库服务中的 DocumentClient 关联的连接策略。

构造函数摘要

构造函数 说明
ConnectionPolicy()

构造函数。

方法摘要

修饰符和类型 方法和描述
ConnectionMode getConnectionMode()

获取客户端中使用的连接模式。
ConnectionPolicy GetDefault()

获取默认连接策略。
boolean getEnableEndpointDiscovery()

获取为异地复制的数据库帐户启用终结点发现的标志。
int getIdleConnectionTimeoutInMillis()

获取空闲连接的超时值，默认值为 60 秒。
int getMaxPoolSize()

获取客户端正在使用的连接池大小的值。
MediaReadMode getMediaReadMode()

获取 (又名媒体) 下载模式的附件内容。
int getMediaRequestTimeoutInMillis()

获取或设置等待网络对等方响应的时间， (又名媒体) 操作。
List<String> getPreferredLocations()

获取异地复制数据库帐户的首选位置
InetSocketAddress getProxy()

获取代理服务器的 InetSocketAddress。
int getRequestTimeoutInMillis()

获取请求超时 (等待网络对等方) 响应的时间（以毫秒为单位）。
RetryOptions getRetryOptions()

获取与 DocumentClient 实例关联的重试策略选项。
String getUserAgentSuffix()

获取用户代理后缀的值。
Boolean isEnableReadRequestsFallback()

获取是否允许读取转到在 Azure Cosmos DB 服务帐户上配置的多个区域。

默认值为 null。

如果未设置此属性，则对于除有限过期之外的所有一致性级别，默认值为 true;对于有限过期，默认值为 false。 1. enableEndpointDiscovery 为 true 2。 Azure Cosmos DB 帐户有多个区域
boolean isUsingMultipleWriteLocations()

获取用于在 Azure Cosmos DB 服务中异地复制的数据库帐户) 的任何位置 (区域启用写入的标志。

当此属性的值为 true 时，SDK 会将写入操作定向到异地复制数据库帐户的可用可写位置。 可写位置按 PreferredLocations 属性排序。 在 DatabaseAccount 中的 EnableMultipleWriteLocations 也设置为 true 之前，将属性值设置为 true 不起作用。

默认值为 false，指示写入将定向到 PreferredLocations 属性中的第一个区域（如果它是写入区域）或主要帐户区域（如果未指定 PreferredLocations）。

该值应与帐户配置匹配。

在客户端生存期内，如果发生上述任何事件，写入操作可以更改区域终结点 https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability
void setConnectionMode(ConnectionMode connectionMode)

设置客户端中使用的连接模式。
void setEnableEndpointDiscovery(boolean enableEndpointDiscovery)

设置 标志，为异地复制的数据库帐户启用终结点发现。

如果 EnableEndpointDiscovery 为 true，SDK 将自动发现当前的写入和读取区域，以确保根据区域功能和用户首选项将请求发送到正确的区域。

此属性的默认值为 true，表示已启用终结点发现。
void setEnableReadRequestsFallback(Boolean enableReadRequestsFallback)

设置是否允许读取转到在 Azure Cosmos DB 服务帐户上配置的多个区域。

默认值为 null。

如果未设置此属性，则对于除有限过期之外的所有一致性级别，默认值为 true;对于有限过期，默认值为 false。 1. enableEndpointDiscovery 为 true 2。 Azure Cosmos DB 帐户有多个区域
void setIdleConnectionTimeoutInMillis(int idleConnectionTimeoutInMillis)

设置空闲连接的超时值。 之后，连接将自动关闭。
void setMaxPoolSize(int maxPoolSize)

设置连接池大小的值，默认值为 1000。
void setMediaReadMode(MediaReadMode mediaReadMode)

设置附件内容 (又名媒体) 下载模式。
void setMediaRequestTimeoutInMillis(int mediaRequestTimeoutInMillis)

获取或设置等待网络对等方响应的时间，该时间 (又名媒体) 操作。
void setPreferredLocations(List<String> preferredLocations)

设置异地复制数据库帐户的首选位置。 例如，将“美国东部”作为首选位置。

当 EnableEndpointDiscovery 为 true 且 PreferredRegions 为非空时，SDK 将倾向于按照指定位置执行操作的顺序使用集合中的位置。

如果 EnableEndpointDiscovery 设置为 false，则忽略此属性。
void setProxy(String proxyHost, int proxyPort)

这将为代理服务器创建 InetSocketAddress，对 cosmoDB 的所有请求都将从此地址路由。

void setRequestTimeoutInMillis(int requestTimeoutInMillis)

设置请求超时 (等待网络对等方) 响应的时间（以毫秒为单位）。 默认值为 60 秒。
void setRetryOptions(RetryOptions retryOptions)

设置与 DocumentClient 实例关联的重试策略选项。

RetryOptions 类中的属性允许应用程序自定义内置的重试策略。 此属性是可选的。 如果未设置，SDK 将使用默认值来配置重试策略。 有关更多详细信息，请参阅 RetryOptions 类。
void setUserAgentSuffix(String userAgentSuffix)

设置用户代理后缀的值。
void setUsingMultipleWriteLocations(boolean usingMultipleWriteLocations)

设置 标志以在 Azure Cosmos DB 服务中为异地复制的数据库帐户启用写入 (区域) 。

当此属性的值为 true 时，SDK 会将写入操作定向到异地复制数据库帐户的可用可写位置。 可写位置按 PreferredLocations 属性排序。 在 DatabaseAccount 中的 EnableMultipleWriteLocations 也设置为 true 之前，将属性值设置为 true 不起作用。

默认值为 false，指示写入将定向到 PreferredLocations 属性中的第一个区域（如果它是写入区域）或主要帐户区域（如果未指定 PreferredLocations）。

该值应与帐户配置匹配。

在客户端生存期内，如果发生上述任何事件，写入操作可以更改区域终结点 https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability
String toString()

构造函数详细信息

ConnectionPolicy

public ConnectionPolicy()

构造函数。

方法详细信息

getConnectionMode

public ConnectionMode getConnectionMode()

获取客户端中使用的连接模式。

返回:

连接模式。

GetDefault

public static ConnectionPolicy GetDefault()

获取默认连接策略。

返回:

默认连接策略。

getEnableEndpointDiscovery

public boolean getEnableEndpointDiscovery()

获取为异地复制的数据库帐户启用终结点发现的标志。

返回:

是否启用终结点发现。

getIdleConnectionTimeoutInMillis

public int getIdleConnectionTimeoutInMillis()

获取空闲连接的超时值，默认值为 60 秒。

返回:

空闲连接超时。

getMaxPoolSize

public int getMaxPoolSize()

获取客户端正在使用的连接池大小的值。

返回:

连接池大小。

getMediaReadMode

public MediaReadMode getMediaReadMode()

获取 (又名媒体) 下载模式的附件内容。

返回:

媒体读取模式。

getMediaRequestTimeoutInMillis

public int getMediaRequestTimeoutInMillis()

获取或设置等待网络对等方响应的时间， (又名媒体) 操作。

返回:

媒体请求超时（以毫秒为单位）。

getPreferredLocations

public List getPreferredLocations()

获取异地复制数据库帐户的首选位置

返回:

首选位置的列表。

getProxy

public InetSocketAddress getProxy()

获取代理服务器的 InetSocketAddress。

返回:

proxyHost 的值。

getRequestTimeoutInMillis

public int getRequestTimeoutInMillis()

获取请求超时 (等待网络对等方) 响应的时间（以毫秒为单位）。

返回:

请求超时（以毫秒为单位）。

getRetryOptions

public RetryOptions getRetryOptions()

获取与 DocumentClient 实例关联的重试策略选项。

返回:

RetryOptions 实例。

getUserAgentSuffix

public String getUserAgentSuffix()

获取用户代理后缀的值。

返回:

用户代理后缀的值。

isEnableReadRequestsFallback

public Boolean isEnableReadRequestsFallback()

获取是否允许读取转到在 Azure Cosmos DB 服务帐户上配置的多个区域。

默认值为 null。

如果未设置此属性，则对于除有限过期之外的所有一致性级别，默认值为 true;对于有限过期，默认值为 false。 1. enableEndpointDiscovery 为 true 2。 Azure Cosmos DB 帐户有多个区域

返回:

标志，允许读取转到在 Azure Cosmos DB 服务帐户上配置的多个区域。

isUsingMultipleWriteLocations

public boolean isUsingMultipleWriteLocations()

获取用于在 Azure Cosmos DB 服务中异地复制的数据库帐户) 的任何位置 (区域启用写入的标志。

当此属性的值为 true 时，SDK 会将写入操作定向到异地复制数据库帐户的可用可写位置。 可写位置按 PreferredLocations 属性排序。 在 DatabaseAccount 中的 EnableMultipleWriteLocations 也设置为 true 之前，将属性值设置为 true 不起作用。

默认值为 false，指示写入将定向到 PreferredLocations 属性中的第一个区域（如果它是写入区域）或主要帐户区域（如果未指定 PreferredLocations）。

该值应与帐户配置匹配。

在客户端生存期内，如果发生上述任何事件，写入操作可以更改区域终结点 https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability

返回:

标志，用于在异地复制数据库帐户) 的任何位置 (区域启用写入。

setConnectionMode

public void setConnectionMode(ConnectionMode connectionMode)

设置客户端中使用的连接模式。

参数:

connectionMode - 连接模式。

setEnableEndpointDiscovery

public void setEnableEndpointDiscovery(boolean enableEndpointDiscovery)

设置 标志，为异地复制的数据库帐户启用终结点发现。

如果 EnableEndpointDiscovery 为 true，SDK 将自动发现当前的写入和读取区域，以确保根据区域功能和用户首选项将请求发送到正确的区域。

此属性的默认值为 true，表示已启用终结点发现。

参数:

enableEndpointDiscovery - 如果启用了 EndpointDiscovery，则为 true。

setEnableReadRequestsFallback

public void setEnableReadRequestsFallback(Boolean enableReadRequestsFallback)

设置是否允许读取转到在 Azure Cosmos DB 服务帐户上配置的多个区域。

默认值为 null。

如果未设置此属性，则对于除有限过期之外的所有一致性级别，默认值为 true;对于有限过期，默认值为 false。 1. enableEndpointDiscovery 为 true 2。 Azure Cosmos DB 帐户有多个区域

参数:

enableReadRequestsFallback - 标志，允许读取转到在 Azure Cosmos DB 服务帐户上配置的多个区域。

setIdleConnectionTimeoutInMillis

public void setIdleConnectionTimeoutInMillis(int idleConnectionTimeoutInMillis)

设置空闲连接的超时值。 之后，连接将自动关闭。

参数:

idleConnectionTimeoutInMillis - 空闲连接的超时时间（以秒为单位）。

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize)

设置连接池大小的值，默认值为 1000。

参数:

maxPoolSize - 连接池大小的值。

setMediaReadMode

public void setMediaReadMode(MediaReadMode mediaReadMode)

设置附件内容 (又名媒体) 下载模式。

参数:

mediaReadMode - 媒体读取模式。

setMediaRequestTimeoutInMillis

public void setMediaRequestTimeoutInMillis(int mediaRequestTimeoutInMillis)

获取或设置等待网络对等方响应的时间，该时间 (又名媒体) 操作。

参数:

mediaRequestTimeoutInMillis - 媒体请求超时（以毫秒为单位）。

setPreferredLocations

public void setPreferredLocations(List preferredLocations)

设置异地复制数据库帐户的首选位置。 例如，将“美国东部”作为首选位置。

当 EnableEndpointDiscovery 为 true 且 PreferredRegions 为非空时，SDK 将倾向于按照指定位置执行操作的顺序使用集合中的位置。

如果 EnableEndpointDiscovery 设置为 false，则忽略此属性。

参数:

preferredLocations - 首选位置的列表。

setProxy

public void setProxy(String proxyHost, int proxyPort)

这将为代理服务器创建 InetSocketAddress，对 cosmoDB 的所有请求都将从此地址路由。

参数:

proxyHost - 代理服务器主机。
proxyPort - 代理服务器端口。

setRequestTimeoutInMillis

public void setRequestTimeoutInMillis(int requestTimeoutInMillis)

设置请求超时 (等待网络对等方) 响应的时间（以毫秒为单位）。 默认值为 60 秒。

参数:

requestTimeoutInMillis - 请求超时（以毫秒为单位）。

setRetryOptions

public void setRetryOptions(RetryOptions retryOptions)

设置与 DocumentClient 实例关联的重试策略选项。

RetryOptions 类中的属性允许应用程序自定义内置的重试策略。 此属性是可选的。 如果未设置，SDK 将使用默认值来配置重试策略。 有关更多详细信息，请参阅 RetryOptions 类。

参数:

retryOptions - RetryOptions 实例。

setUserAgentSuffix

public void setUserAgentSuffix(String userAgentSuffix)

设置用户代理后缀的值。

参数:

userAgentSuffix - 要追加到用户代理标头的值，用于监视目的。

setUsingMultipleWriteLocations

public void setUsingMultipleWriteLocations(boolean usingMultipleWriteLocations)

设置 标志以在 Azure Cosmos DB 服务中为异地复制的数据库帐户启用写入 (区域) 。

当此属性的值为 true 时，SDK 会将写入操作定向到异地复制数据库帐户的可用可写位置。 可写位置按 PreferredLocations 属性排序。 在 DatabaseAccount 中的 EnableMultipleWriteLocations 也设置为 true 之前，将属性值设置为 true 不起作用。

默认值为 false，指示写入将定向到 PreferredLocations 属性中的第一个区域（如果它是写入区域）或主要帐户区域（如果未指定 PreferredLocations）。

该值应与帐户配置匹配。

在客户端生存期内，如果发生上述任何事件，写入操作可以更改区域终结点 https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability

参数:

usingMultipleWriteLocations - 标志，用于在异地复制数据库帐户) 的任何位置 (区域启用写入。

toString

public String toString()

适用于