DocumentCollection Klasse

Paket:

com.microsoft.azure.cosmosdb

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

public class DocumentCollection extends Resource

Stellt eine Dokumentsammlung im Azure Cosmos DB-Datenbankdienst dar. Eine Sammlung ist ein benannter logischer Container für Dokumente.

Eine Datenbank kann null oder mehr benannte Auflistungen enthalten, und jede Sammlung besteht aus 0 oder mehr JSON-Dokumenten. Da sie schemafrei sind, müssen die Dokumente in einer Auflistung nicht dieselbe Struktur oder felder verwenden. Da Sammlungen Anwendungsressourcen sind, können sie entweder mithilfe des master-Schlüssels oder mit Ressourcenschlüsseln autorisiert werden.

Zusammenfassung zum Konstruktor

Konstruktor	Beschreibung
DocumentCollection()	Initialisieren Sie ein Dokumentsammlungsobjekt.
DocumentCollection(String jsonString)	Initialisieren Sie ein Dokumentsammlungsobjekt aus der JSON-Zeichenfolge.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
boolean	equals(Object obj)
ConflictResolutionPolicy	getConflictResolutionPolicy() Ruft die conflictResolutionPolicy ab, die zum Auflösen von Schreibkonflikten in Dokumenten in verschiedenen Regionen in einer Sammlung im Azure Cosmos DB-Dienst verwendet wird.
String	getConflictsLink() Ruft die Selbstverknüpfung für Konflikte in einer Auflistung ab.
Integer	getDefaultTimeToLive() Ruft den Standardzeitwert der Sammlung ab.
String	getDocumentsLink() Ruft die Selbstverknüpfung für Dokumente in einer Sammlung ab.
IndexingPolicy	getIndexingPolicy() Ruft die Indizierungsrichtlinie ab.
PartitionKeyDefinition	getPartitionKey() Ruft die Partitionsschlüsseldefinition der Auflistung ab.
String	getStoredProceduresLink() Ruft die Selbstverknüpfung für gespeicherte Prozeduren in einer Auflistung ab.
String	getTriggersLink() Ruft die Selbstverknüpfung für Trigger in einer Auflistung ab.
UniqueKeyPolicy	getUniqueKeyPolicy() Legt die Uni fest, die die Eindeutigkeit von Dokumenten in der Sammlung im Azure Cosmos DB-Dienst garantiert.
String	getUserDefinedFunctionsLink() Ruft die Selbstverknüpfung für benutzerdefinierte Funktionen in einer Auflistung ab.
int	hashCode()
void	setConflictResolutionPolicy(ConflictResolutionPolicy value) Legt die conflictResolutionPolicy fest, die zum Auflösen von in Konflikt stehenden Schreibvorgängen in Dokumenten in verschiedenen Regionen in einer Sammlung im Azure Cosmos DB-Dienst verwendet wird.
void	setDefaultTimeToLive(Integer timeToLive) Legt den Standardwert für die Gültigkeitsdauer der Auflistung fest. Der Standardwert für die Gültigkeitsdauer einer Auflistung ist eine optionale Eigenschaft. Wenn festgelegt, laufen die Dokumente innerhalb der Sammlung nach der angegebenen Anzahl von Sekunden seit der letzten Schreibzeit ab. Der Wert dieser Eigenschaft sollte einer der folgenden sein: null: Gibt an, dass die Auswertung der Gültigkeitsdauer deaktiviert ist und Dokumente innerhalb der Sammlung nie ablaufen, unabhängig davon, ob die Gültigkeitsdauer für einzelne Dokumente festgelegt ist. Positive ganze Zahl ungleich null: Gibt den Standardwert für die Gültigkeitsdauer für alle Dokumente innerhalb der Auflistung an. Dieser Wert kann durch den Gültigkeitsdauerwert einzelner Dokumente überschrieben werden. -1: Gibt standardmäßig an, dass alle Dokumente innerhalb der Sammlung nie ablaufen. Dieser Wert kann durch den Gültigkeitsdauerwert einzelner Dokumente überschrieben werden.
void	setIndexingPolicy(IndexingPolicy indexingPolicy) Legt die Indizierungsrichtlinie fest.
void	setPartitionKey(PartitionKeyDefinition partitionKey) Legt die Partitionsschlüsseldefinition der Auflistung fest.
void	setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

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

DocumentCollection

public DocumentCollection()

Initialisieren Sie ein Dokumentsammlungsobjekt.

DocumentCollection

public DocumentCollection(String jsonString)

Initialisieren Sie ein Dokumentsammlungsobjekt aus der JSON-Zeichenfolge.

Parameters:

jsonString - die JSON-Zeichenfolge, die die Dokumentauflistung darstellt.

Details zur Methode

equals

public boolean equals(Object obj)

Parameters:

obj

getConflictResolutionPolicy

public ConflictResolutionPolicy getConflictResolutionPolicy()

Ruft die conflictResolutionPolicy ab, die zum Auflösen von Schreibkonflikten in Dokumenten in verschiedenen Regionen in einer Sammlung im Azure Cosmos DB-Dienst verwendet wird.

Returns:

Conflictresolutionpolicy

getConflictsLink

public String getConflictsLink()

Ruft die Selbstverknüpfung für Konflikte in einer Auflistung ab.

Returns:

der Konfliktlink.

getDefaultTimeToLive

public Integer getDefaultTimeToLive()

Ruft den Standardzeitwert der Sammlung ab.

Returns:

der Standardwert für die Laufzeit in Sekunden.

getDocumentsLink

public String getDocumentsLink()

Ruft die Selbstverknüpfung für Dokumente in einer Sammlung ab.

Returns:

der Dokumentlink.

getIndexingPolicy

public IndexingPolicy getIndexingPolicy()

Ruft die Indizierungsrichtlinie ab.

Returns:

die Indizierungsrichtlinie.

getPartitionKey

public PartitionKeyDefinition getPartitionKey()

Ruft die Partitionsschlüsseldefinition der Auflistung ab.

Returns:

Die Partitionsschlüsseldefinition.

getStoredProceduresLink

public String getStoredProceduresLink()

Ruft die Selbstverknüpfung für gespeicherte Prozeduren in einer Auflistung ab.

Returns:

Der Link für gespeicherte Prozeduren.

getTriggersLink

public String getTriggersLink()

Ruft die Selbstverknüpfung für Trigger in einer Auflistung ab.

Returns:

der Triggerlink.

getUniqueKeyPolicy

public UniqueKeyPolicy getUniqueKeyPolicy()

Legt die Uni fest, die die Eindeutigkeit von Dokumenten in der Sammlung im Azure Cosmos DB-Dienst garantiert.

Returns:

UniqueKeyPolicy

getUserDefinedFunctionsLink

public String getUserDefinedFunctionsLink()

Ruft die Selbstverknüpfung für benutzerdefinierte Funktionen in einer Auflistung ab.

Returns:

Der Link für benutzerdefinierte Funktionen.

hashCode

public int hashCode()

setConflictResolutionPolicy

public void setConflictResolutionPolicy(ConflictResolutionPolicy value)

Legt die conflictResolutionPolicy fest, die zum Auflösen von in Konflikt stehenden Schreibvorgängen in Dokumenten in verschiedenen Regionen in einer Sammlung im Azure Cosmos DB-Dienst verwendet wird.

Parameters:

value - Zu verwendende ConflictResolutionPolicy.

setDefaultTimeToLive

public void setDefaultTimeToLive(Integer timeToLive)

Legt den Standardwert für die Gültigkeitsdauer der Auflistung fest.

Der Standardwert für die Gültigkeitsdauer einer Auflistung ist eine optionale Eigenschaft. Wenn festgelegt, laufen die Dokumente innerhalb der Sammlung nach der angegebenen Anzahl von Sekunden seit der letzten Schreibzeit ab. Der Wert dieser Eigenschaft sollte einer der folgenden sein:

null: Gibt an, dass die Auswertung der Gültigkeitsdauer deaktiviert ist und Dokumente innerhalb der Sammlung nie ablaufen, unabhängig davon, ob die Gültigkeitsdauer für einzelne Dokumente festgelegt ist.

Positive ganze Zahl ungleich null: Gibt den Standardwert für die Gültigkeitsdauer für alle Dokumente innerhalb der Auflistung an. Dieser Wert kann durch den Gültigkeitsdauerwert einzelner Dokumente überschrieben werden.

-1: Gibt standardmäßig an, dass alle Dokumente innerhalb der Sammlung nie ablaufen. Dieser Wert kann durch den Gültigkeitsdauerwert einzelner Dokumente überschrieben werden.

Parameters:

timeToLive - Der Standardwert für die Gültigkeitsdauer in Sekunden.

setIndexingPolicy

public void setIndexingPolicy(IndexingPolicy indexingPolicy)

Legt die Indizierungsrichtlinie fest.

Parameters:

indexingPolicy - die Indizierungsrichtlinie.

setPartitionKey

public void setPartitionKey(PartitionKeyDefinition partitionKey)

Legt die Partitionsschlüsseldefinition der Auflistung fest.

Parameters:

partitionKey - Die Partitionsschlüsseldefinition.

setUniqueKeyPolicy

public void setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Parameters:

uniqueKeyPolicy