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

CosmosContainerProperties 类

包:

com.azure.cosmos.models

Maven 项目:

com.azure:azure-cosmos:4.59.0

• java.lang.Object
• • com.azure.cosmos.models.CosmosContainerProperties

public final class CosmosContainerProperties

表示 Azure Cosmos DB 数据库服务中的容器。 cosmos 容器是 cosmos 项的命名逻辑容器。

数据库可能包含零个或多个命名容器，每个容器由零个或多个 JSON 项组成。 由于没有架构，容器中的项不需要共享相同的结构或字段。 由于容器是应用程序资源，因此可以使用主密钥或资源密钥进行授权。

构造函数摘要

构造函数	说明
CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition)	构造函数
CosmosContainerProperties(String id, String partitionKeyPath)	构造函数

方法摘要

修饰符和类型	方法和描述
Integer	getAnalyticalStoreTimeToLiveInSeconds() 从 Azure Cosmos DB 服务获取容器中项的分析存储生存时间（以秒为单位）。
ChangeFeedPolicy	getChangeFeedPolicy() 获取 Azure Cosmos DB 服务中此容器的更改源策略。
ClientEncryptionPolicy	getClientEncryptionPolicy() 获取用于加密项字段的客户端加密策略
Collection<ComputedProperty>	getComputedProperties() 获取 Azure Cosmos DB 服务中此容器的计算属性。
ConflictResolutionPolicy	getConflictResolutionPolicy() 获取冲突解决策略，该策略用于解决 Azure Cosmos DB 服务容器中不同区域中的项的冲突写入。
Integer	getDefaultTimeToLiveInSeconds() 获取容器的默认生存时间值。
String	getETag() 获取与资源关联的实体标记。
String	getId() 获取资源的名称。
IndexingPolicy	getIndexingPolicy() 获取容器的索引策略。
PartitionKeyDefinition	getPartitionKeyDefinition() 获取容器的分区键定义。
String	getResourceId() 获取与资源关联的 ID。
Instant	getTimestamp() 获取与资源关联的上次修改时间戳。
UniqueKeyPolicy	getUniqueKeyPolicy() 获取容器唯一密钥策略
CosmosContainerProperties	setAnalyticalStoreTimeToLiveInSeconds(Integer timeToLive) 为 Azure Cosmos DB 服务中的容器中的项设置分析存储的生存时间（以秒为单位）。
CosmosContainerProperties	setChangeFeedPolicy(ChangeFeedPolicy value) 在 Azure Cosmos DB 服务中设置此容器的更改源策略。
CosmosContainerProperties	setClientEncryptionPolicy(ClientEncryptionPolicy value) 设置用于加密项字段的客户端加密策略
CosmosContainerProperties	setComputedProperties(Collection<ComputedProperty> computedProperties) 在 Azure Cosmos DB 服务中设置此容器的计算属性。
CosmosContainerProperties	setConflictResolutionPolicy(ConflictResolutionPolicy value) 设置冲突解决策略，用于解决 Azure Cosmos DB 服务容器中不同区域中项的冲突写入。
CosmosContainerProperties	setDefaultTimeToLiveInSeconds(Integer timeToLive) 设置容器的默认生存时间值。
CosmosContainerProperties	setId(String id) 设置资源的名称。
CosmosContainerProperties	setIndexingPolicy(IndexingPolicy indexingPolicy) 设置容器的索引策略
CosmosContainerProperties	setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition) 设置容器的分区键定义。
CosmosContainerProperties	setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy) 设置容器唯一密钥策略

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

构造函数详细信息

CosmosContainerProperties

public CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition)

构造函数

Parameters:

id - 容器的 ID

partitionKeyDefinition - PartitionKeyDefinition

CosmosContainerProperties

public CosmosContainerProperties(String id, String partitionKeyPath)

构造函数

Parameters:

id - 容器的 ID

partitionKeyPath - 分区键路径

方法详细信息

getAnalyticalStoreTimeToLiveInSeconds

public Integer getAnalyticalStoreTimeToLiveInSeconds()

从 Azure Cosmos DB 服务获取容器中项的分析存储生存时间（以秒为单位）。 它是一个可选属性。 有效值必须是非零正整数、“-1”或 0。 默认情况下，AnalysisStoreTimeToLive 设置为 0，这意味着为容器关闭分析存储;-1 表示分析存储中的项永不过期。 度量单位为秒。 允许的最大值为 2147483647。

Returns:

分析 ttl

getChangeFeedPolicy

public ChangeFeedPolicy getChangeFeedPolicy()

获取 Azure Cosmos DB 服务中此容器的 changeFeedPolicy。

Returns:

ChangeFeedPolicy

getClientEncryptionPolicy

public ClientEncryptionPolicy getClientEncryptionPolicy()

获取用于加密项字段的 ClientEncryptionPolicy

Returns:

ClientEncryptionPolicy

getComputedProperties

public Collection getComputedProperties()

获取 Azure Cosmos DB 服务中此容器的 computedProperties。

Returns:

computedProperties。

getConflictResolutionPolicy

public ConflictResolutionPolicy getConflictResolutionPolicy()

获取 conflictResolutionPolicy，用于解决 Azure Cosmos DB 服务容器中不同区域中项的冲突写入。

Returns:

ConflictResolutionPolicy

getDefaultTimeToLiveInSeconds

public Integer getDefaultTimeToLiveInSeconds()

获取容器的默认生存时间值。

Returns:

默认生存时间值（以秒为单位）。

getETag

public String getETag()

获取与资源关联的实体标记。 仅当从服务器获取响应时，这才相关。

Returns:

e 标记。

getId

public String getId()

获取资源的名称。

Returns:

资源的名称。

getIndexingPolicy

public IndexingPolicy getIndexingPolicy()

获取容器的索引策略。

Returns:

索引策略。

getPartitionKeyDefinition

public PartitionKeyDefinition getPartitionKeyDefinition()

获取容器的分区键定义。

Returns:

分区键定义。

getResourceId

public String getResourceId()

获取与资源关联的 ID。

Returns:

与资源关联的 ID。

getTimestamp

public Instant getTimestamp()

获取与资源关联的上次修改时间戳。 仅当从服务器获取响应时，这才相关。

Returns:

时间戳。

getUniqueKeyPolicy

public UniqueKeyPolicy getUniqueKeyPolicy()

获取容器唯一密钥策略

Returns:

唯一密钥策略

setAnalyticalStoreTimeToLiveInSeconds

public CosmosContainerProperties setAnalyticalStoreTimeToLiveInSeconds(Integer timeToLive)

为 Azure Cosmos DB 服务中的容器中的项设置分析存储的生存时间（以秒为单位）。 它是一个可选属性。 有效值必须是非零正整数、“-1”或 0。 默认情况下，AnalysisStoreTimeToLive 设置为 0，这意味着为容器关闭分析存储;-1 表示分析存储中的项永不过期。 度量单位为秒。 允许的最大值为 2147483647。

Parameters:

timeToLive - 分析存储生存时间（以秒为单位）。

Returns:

CosmosContainerProperties。

setChangeFeedPolicy

public CosmosContainerProperties setChangeFeedPolicy(ChangeFeedPolicy value)

设置 Azure Cosmos DB 服务中此容器的 changeFeedPolicy。

Parameters:

value - 要使用的 ChangeFeedPolicy。

Returns:

CosmosContainerProperties。

setClientEncryptionPolicy

public CosmosContainerProperties setClientEncryptionPolicy(ClientEncryptionPolicy value)

设置用于加密项字段的 ClientEncryptionPolicy

Parameters:

value - 要使用的 ClientEncryptionPolicy。

Returns:

CosmosContainerProperties。

setComputedProperties

public CosmosContainerProperties setComputedProperties(Collection computedProperties)

在 Azure Cosmos DB 服务中设置此容器的 computedProperties。 有关如何使用计算属性的详细信息，请访问 Azure Cosmos DB 中的计算属性

Parameters:

computedProperties - computedProperties。

Returns:

CosmosContainerProperties。

setConflictResolutionPolicy

public CosmosContainerProperties setConflictResolutionPolicy(ConflictResolutionPolicy value)

设置 conflictResolutionPolicy，用于解决 Azure Cosmos DB 服务容器中不同区域中项的冲突写入。

Parameters:

value - 要使用的 ConflictResolutionPolicy。

Returns:

CosmosContainerProperties。

setDefaultTimeToLiveInSeconds

public CosmosContainerProperties setDefaultTimeToLiveInSeconds(Integer timeToLive)

设置容器的默认生存时间值。

容器上的默认生存时间值为可选属性。 如果设置，容器中的项在自上次写入时间起的指定秒数后过期。 此属性的值应为下列值之一：

null - 指示对生存时间的评估已禁用，并且容器中的项永远不会过期，无论各个项是否设置了生存时间。

非零正整数 - 指示容器中所有项的默认生存时间值。 此值可由单个项的生存时间值重写。

-1 - 指示默认情况下容器中的所有项永不过期。 此值可由单个项的生存时间值重写。

Parameters:

timeToLive - 默认生存时间值（以秒为单位）。

Returns:

CosmosContainerProperties。

setId

public CosmosContainerProperties setId(String id)

设置资源的名称。

Parameters:

id - 资源的名称。

Returns:

的当前实例 CosmosContainerProperties。

setIndexingPolicy

public CosmosContainerProperties setIndexingPolicy(IndexingPolicy indexingPolicy)

设置容器的索引策略

Parameters:

indexingPolicy - IndexingPolicy 索引策略

Returns:

CosmosContainerProperties。

setPartitionKeyDefinition

public CosmosContainerProperties setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition)

设置容器的分区键定义。

Parameters:

partitionKeyDefinition - 分区键定义。

Returns:

CosmosContainerProperties。

setUniqueKeyPolicy

public CosmosContainerProperties setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

设置容器唯一密钥策略

Parameters:

uniqueKeyPolicy - 唯一密钥策略

Returns:

CosmosContainerProperties。