Freigeben über

Document Klasse

  • Referenz
Paket:
com.microsoft.azure.cosmosdb

public class Document extends Resource

Stellt ein Dokument im Azure Cosmos DB-Datenbankdienst dar.

Ein Dokument ist ein strukturiertes JSON-Dokument. Es gibt kein festgelegtes Schema für die JSON-Dokumente, und ein Dokument kann eine beliebige Anzahl benutzerdefinierter Eigenschaften sowie eine optionale Liste von Anlagen enthalten. Das Dokument ist eine Anwendungsressource und kann mithilfe des master Schlüssels oder Ressourcenschlüssels autorisiert werden.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
Document()

Initialisieren Sie ein Dokumentobjekt.

Document(String jsonString)

Initialisieren Sie ein Dokumentobjekt aus der JSON-Zeichenfolge.
Document(String jsonString, ObjectMapper objectMapper)

Initialisieren Sie ein Dokumentobjekt aus der JSON-Zeichenfolge.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
Integer getTimeToLive()

Ruft den Time-to-Live-Wert des Dokuments ab.
void setTimeToLive(Integer timeToLive)

Legt den Wert für die Laufzeit des Dokuments fest.

Der Time-to-Live-Wert eines Dokuments ist eine optionale Eigenschaft. Wenn festgelegt, läuft das Dokument nach der angegebenen Anzahl von Sekunden seit der letzten Schreibzeit ab. Der Wert dieser Eigenschaft sollte einer der folgenden sein:

null: Gibt den Wert für die Laufzeit für dieses Dokument an, der vom Standardwert für die Laufzeit der übergeordneten Auflistung erbt.

nonzero positive ganze Zahl: Gibt die Anzahl der Sekunden an, bevor das Dokument abläuft. Es überschreibt den standardbasierten Time-to-Live-Wert, der für die übergeordnete Auflistung angegeben ist, es sei denn, die Standardzeit der übergeordneten Auflistung ist NULL.

-1 : Gibt an, dass das Dokument nie abläuft. Es überschreibt den standardbasierten Time-to-Live-Wert, der für die übergeordnete Auflistung angegeben ist, es sei denn, die Standardzeit der übergeordneten Auflistung ist NULL.

Geerbte Elemente

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

Details zum Konstruktor

Document

public Document()

Initialisieren Sie ein Dokumentobjekt.

Document

public Document(String jsonString)

Initialisieren Sie ein Dokumentobjekt aus der JSON-Zeichenfolge.

Parameters:

jsonString - die JSON-Zeichenfolge, die das Dokumentobjekt darstellt.

Document

public Document(String jsonString, ObjectMapper objectMapper)

Initialisieren Sie ein Dokumentobjekt aus der JSON-Zeichenfolge.

Parameters:

jsonString - die JSON-Zeichenfolge, die das Dokumentobjekt darstellt.
objectMapper - benutzerdefinierte Objektzuordnung

Details zur Methode

getTimeToLive

public Integer getTimeToLive()

Ruft den Time-to-Live-Wert des Dokuments ab.

Returns:

der Wert der Laufzeit des Dokuments in Sekunden.

setTimeToLive

public void setTimeToLive(Integer timeToLive)

Legt den Wert für die Laufzeit des Dokuments fest.

Der Time-to-Live-Wert eines Dokuments ist eine optionale Eigenschaft. Wenn festgelegt, läuft das Dokument nach der angegebenen Anzahl von Sekunden seit der letzten Schreibzeit ab. Der Wert dieser Eigenschaft sollte einer der folgenden sein:

null: Gibt den Wert für die Laufzeit für dieses Dokument an, der vom Standardwert für die Laufzeit der übergeordneten Auflistung erbt.

nonzero positive ganze Zahl: Gibt die Anzahl der Sekunden an, bevor das Dokument abläuft. Es überschreibt den standardbasierten Time-to-Live-Wert, der für die übergeordnete Auflistung angegeben ist, es sei denn, die Standardzeit der übergeordneten Auflistung ist NULL.

-1 : Gibt an, dass das Dokument nie abläuft. Es überschreibt den standardbasierten Time-to-Live-Wert, der für die übergeordnete Auflistung angegeben ist, es sei denn, die Standardzeit der übergeordneten Auflistung ist NULL.

Parameters:

timeToLive - der Wert der Laufzeit des Dokuments in Sekunden.

Gilt für: