CosmosDbPartitionedStorageOptions 类

包:

com.microsoft.bot.azure

Maven 项目:

com.microsoft.bot:bot-azure:4.14.3

• java.lang.Object
• • com.microsoft.bot.azure.CosmosDbPartitionedStorageOptions

public class CosmosDbPartitionedStorageOptions

Cosmos DB 分区存储选项。

构造函数摘要

构造函数	说明
CosmosDbPartitionedStorageOptions()	构造一个空的 options 对象。
CosmosDbPartitionedStorageOptions(Configuration configuration)	使用 Configuration 中的属性构造。

方法摘要

修饰符和类型	方法和描述
java.lang.String	getAuthKey() 获取 Cosmos DB 的身份验证密钥。
java.lang.Boolean	getCompatibilityMode() 获取一个值，该值指示是否在兼容模式下运行。
ConnectionPolicy	getConnectionPolicy() 获取 CosmosDB 的连接策略。
ConsistencyLevel	getConsistencyLevel() 表示 Azure Cosmos DB 数据库服务中 Azure Cosmos DB 客户端操作支持的一致性级别。
java.lang.String	getContainerId() 获取容器标识符。
java.lang.Integer	getContainerThroughput() 获取创建容器时设置的吞吐量。
java.lang.String	getCosmosDbEndpoint() 获取 CosmosDB 终结点。
java.lang.String	getDatabaseId() 获取 Cosmos DB 实例的数据库标识符。
java.lang.String	getKeySuffix() 获取要添加到每个键的后缀。
void	setAuthKey(String withAuthKey) 设置 Cosmos DB 的身份验证密钥。
void	setCompatibilityMode(Boolean withCompatibilityMode) 设置一个值，该值指示是否在兼容模式下运行。
void	setConnectionPolicy(ConnectionPolicy withConnectionPolicy) 设置 CosmosDB 的连接策略。
void	setConsistencyLevel(ConsistencyLevel withConsistencyLevel) 表示 Azure Cosmos DB 数据库服务中 Azure Cosmos DB 客户端操作支持的一致性级别。
void	setContainerId(String withContainerId) 设置容器标识符。
void	setContainerThroughput(Integer withContainerThroughput) 设置创建容器时设置的吞吐量。
void	setCosmosDbEndpoint(String withCosmosDbEndpoint) 设置 CosmosDB 终结点。
void	setDatabaseId(String withDatabaseId) 设置 Cosmos DB 实例的数据库标识符。
void	setKeySuffix(String withKeySuffix) 设置要添加到每个键的后缀。

方法继承自 java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

构造函数详细信息

CosmosDbPartitionedStorageOptions

public CosmosDbPartitionedStorageOptions()

构造一个空的 options 对象。

CosmosDbPartitionedStorageOptions

public CosmosDbPartitionedStorageOptions(Configuration configuration)

使用 Configuration 中的属性构造。

Parameters:

configuration - 要从中读取属性的 Configuration 对象。

方法详细信息

getAuthKey

public String getAuthKey()

获取 Cosmos DB 的身份验证密钥。

Returns:

数据库的身份验证密钥。

getCompatibilityMode

public Boolean getCompatibilityMode()

获取一个值，该值指示是否在兼容模式下运行。 早期版本的 CosmosDb 的密钥长度限制为 255。 超过此长度的密钥在 CosmosDbKeyEscape 中被截断。 这仍然是默认行为，但可以通过将 CompatibilityMode 设置为 false 来重写。 此设置还允许使用未指定 PartitionKey 的旧集合。 注意：如果使用 KeySuffix，CompatibilityMode 不能为“true”。

Returns:

compatibilityMode

getConnectionPolicy

public ConnectionPolicy getConnectionPolicy()

获取 CosmosDB 的 ConnectionPolicy。

Returns:

ConnectionPolicy 设置。

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

表示 Azure Cosmos DB 数据库服务中 Azure Cosmos DB 客户端操作支持的一致性级别。 请求的 ConsistencyLevel 必须与为数据库帐户预配的 ConsistencyLevel 匹配或弱。 按强度顺序排列的一致性级别为 Strong、BoundedStaleness、Session 和 Eventual。

Returns:

The ConsistencyLevel

getContainerId

public String getContainerId()

获取容器标识符。

Returns:

容器/集合 ID。

getContainerThroughput

public Integer getContainerThroughput()

获取创建容器时设置的吞吐量。 默认为 400。

Returns:

容器吞吐量。

getCosmosDbEndpoint

public String getCosmosDbEndpoint()

获取 CosmosDB 终结点。

Returns:

数据库终结点。

getDatabaseId

public String getDatabaseId()

获取 Cosmos DB 实例的数据库标识符。

Returns:

CosmosDB DB ID。

getKeySuffix

public String getKeySuffix()

获取要添加到每个键的后缀。 请参阅 CosmosDbKeyEscape.EscapeKey (字符串) 。 注意：CompatibilityMode 必须设置为“false”才能使用 KeySuffix。 使用 KeySuffix 时，不会截断密钥，但如果密钥长度超过 CosmosDb 允许的长度，则会引发异常。

Returns:

仅包含有效 CosmosDb 键字符的字符串。 (例如：“\”、“？”、“/”、“#”、“*”) 。

setAuthKey

public void setAuthKey(String withAuthKey)

设置 Cosmos DB 的身份验证密钥。

Parameters:

withAuthKey - 要使用的身份验证密钥。

setCompatibilityMode

public void setCompatibilityMode(Boolean withCompatibilityMode)

设置一个值，该值指示是否在兼容模式下运行。 早期版本的 CosmosDb 的密钥长度限制为 255。 超过此长度的密钥在 CosmosDbKeyEscape 中被截断。 这仍然是默认行为，但可以通过将 CompatibilityMode 设置为 false 来重写。 此设置还允许使用未指定 PartitionKey 的旧集合。 注意：如果使用 KeySuffix，CompatibilityMode 不能为“true”。

Parameters:

withCompatibilityMode - 目前，cosmosdb 的最大密钥长度为 1023： https://docs.microsoft.com/en-us/azure/cosmos-db/concepts-limits#per-item-limits 向后兼容性的默认值为 255，即 CosmosDbKeyEscape.MaxKeyLength。

setConnectionPolicy

public void setConnectionPolicy(ConnectionPolicy withConnectionPolicy)

设置 CosmosDB 的 ConnectionPolicy。

Parameters:

withConnectionPolicy - ConnectionPolicy 设置。

setConsistencyLevel

public void setConsistencyLevel(ConsistencyLevel withConsistencyLevel)

表示 Azure Cosmos DB 数据库服务中 Azure Cosmos DB 客户端操作支持的一致性级别。 请求的 ConsistencyLevel 必须与为数据库帐户预配的 ConsistencyLevel 匹配或弱。 按强度顺序排列的一致性级别为 Strong、BoundedStaleness、Session 和 Eventual。

Parameters:

withConsistencyLevel - 要使用的 ConsistencyLevel。

setContainerId

public void setContainerId(String withContainerId)

设置容器标识符。

Parameters:

withContainerId - 容器/集合 ID。

setContainerThroughput

public void setContainerThroughput(Integer withContainerThroughput)

设置创建容器时设置的吞吐量。 默认为 400。

Parameters:

withContainerThroughput - 所需的虽然输出。

setCosmosDbEndpoint

public void setCosmosDbEndpoint(String withCosmosDbEndpoint)

设置 CosmosDB 终结点。

Parameters:

withCosmosDbEndpoint - 要使用的数据库终结点。

setDatabaseId

public void setDatabaseId(String withDatabaseId)

设置 Cosmos DB 实例的数据库标识符。

Parameters:

withDatabaseId - CosmosDB ID。

setKeySuffix

public void setKeySuffix(String withKeySuffix)

设置要添加到每个键的后缀。 请参阅 CosmosDbKeyEscape.EscapeKey (字符串) 。 注意：CompatibilityMode 必须设置为“false”才能使用 KeySuffix。 使用 KeySuffix 时，不会截断密钥，但如果密钥长度超过 CosmosDb 允许的长度，则会引发异常。

Parameters:

withKeySuffix - 仅包含有效 CosmosDb 键字符的字符串。 (例如：“\”、“？”、“/”、“#”、“*”) 。