CosmosDbPartitionedStorageOptions Klasse

  • Referenz
Paket:
com.microsoft.bot.azure
Maven-Artefakt:
com.microsoft.bot:bot-azure:4.14.3
  • java.lang.Object
    • com.microsoft.bot.azure.CosmosDbPartitionedStorageOptions

public class CosmosDbPartitionedStorageOptions

Cosmos DB Partitioned Storage Options.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
CosmosDbPartitionedStorageOptions()

Erstellt ein leeres Optionsobjekt.
CosmosDbPartitionedStorageOptions(Configuration configuration)

Mit Eigenschaften aus Der Konfiguration erstellen.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
java.lang.String getAuthKey()

Ruft den Authentifizierungsschlüssel für Cosmos DB ab.
java.lang.Boolean getCompatibilityMode()

Ruft einen Wert ab, der angibt, ob im Kompatibilitätsmodus ausgeführt werden soll.
ConnectionPolicy getConnectionPolicy()

Ruft die ConnectionPolicy for the CosmosDB ab.
ConsistencyLevel getConsistencyLevel()

Stellt die Konsistenzstufen dar, die für Azure Cosmos DB-Clientvorgänge im Azure Cosmos DB-Datenbankdienst unterstützt werden.
java.lang.String getContainerId()

Ruft den Containerbezeichner ab.
java.lang.Integer getContainerThroughput()

Ruft den beim Erstellen des Containers festgelegten Durchsatz ab.
java.lang.String getCosmosDbEndpoint()

Ruft den CosmosDB-Endpunkt ab.
java.lang.String getDatabaseId()

Ruft den Datenbankbezeichner für Cosmos DB-Instanz ab.
java.lang.String getKeySuffix()

Ruft das Suffix ab, das zu jedem Schlüssel hinzugefügt werden soll.
void setAuthKey(String withAuthKey)

Legt den Authentifizierungsschlüssel für Cosmos DB fest.
void setCompatibilityMode(Boolean withCompatibilityMode)

Legt einen Wert fest, der angibt, ob im Kompatibilitätsmodus ausgeführt werden soll.
void setConnectionPolicy(ConnectionPolicy withConnectionPolicy)

Legt die ConnectionPolicy für cosmosDB fest.
void setConsistencyLevel(ConsistencyLevel withConsistencyLevel)

Stellt die Konsistenzstufen dar, die für Azure Cosmos DB-Clientvorgänge im Azure Cosmos DB-Datenbankdienst unterstützt werden.
void setContainerId(String withContainerId)

Legt den Containerbezeichner fest.
void setContainerThroughput(Integer withContainerThroughput)

Legt den Durchsatz beim Erstellen des Containers fest.
void setCosmosDbEndpoint(String withCosmosDbEndpoint)

Legt den CosmosDB-Endpunkt fest.
void setDatabaseId(String withDatabaseId)

Legt den Datenbankbezeichner für Cosmos DB-Instanz fest.
void setKeySuffix(String withKeySuffix)

Legt das Suffix fest, das jedem Schlüssel hinzugefügt werden soll.

Geerbte Methoden von java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Details zum Konstruktor

CosmosDbPartitionedStorageOptions

public CosmosDbPartitionedStorageOptions()

Erstellt ein leeres Optionsobjekt.

CosmosDbPartitionedStorageOptions

public CosmosDbPartitionedStorageOptions(Configuration configuration)

Mit Eigenschaften aus Der Konfiguration erstellen.

Parameter:

configuration - Das Configuration-Objekt, aus dem Eigenschaften gelesen werden sollen.

Details zur Methode

getAuthKey

public String getAuthKey()

Ruft den Authentifizierungsschlüssel für Cosmos DB ab.

Gibt zurück:

Der Authentifizierungsschlüssel für die DB.

getCompatibilityMode

public Boolean getCompatibilityMode()

Ruft einen Wert ab, der angibt, ob im Kompatibilitätsmodus ausgeführt werden soll. Frühe Versionen von CosmosDb hatten ein Schlüssellängenlimit von 255. Schlüssel, die länger als dies sind, wurden in CosmosDbKeyEscape abgeschnitten. Dies bleibt das Standardverhalten, kann jedoch überschrieben werden, indem "CompatibilityMode" auf "false" festgelegt wird. Diese Einstellung ermöglicht auch die Verwendung älterer Sammlungen, bei denen kein PartitionKey angegeben wurde. Hinweis: CompatibilityMode kann nicht 'true' sein, wenn KeySuffix verwendet wird.

Gibt zurück:

Der compatibilityMode

getConnectionPolicy

public ConnectionPolicy getConnectionPolicy()

Ruft die ConnectionPolicy für die CosmosDB ab.

Gibt zurück:

Die ConnectionPolicy-Einstellungen.

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Stellt die Konsistenzstufen dar, die für Azure Cosmos DB-Clientvorgänge im Azure Cosmos DB-Datenbankdienst unterstützt werden. Die angeforderte Konsistenzstufe muss übereinstimmen oder schwächer sein als die für das Datenbankkonto bereitgestellte. Konsistenzstufen nach Festigkeitsreihenfolge sind "Strong", "BoundedStaleness", "Session" und "Eventual".

Gibt zurück:

"ConsistencyLevel"

getContainerId

public String getContainerId()

Ruft den Containerbezeichner ab.

Gibt zurück:

Die Container-/Sammlungs-ID.

getContainerThroughput

public Integer getContainerThroughput()

Ruft den beim Erstellen des Containers festgelegten Durchsatz ab. Standardwert ist 400.

Gibt zurück:

Der Containerdurchsatz.

getCosmosDbEndpoint

public String getCosmosDbEndpoint()

Ruft den CosmosDB-Endpunkt ab.

Gibt zurück:

Der DB-Endpunkt.

getDatabaseId

public String getDatabaseId()

Ruft den Datenbankbezeichner für Cosmos DB-Instanz ab.

Gibt zurück:

Die CosmosDB DB-ID.

getKeySuffix

public String getKeySuffix()

Ruft das Suffix ab, das zu jedem Schlüssel hinzugefügt werden soll. Siehe CosmosDbKeyEscape.EscapeKey(string). Hinweis:CompatibilityMode muss auf "false" festgelegt werden, um einen KeySuffix zu verwenden. Wenn KeySuffix verwendet wird, werden Schlüssel NICHT abgeschnitten, aber eine Ausnahme wird ausgelöst, wenn die Schlüssellänge länger als von CosmosDb zulässig ist.

Gibt zurück:

Zeichenfolge, die nur gültige CosmosDb-Schlüsselzeichen enthält. (z. B. nicht: '\', '?', '/', '#', '*').

setAuthKey

public void setAuthKey(String withAuthKey)

Legt den Authentifizierungsschlüssel für Cosmos DB fest.

Parameter:

withAuthKey - Der zu verwendende Authentifizierungsschlüssel.

setCompatibilityMode

public void setCompatibilityMode(Boolean withCompatibilityMode)

Legt einen Wert fest, der angibt, ob im Kompatibilitätsmodus ausgeführt werden soll. Frühe Versionen von CosmosDb hatten ein Schlüssellängenlimit von 255. Schlüssel, die länger als dies sind, wurden in CosmosDbKeyEscape abgeschnitten. Dies bleibt das Standardverhalten, kann jedoch überschrieben werden, indem "CompatibilityMode" auf "false" festgelegt wird. Diese Einstellung ermöglicht auch die Verwendung älterer Sammlungen, bei denen kein PartitionKey angegeben wurde. Hinweis: CompatibilityMode kann nicht 'true' sein, wenn KeySuffix verwendet wird.

Parameter:

withCompatibilityMode - Derzeit beträgt die maximale Schlüssellänge für Cosmosdb 1023: https://docs.microsoft.com/en-us/azure/cosmos-db/concepts-limits#per-item-limits Der Standardwert für Abwärtskompatibilität ist 255, CosmosDbKeyEscape.MaxKeyLength.

setConnectionPolicy

public void setConnectionPolicy(ConnectionPolicy withConnectionPolicy)

Legt die ConnectionPolicy für die CosmosDB fest.

Parameter:

withConnectionPolicy - Die ConnectionPolicy-Einstellungen.

setConsistencyLevel

public void setConsistencyLevel(ConsistencyLevel withConsistencyLevel)

Stellt die Konsistenzstufen dar, die für Azure Cosmos DB-Clientvorgänge im Azure Cosmos DB-Datenbankdienst unterstützt werden. Die angeforderte Konsistenzstufe muss übereinstimmen oder schwächer sein als die für das Datenbankkonto bereitgestellte. Konsistenzstufen nach Festigkeitsreihenfolge sind "Strong", "BoundedStaleness", "Session" und "Eventual".

Parameter:

withConsistencyLevel - Die zu verwendende Konsistenzstufe.

setContainerId

public void setContainerId(String withContainerId)

Legt den Containerbezeichner fest.

Parameter:

withContainerId - Die Container-/Sammlungs-ID.

setContainerThroughput

public void setContainerThroughput(Integer withContainerThroughput)

Legt den Durchsatz beim Erstellen des Containers fest. Standardwert ist 400.

Parameter:

withContainerThroughput - Die gewünschte Obwohlput.

setCosmosDbEndpoint

public void setCosmosDbEndpoint(String withCosmosDbEndpoint)

Legt den CosmosDB-Endpunkt fest.

Parameter:

withCosmosDbEndpoint - Der zu verwendende DB-Endpunkt.

setDatabaseId

public void setDatabaseId(String withDatabaseId)

Legt den Datenbankbezeichner für Cosmos DB-Instanz fest.

Parameter:

withDatabaseId - Die CosmosDB-ID.

setKeySuffix

public void setKeySuffix(String withKeySuffix)

Legt das Suffix fest, das jedem Schlüssel hinzugefügt werden soll. Siehe CosmosDbKeyEscape.EscapeKey(string). Hinweis:CompatibilityMode muss auf "false" festgelegt werden, um einen KeySuffix zu verwenden. Wenn KeySuffix verwendet wird, werden Schlüssel NICHT abgeschnitten, aber eine Ausnahme wird ausgelöst, wenn die Schlüssellänge länger als von CosmosDb zulässig ist.

Parameter:

withKeySuffix - Zeichenfolge, die nur gültige CosmosDb-Schlüsselzeichen enthält. (z. B. nicht: '\', '?', '/', '#', '*').

Gilt für: