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

DocumentCollection 类

包:

com.microsoft.azure.cosmosdb

• java.lang.Object
• • JsonSerializable
  • • 资源
    • • com.microsoft.azure.cosmosdb.DocumentCollection

public class DocumentCollection extends Resource

表示 Azure Cosmos DB 数据库服务中的文档集合。 集合是文档的命名逻辑容器。

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

构造函数摘要

构造函数	说明
DocumentCollection()	初始化文档集合对象。
DocumentCollection(String jsonString)	从 json 字符串初始化文档集合对象。

方法摘要

修饰符和类型	方法和描述
boolean	equals(Object obj)
ConflictResolutionPolicy	getConflictResolutionPolicy() 获取 conflictResolutionPolicy，用于解决 Azure Cosmos DB 服务集合中不同区域中文档的冲突写入。
String	getConflictsLink() 获取集合中冲突的自链接。
Integer	getDefaultTimeToLive() 获取集合的默认生存时间值。
String	getDocumentsLink() 获取集合中文档的自链接。
IndexingPolicy	getIndexingPolicy() 获取索引策略。
PartitionKeyDefinition	getPartitionKey() 获取集合的分区键定义。
String	getStoredProceduresLink() 获取集合中存储过程的自链接。
String	getTriggersLink() 获取集合中触发器的自链接。
UniqueKeyPolicy	getUniqueKeyPolicy() 设置 Uni，用于保证 Azure Cosmos DB 服务集合中文档的唯一性。
String	getUserDefinedFunctionsLink() 获取集合中用户定义的函数的自链接。
int	hashCode()
void	setConflictResolutionPolicy(ConflictResolutionPolicy value) 设置 conflictResolutionPolicy，用于解决 Azure Cosmos DB 服务集合中不同区域中文档的冲突写入。
void	setDefaultTimeToLive(Integer timeToLive) 设置集合的默认生存时间值。 集合上的默认生存时间值是可选属性。 如果设置，集合中的文档将在自上次写入后指定的秒数后过期。 此属性的值应为下列值之一： null - 指示已禁用生存时间评估，并且集合中的文档永远不会过期，无论各个文档是否设置了生存时间。 非零正整数 - 指示集合中所有文档的默认生存时间值。 此值可由单个文档的生存时间值重写。 -1 - 默认指示集合中的所有文档永不过期。 此值可由单个文档的生存时间值重写。
void	setIndexingPolicy(IndexingPolicy indexingPolicy) 设置索引策略。
void	setPartitionKey(PartitionKeyDefinition partitionKey) 设置集合的分区键定义。
void	setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

继承成员

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) Resource.getETag() JsonSerializable.getHashMap() Resource.getId() JsonSerializable.getInt(String propertyName) JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(List<String> propertyNames) Resource.getResourceId() Resource.getSelfLink() JsonSerializable.getString(String propertyName) Resource.getTimestamp() JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.remove(String propertyName) Resource.Resource(Resource resource) Resource.Resource() Resource.Resource(String jsonString, ObjectMapper objectMapper) Resource.Resource(String jsonString) Resource.setId(String id) Resource.setResourceId(String resourceId) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString()

构造函数详细信息

DocumentCollection

public DocumentCollection()

初始化文档集合对象。

DocumentCollection

public DocumentCollection(String jsonString)

从 json 字符串初始化文档集合对象。

参数:

jsonString - 表示文档集合的 json 字符串。

方法详细信息

equals

public boolean equals(Object obj)

参数:

obj

getConflictResolutionPolicy

public ConflictResolutionPolicy getConflictResolutionPolicy()

获取 conflictResolutionPolicy，用于解决 Azure Cosmos DB 服务集合中不同区域中文档的冲突写入。

返回:

ConflictResolutionPolicy

getConflictsLink

public String getConflictsLink()

获取集合中冲突的自链接。

返回:

冲突链接。

getDefaultTimeToLive

public Integer getDefaultTimeToLive()

获取集合的默认生存时间值。

返回:

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

getDocumentsLink

public String getDocumentsLink()

获取集合中文档的自链接。

返回:

文档链接。

getIndexingPolicy

public IndexingPolicy getIndexingPolicy()

获取索引策略。

返回:

索引策略。

getPartitionKey

public PartitionKeyDefinition getPartitionKey()

获取集合的分区键定义。

返回:

分区键定义。

getStoredProceduresLink

public String getStoredProceduresLink()

获取集合中存储过程的自链接。

返回:

存储过程链接。

getTriggersLink

public String getTriggersLink()

获取集合中触发器的自链接。

返回:

触发器链接。

getUniqueKeyPolicy

public UniqueKeyPolicy getUniqueKeyPolicy()

设置 Uni，用于保证 Azure Cosmos DB 服务集合中文档的唯一性。

返回:

UniqueKeyPolicy

getUserDefinedFunctionsLink

public String getUserDefinedFunctionsLink()

获取集合中用户定义的函数的自链接。

返回:

用户定义的函数链接。

hashCode

public int hashCode()

setConflictResolutionPolicy

public void setConflictResolutionPolicy(ConflictResolutionPolicy value)

设置 conflictResolutionPolicy，用于解决 Azure Cosmos DB 服务集合中不同区域中文档的冲突写入。

参数:

value - 要使用的 ConflictResolutionPolicy。

setDefaultTimeToLive

public void setDefaultTimeToLive(Integer timeToLive)

设置集合的默认生存时间值。

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

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

非零正整数 - 指示集合中所有文档的默认生存时间值。 此值可由单个文档的生存时间值重写。

-1 - 默认指示集合中的所有文档永不过期。 此值可由单个文档的生存时间值重写。

参数:

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

setIndexingPolicy

public void setIndexingPolicy(IndexingPolicy indexingPolicy)

设置索引策略。

参数:

indexingPolicy - 索引策略。

setPartitionKey

public void setPartitionKey(PartitionKeyDefinition partitionKey)

设置集合的分区键定义。

参数:

partitionKey - 分区键定义。

setUniqueKeyPolicy

public void setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

参数:

uniqueKeyPolicy