Document Classe

Paquet:

com.microsoft.azure.cosmosdb

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

public class Document extends Resource

Représente un document dans le service de base de données Azure Cosmos DB.

Un document est un document JSON structuré. Il n’existe aucun schéma défini pour les documents JSON, et un document peut contenir un nombre quelconque de propriétés personnalisées ainsi qu’une liste facultative de pièces jointes. Document est une ressource d’application qui peut être autorisée à l’aide de la clé master ou des clés de ressource.

Récapitulatif du constructeur

Constructeur	Description
Document()	Initialiser un objet de document.
Document(String jsonString)	Initialisez un objet de document à partir d’une chaîne json.
Document(String jsonString, ObjectMapper objectMapper)	Initialisez un objet de document à partir d’une chaîne json.

Résumé de la méthode

Modificateur et type	Méthode et description
Integer	getTimeToLive() Obtient la valeur de durée de vie du document.
void	setTimeToLive(Integer timeToLive) Définit la valeur de durée de vie du document. La valeur de durée de vie d’un document est une propriété facultative. S’il est défini, le document expire après le nombre de secondes spécifié depuis sa dernière écriture. La valeur de cette propriété doit être l’une des suivantes : null : indique que la valeur de durée de vie de ce document hérite de la valeur de durée de vie par défaut de la collection parente. entier positif différent de zéro : indique le nombre de secondes avant l’expiration du document. Elle remplace la valeur de durée de vie par défaut spécifiée sur la collection parente, sauf si la durée de vie par défaut de la collection parente est null. -1 : indique que le document n’expire jamais. Elle remplace la valeur de durée de vie par défaut spécifiée sur la collection parente, sauf si la durée de vie par défaut de la collection parente est null.

Membres hérités

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

Détails du constructeur

Document

public Document()

Initialiser un objet de document.

Document

public Document(String jsonString)

Initialisez un objet de document à partir d’une chaîne json.

Parameters:

jsonString - chaîne json qui représente l’objet document.

Document

public Document(String jsonString, ObjectMapper objectMapper)

Initialisez un objet de document à partir d’une chaîne json.

Parameters:

jsonString - chaîne json qui représente l’objet document.

objectMapper - mappeur d’objets personnalisé

Détails de la méthode

getTimeToLive

public Integer getTimeToLive()

Obtient la valeur de durée de vie du document.

Returns:

la valeur de durée de vie du document en secondes.

setTimeToLive

public void setTimeToLive(Integer timeToLive)

Définit la valeur de durée de vie du document.

La valeur de durée de vie d’un document est une propriété facultative. S’il est défini, le document expire après le nombre de secondes spécifié depuis sa dernière écriture. La valeur de cette propriété doit être l’une des suivantes :

null : indique que la valeur de durée de vie de ce document hérite de la valeur de durée de vie par défaut de la collection parente.

entier positif différent de zéro : indique le nombre de secondes avant l’expiration du document. Elle remplace la valeur de durée de vie par défaut spécifiée sur la collection parente, sauf si la durée de vie par défaut de la collection parente est null.

-1 : indique que le document n’expire jamais. Elle remplace la valeur de durée de vie par défaut spécifiée sur la collection parente, sauf si la durée de vie par défaut de la collection parente est null.

Parameters:

timeToLive - la valeur de durée de vie du document en secondes.