CosmosContainerProperties Klasse

Paket:

com.azure.cosmos.models

Maven-Artefakt:

com.azure:azure-cosmos:4.59.0

• java.lang.Object
• • com.azure.cosmos.models.CosmosContainerProperties

public final class CosmosContainerProperties

Stellt einen Container im Azure Cosmos DB-Datenbankdienst dar. Ein Cosmos-Container ist ein benannter logischer Container für Cosmos-Elemente.

Eine Datenbank kann null oder mehr benannte Container enthalten, und jeder Container besteht aus 0 oder mehr JSON-Elementen. Da sie schemafrei sind, müssen die Elemente in einem Container nicht dieselbe Struktur oder felder gemeinsam nutzen. Da Es sich bei Containern um Anwendungsressourcen handelt, können sie entweder mithilfe des master schlüssels oder mit Ressourcenschlüsseln autorisiert werden.

Zusammenfassung zum Konstruktor

Konstruktor	Beschreibung
CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition)	Konstruktor
CosmosContainerProperties(String id, String partitionKeyPath)	Konstruktor

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
Integer	getAnalyticalStoreTimeToLiveInSeconds() Ruft die Gültigkeitsdauer des Analysespeichers in Sekunden für Elemente in einem Container aus dem Azure Cosmos DB-Dienst ab.
ChangeFeedPolicy	getChangeFeedPolicy() Ruft die Änderungsfeedrichtliniefür diesen Container im Azure Cosmos DB-Dienst ab.
ClientEncryptionPolicy	getClientEncryptionPolicy() Ruft die Clientverschlüsselungsrichtlinieab, die zum Verschlüsseln von Elementfeldern verwendet wird.
Collection<ComputedProperty>	getComputedProperties() Ruft die berechnetenEigenschaften für diesen Container im Azure Cosmos DB-Dienst ab.
ConflictResolutionPolicy	getConflictResolutionPolicy() Ruft die Konfliktlösungsrichtlinieab, die zum Auflösen von in Konflikt stehenden Schreibvorgängen für Elemente in verschiedenen Regionen in einem Container im Azure Cosmos DB-Dienst verwendet wird.
Integer	getDefaultTimeToLiveInSeconds() Ruft den Standardwert für die Gültigkeitsdauer des Containers ab.
String	getETag() Rufen Sie das Entitätstag ab, das der Ressource zugeordnet ist.
String	getId() Ruft den Namen der Ressource ab.
IndexingPolicy	getIndexingPolicy() Ruft die Indizierungsrichtlinie des Containers ab.
PartitionKeyDefinition	getPartitionKeyDefinition() Ruft die Partitionsschlüsseldefinition der Container ab.
String	getResourceId() Ruft die der Ressource zugeordnete ID ab.
Instant	getTimestamp() Rufen Sie den der Ressource zugeordneten Zeitstempel der letzten Änderung ab.
UniqueKeyPolicy	getUniqueKeyPolicy() Ruft die Eindeutige Schlüsselrichtlinie für Container ab.
CosmosContainerProperties	setAnalyticalStoreTimeToLiveInSeconds(Integer timeToLive) Legt die Zeit des Analysespeichers für Elemente in einem Container aus dem Azure Cosmos DB-Dienst in Sekunden fest.
CosmosContainerProperties	setChangeFeedPolicy(ChangeFeedPolicy value) Legt die Änderungsfeedrichtliniefür diesen Container im Azure Cosmos DB-Dienst fest.
CosmosContainerProperties	setClientEncryptionPolicy(ClientEncryptionPolicy value) Legt die Clientverschlüsselungsrichtliniefest, die zum Verschlüsseln von Elementfeldern verwendet wird.
CosmosContainerProperties	setComputedProperties(Collection<ComputedProperty> computedProperties) Legt die berechnetenEigenschaften für diesen Container im Azure Cosmos DB-Dienst fest.
CosmosContainerProperties	setConflictResolutionPolicy(ConflictResolutionPolicy value) Legt die Konfliktlösungsrichtliniefest, die zum Auflösen von Schreibkonflikten für Elemente in verschiedenen Regionen in einem Container im Azure Cosmos DB-Dienst verwendet wird.
CosmosContainerProperties	setDefaultTimeToLiveInSeconds(Integer timeToLive) Legt den Standardwert für die Laufzeit des Containers fest.
CosmosContainerProperties	setId(String id) Legt den Namen der Ressource fest.
CosmosContainerProperties	setIndexingPolicy(IndexingPolicy indexingPolicy) Legt die Indizierungsrichtlinie des Containers fest.
CosmosContainerProperties	setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition) Legt die Partitionsschlüsseldefinition der Container fest.
CosmosContainerProperties	setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy) Legt die Richtlinie für eindeutige Schlüssel für Container fest.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zum Konstruktor

CosmosContainerProperties

public CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition)

Konstruktor

Parameters:

id - ID des Containers

partitionKeyDefinition - das PartitionKeyDefinition

CosmosContainerProperties

public CosmosContainerProperties(String id, String partitionKeyPath)

Konstruktor

Parameters:

id - ID des Containers

partitionKeyPath - Partitionsschlüsselpfad

Details zur Methode

getAnalyticalStoreTimeToLiveInSeconds

public Integer getAnalyticalStoreTimeToLiveInSeconds()

Ruft die Gültigkeitsdauer des Analysespeichers in Sekunden für Elemente in einem Container aus dem Azure Cosmos DB-Dienst ab. Es handelt sich um eine optionale Eigenschaft. Ein gültiger Wert muss entweder eine positive ganze Zahl ungleich null, '-1' oder 0 sein. AnalyticalStoreTimeToLive ist standardmäßig auf 0 festgelegt, was bedeutet, dass der Analysespeicher für den Container deaktiviert ist. -1 bedeutet, dass Elemente im Analysespeicher nie ablaufen. Die Maßeinheit beträgt Sekunden. Der maximal zulässige Wert ist 2147483647.

Returns:

analytische ttl

getChangeFeedPolicy

public ChangeFeedPolicy getChangeFeedPolicy()

Ruft die changeFeedPolicy für diesen Container im Azure Cosmos DB-Dienst ab.

Returns:

ChangeFeedPolicy

getClientEncryptionPolicy

public ClientEncryptionPolicy getClientEncryptionPolicy()

Ruft die ClientEncryptionPolicy ab, die zum Verschlüsseln von Elementfeldern verwendet wird.

Returns:

ClientEncryptionPolicy

getComputedProperties

public Collection getComputedProperties()

Ruft die computedProperties für diesen Container im Azure Cosmos DB-Dienst ab.

Returns:

computedProperties.

getConflictResolutionPolicy

public ConflictResolutionPolicy getConflictResolutionPolicy()

Ruft die conflictResolutionPolicy ab, die zum Auflösen von in Konflikt stehenden Schreibvorgängen für Elemente in verschiedenen Regionen in einem Container im Azure Cosmos DB-Dienst verwendet wird.

Returns:

Conflictresolutionpolicy

getDefaultTimeToLiveInSeconds

public Integer getDefaultTimeToLiveInSeconds()

Ruft den Standardwert für die Gültigkeitsdauer des Containers ab.

Returns:

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

getETag

public String getETag()

Rufen Sie das Entitätstag ab, das der Ressource zugeordnet ist. Dies ist nur relevant, wenn eine Antwort vom Server abgerufen wird.

Returns:

das e-Tag.

getId

public String getId()

Ruft den Namen der Ressource ab.

Returns:

der Name der Ressource.

getIndexingPolicy

public IndexingPolicy getIndexingPolicy()

Ruft die Indizierungsrichtlinie des Containers ab.

Returns:

die Indizierungsrichtlinie.

getPartitionKeyDefinition

public PartitionKeyDefinition getPartitionKeyDefinition()

Ruft die Partitionsschlüsseldefinition der Container ab.

Returns:

die Partitionsschlüsseldefinition.

getResourceId

public String getResourceId()

Ruft die der Ressource zugeordnete ID ab.

Returns:

die der Ressource zugeordnete ID.

getTimestamp

public Instant getTimestamp()

Rufen Sie den der Ressource zugeordneten Zeitstempel der letzten Änderung ab. Dies ist nur relevant, wenn eine Antwort vom Server abgerufen wird.

Returns:

den Zeitstempel.

getUniqueKeyPolicy

public UniqueKeyPolicy getUniqueKeyPolicy()

Ruft die Eindeutige Schlüsselrichtlinie für Container ab.

Returns:

die Eindeutige Schlüsselrichtlinie

setAnalyticalStoreTimeToLiveInSeconds

public CosmosContainerProperties setAnalyticalStoreTimeToLiveInSeconds(Integer timeToLive)

Legt die Zeit des Analysespeichers für Elemente in einem Container aus dem Azure Cosmos DB-Dienst in Sekunden fest. Es ist eine optionale Eigenschaft. Ein gültiger Wert muss entweder eine nichtzero positive ganze Zahl, "-1" oder 0 sein. AnalyticalStoreTimeToLive ist standardmäßig auf 0 festgelegt, was bedeutet, dass der Analysespeicher für den Container deaktiviert ist. -1 bedeutet, dass Elemente im Analysespeicher nie ablaufen. Die Maßeinheit beträgt Sekunden. Der maximal zulässige Wert ist 2147483647.

Parameters:

timeToLive - die Zeit des Analysespeichers in Sekunden.

Returns:

CosmosContainerProperties.

setChangeFeedPolicy

public CosmosContainerProperties setChangeFeedPolicy(ChangeFeedPolicy value)

Legt die changeFeedPolicy für diesen Container im Azure Cosmos DB-Dienst fest.

Parameters:

value - Zu verwendende ChangeFeedPolicy.

Returns:

CosmosContainerProperties.

setClientEncryptionPolicy

public CosmosContainerProperties setClientEncryptionPolicy(ClientEncryptionPolicy value)

Legt die ClientEncryptionPolicy fest, die zum Verschlüsseln von Elementfeldern verwendet wird.

Parameters:

value - Zu verwendende ClientEncryptionPolicy.

Returns:

CosmosContainerProperties.

setComputedProperties

public CosmosContainerProperties setComputedProperties(Collection computedProperties)

Legt die computedProperties für diesen Container im Azure Cosmos DB-Dienst fest. Weitere Informationen zur Verwendung von berechneten Eigenschaften finden Sie unter Computed Properties in Azure Cosmos DB.

Parameters:

computedProperties - computedProperties.

Returns:

CosmosContainerProperties.

setConflictResolutionPolicy

public CosmosContainerProperties setConflictResolutionPolicy(ConflictResolutionPolicy value)

Legt die conflictResolutionPolicy fest, die zum Auflösen von Schreibkonflikten für Elemente in verschiedenen Regionen in einem Container im Azure Cosmos DB-Dienst verwendet wird.

Parameters:

value - ConflictResolutionPolicy, die verwendet werden soll.

Returns:

CosmosContainerProperties.

setDefaultTimeToLiveInSeconds

public CosmosContainerProperties setDefaultTimeToLiveInSeconds(Integer timeToLive)

Legt den Standardwert für die Laufzeit des Containers fest.

Der Standardwert für die Laufzeit eines Containers ist eine optionale Eigenschaft. Wenn festgelegt, laufen die Elemente innerhalb des Containers nach der angegebenen Anzahl von Sekunden seit ihrer letzten Schreibzeit ab. Der Wert dieser Eigenschaft sollte einer der folgenden sein:

null: Gibt an, dass die Auswertung der Laufzeit deaktiviert ist und Elemente innerhalb des Containers nie ablaufen, unabhängig davon, ob die Laufzeit für einzelne Elemente festgelegt ist.

nonzero positive ganze Zahl: Gibt den Standardwert für die Laufzeit für alle Elemente im Container an. Dieser Wert kann von einzelnen Elementen überschrieben werden.

-1 : Gibt standardmäßig an, dass alle Elemente innerhalb des Containers nie ablaufen. Dieser Wert kann von einzelnen Elementen überschrieben werden.

Parameters:

timeToLive - der Standardwert für die Laufzeit in Sekunden.

Returns:

CosmosContainerProperties.

setId

public CosmosContainerProperties setId(String id)

Legt den Namen der Ressource fest.

Parameters:

id - der Name der Ressource.

Returns:

der aktuelle instance von CosmosContainerProperties.

setIndexingPolicy

public CosmosContainerProperties setIndexingPolicy(IndexingPolicy indexingPolicy)

Legt die Indizierungsrichtlinie des Containers fest.

Parameters:

indexingPolicy - IndexingPolicy die Indizierungsrichtlinie

Returns:

CosmosContainerProperties.

setPartitionKeyDefinition

public CosmosContainerProperties setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition)

Legt die Partitionsschlüsseldefinition der Container fest.

Parameters:

partitionKeyDefinition - die Partitionsschlüsseldefinition.

Returns:

CosmosContainerProperties.

setUniqueKeyPolicy

public CosmosContainerProperties setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Legt die Richtlinie für eindeutige Schlüssel für Container fest.

Parameters:

uniqueKeyPolicy - die Eindeutige Schlüsselrichtlinie

Returns:

CosmosContainerProperties.