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

Document 类

包:

com.microsoft.azure.cosmosdb

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

public class Document extends Resource

表示 Azure Cosmos DB 数据库服务中的文档。

文档是结构化的 JSON 文档。 JSON 文档没有设置的架构，文档可能包含任意数量的自定义属性以及可选的附件列表。 文档是应用程序资源，可以使用主密钥或资源密钥进行授权。

构造函数摘要

构造函数	说明
Document()	初始化文档对象。
Document(String jsonString)	从 json 字符串初始化文档对象。
Document(String jsonString, ObjectMapper objectMapper)	从 json 字符串初始化文档对象。

方法摘要

修饰符和类型	方法和描述
Integer	getTimeToLive() 获取文档的生存时间值。
void	setTimeToLive(Integer timeToLive) 设置文档的生存时间值。 文档的生存时间值是一个可选属性。 如果设置，则文档将在自上次写入后指定的秒数后过期。 此属性的值应为下列值之一： null - 指示此文档的生存时间值继承自父集合的默认生存时间值。 非零正整数 - 指示文档过期前的秒数。 它替代父集合上指定的默认生存时间值，除非父集合的默认生存时间为 null。 -1 - 指示文档永不过期。 它替代父集合上指定的默认生存时间值，除非父集合的默认生存时间为 null。

继承成员

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()

构造函数详细信息

Document

public Document()

初始化文档对象。

Document

public Document(String jsonString)

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

Parameters:

jsonString - 表示文档对象的 json 字符串。

Document

public Document(String jsonString, ObjectMapper objectMapper)

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

Parameters:

jsonString - 表示文档对象的 json 字符串。

objectMapper - 自定义对象映射器

方法详细信息

getTimeToLive

public Integer getTimeToLive()

获取文档的生存时间值。

Returns:

文档的生存时间值（以秒为单位）。

setTimeToLive

public void setTimeToLive(Integer timeToLive)

设置文档的生存时间值。

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

null - 指示此文档的生存时间值继承自父集合的默认生存时间值。

非零正整数 - 指示文档过期前的秒数。 它替代父集合上指定的默认生存时间值，除非父集合的默认生存时间为 null。

-1 - 指示文档永不过期。 它替代父集合上指定的默认生存时间值，除非父集合的默认生存时间为 null。

Parameters:

timeToLive - 文档的生存时间值（以秒为单位）。