Document Classe

Pacote:

com.microsoft.azure.cosmosdb

• java.lang.Object
• • JsonSerializable
  • • Recurso
    • • com.microsoft.azure.cosmosdb.Document

public class Document extends Resource

Representa um documento no serviço de banco de dados do Azure Cosmos DB.

Um documento é um documento JSON estruturado. Não há um esquema definido para os documentos JSON e um documento pode conter qualquer número de propriedades personalizadas, bem como uma lista opcional de anexos. O documento é um recurso de aplicativo e pode ser autorizado usando a chave de master ou chaves de recurso.

Resumo do Construtor

Construtor	Description
Document()	Inicializar um objeto de documento.
Document(String jsonString)	Inicialize um objeto de documento da cadeia de caracteres json.
Document(String jsonString, ObjectMapper objectMapper)	Inicialize um objeto de documento da cadeia de caracteres json.

Resumo do método

Modificador e tipo	Método e descrição
Integer	getTimeToLive() Obtém o valor de vida útil do documento.
void	setTimeToLive(Integer timeToLive) Define o valor de vida útil do documento. O valor de vida útil de um documento é uma propriedade opcional. Se definido, o documento expirará após o número especificado de segundos desde o último tempo de gravação. O valor dessa propriedade deve ser um dos seguintes: nulo – indica que o valor de vida útil deste documento herda do valor de vida útil padrão da coleção pai. inteiro positivo diferente de zero – indica o número de segundos antes que o documento expire. Ele substitui o valor de vida útil padrão especificado na coleção pai, a menos que o tempo de vida padrão da coleção pai seja nulo. -1 - indica que o documento nunca expira. Ele substitui o valor de vida útil padrão especificado na coleção pai, a menos que o tempo de vida padrão da coleção pai seja nulo.

Membros herdados

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

Detalhes do construtor

Document

public Document()

Inicializar um objeto de documento.

Document

public Document(String jsonString)

Inicialize um objeto de documento da cadeia de caracteres json.

Parameters:

jsonString - a cadeia de caracteres json que representa o objeto do documento.

Document

public Document(String jsonString, ObjectMapper objectMapper)

Inicialize um objeto de documento da cadeia de caracteres json.

Parameters:

jsonString - a cadeia de caracteres json que representa o objeto do documento.

objectMapper - o mapeador de objetos personalizado

Detalhes do método

getTimeToLive

public Integer getTimeToLive()

Obtém o valor de vida útil do documento.

Returns:

o valor de vida útil do documento em segundos.

setTimeToLive

public void setTimeToLive(Integer timeToLive)

Define o valor de vida útil do documento.

O valor de vida útil de um documento é uma propriedade opcional. Se definido, o documento expirará após o número especificado de segundos desde o último tempo de gravação. O valor dessa propriedade deve ser um dos seguintes:

nulo – indica que o valor de vida útil deste documento herda do valor de vida útil padrão da coleção pai.

inteiro positivo diferente de zero – indica o número de segundos antes que o documento expire. Ele substitui o valor de vida útil padrão especificado na coleção pai, a menos que o tempo de vida padrão da coleção pai seja nulo.

-1 - indica que o documento nunca expira. Ele substitui o valor de vida útil padrão especificado na coleção pai, a menos que o tempo de vida padrão da coleção pai seja nulo.

Parameters:

timeToLive - o valor de vida útil do documento em segundos.