ConnectionPolicy Klasse

Paket:

com.microsoft.azure.cosmosdb

• java.lang.Object
• • com.microsoft.azure.cosmosdb.ConnectionPolicy

public class ConnectionPolicy

Stellt die Verbindungsrichtlinie dar, die einem DocumentClient im Azure Cosmos DB-Datenbankdienst zugeordnet ist.

Zusammenfassung zum Konstruktor

Konstruktor	Beschreibung
ConnectionPolicy()	Konstruktor.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
ConnectionMode	getConnectionMode() Ruft den im Client verwendeten Verbindungsmodus ab.
ConnectionPolicy	GetDefault() Ruft die Standardverbindungsrichtlinie ab.
boolean	getEnableEndpointDiscovery() Ruft das Flag ab, um die Endpunktermittlung für georeplizierte Datenbankkonten zu aktivieren.
int	getIdleConnectionTimeoutInMillis() Ruft den Wert des Timeouts für eine Verbindung im Leerlauf ab, der Standardwert ist 60 Sekunden.
int	getMaxPoolSize() Ruft den Wert der Verbindungspoolgröße ab, die der Client verwendet.
MediaReadMode	getMediaReadMode() Ruft den Downloadmodus für Anlageninhalte (auch als Medien bezeichnet) ab.
int	getMediaRequestTimeoutInMillis() Ruft die Zeit ab, die auf die Antwort vom Netzwerkpeer für Vorgänge mit Anlageninhalten (auch als Medien bezeichnet) gewartet werden soll, oder legt diese fest.
List<String>	getPreferredLocations() Ruft die bevorzugten Speicherorte für georeplizierte Datenbankkonten ab.
InetSocketAddress	getProxy() Ruft die InetSocketAddress des Proxyservers ab.
int	getRequestTimeoutInMillis() Ruft das Anforderungstimeout (Zeit zum Warten auf die Antwort vom Netzwerkpeer) in Millisekunden ab.
RetryOptions	getRetryOptions() Ruft die Wiederholungsrichtlinienoptionen ab, die dem DocumentClient-instance zugeordnet sind.
String	getUserAgentSuffix() Ruft den Wert des Benutzer-Agent-Suffixs ab.
Boolean	isEnableReadRequestsFallback() Ruft ab, ob Lesevorgänge in mehrere Regionen gelangen sollen, die für ein Konto des Azure Cosmos DB-Diensts konfiguriert sind. Der Standardwert ist null. Wenn diese Eigenschaft nicht festgelegt ist, ist der Standardwert true für alle anderen Konsistenzebenen als bounded Staleness. Der Standardwert ist false für Bounded Staleness. 1. enableEndpointDiscovery ist wahr 2. Das Azure Cosmos DB-Konto verfügt über mehrere Regionen
boolean	isUsingMultipleWriteLocations() Ruft das Flag ab, um Schreibvorgänge an beliebigen Speicherorten (Regionen) für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst zu aktivieren. Wenn der Wert dieser Eigenschaft true ist, leitet das SDK Schreibvorgänge an verfügbare beschreibbare Speicherorte des georeplizierten Datenbankkontos weiter. Beschreibbare Speicherorte werden von der PreferredLocations-Eigenschaft sortiert. Das Festlegen des Eigenschaftswerts auf true hat keine Auswirkungen, bis EnableMultipleWriteLocations in DatabaseAccount ebenfalls auf true festgelegt ist. Der Standardwert ist false, der angibt, dass Schreibvorgänge in der PreferredLocations-Eigenschaft an die erste Region weitergeleitet werden, wenn es sich um eine Schreibregion oder die primäre Kontoregion handelt, wenn keine PreferredLocations angegeben sind. Der Wert sollte mit Ihrer Kontokonfiguration übereinstimmen. Während der Clientlebensdauer können Schreibvorgänge den regionalen Endpunkt im Fall eines Ereignisses ändern, das unter https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability
void	setConnectionMode(ConnectionMode connectionMode) Legt den im Client verwendeten Verbindungsmodus fest.
void	setEnableEndpointDiscovery(boolean enableEndpointDiscovery) Legt das Flag fest, um die Endpunktermittlung für georeplizierte Datenbankkonten zu aktivieren. Wenn EnableEndpointDiscovery true ist, ermittelt das SDK automatisch die aktuellen Schreib- und Leseregionen, um sicherzustellen, dass Anforderungen basierend auf der Funktion der Region und den Vorlieben des Benutzers an die richtige Region gesendet werden. Der Standardwert für diese Eigenschaft ist true, was angibt, dass die Endpunktermittlung aktiviert ist.
void	setEnableReadRequestsFallback(Boolean enableReadRequestsFallback) Legt fest, ob Lesevorgänge in mehrere Regionen gelangen sollen, die für ein Konto des Azure Cosmos DB-Diensts konfiguriert sind. Der Standardwert ist null. Wenn diese Eigenschaft nicht festgelegt ist, ist der Standardwert true für alle anderen Konsistenzebenen als bounded Staleness. Der Standardwert ist false für Bounded Staleness. 1. enableEndpointDiscovery ist wahr 2. Das Azure Cosmos DB-Konto verfügt über mehrere Regionen
void	setIdleConnectionTimeoutInMillis(int idleConnectionTimeoutInMillis) legt den Wert des Timeouts für eine Verbindung im Leerlauf fest. Danach wird die Verbindung automatisch geschlossen.
void	setMaxPoolSize(int maxPoolSize) Legt den Wert der Verbindungspoolgröße fest, der Standardwert ist 1000.
void	setMediaReadMode(MediaReadMode mediaReadMode) Legt den Downloadmodus für Anlageninhalte (auch als Medien bezeichnet) fest.
void	setMediaRequestTimeoutInMillis(int mediaRequestTimeoutInMillis) Ruft die Zeit ab, die auf eine Antwort vom Netzwerkpeer für Vorgänge mit Anlageninhalten (auch als Medien bezeichnet) wartet, oder legt diese fest.
void	setPreferredLocations(List<String> preferredLocations) Legt die bevorzugten Speicherorte für georeplizierte Datenbankkonten fest. Beispiel: "USA, Osten" als bevorzugter Standort. Wenn EnableEndpointDiscovery true ist und PreferredRegions nicht leer ist, verwendet das SDK die Speicherorte in der Sammlung lieber in der Angegebenen Reihenfolge für die Ausführung von Vorgängen. Wenn EnableEndpointDiscovery auf false festgelegt ist, wird diese Eigenschaft ignoriert.
void	setProxy(String proxyHost, int proxyPort) Dadurch wird die InetSocketAddress für den Proxyserver erstellt. Alle Anforderungen an cosmoDB werden von dieser Adresse weitergeleitet.
void	setRequestTimeoutInMillis(int requestTimeoutInMillis) Legt das Anforderungstimeout (Zeit zum Warten auf die Antwort vom Netzwerkpeer) in Millisekunden fest. Der Standardwert ist 60 Sekunden.
void	setRetryOptions(RetryOptions retryOptions) Legt die Wiederholungsrichtlinienoptionen fest, die dem DocumentClient-instance zugeordnet sind. Eigenschaften in der RetryOptions-Klasse ermöglichen es der Anwendung, die integrierten Wiederholungsrichtlinien anzupassen. Diese Eigenschaft ist optional. Wenn es nicht festgelegt ist, verwendet das SDK die Standardwerte zum Konfigurieren der Wiederholungsrichtlinien. Weitere Informationen finden Sie unter RetryOptions-Klasse.
void	setUserAgentSuffix(String userAgentSuffix) legt den Wert des Suffixs user-agent fest.
void	setUsingMultipleWriteLocations(boolean usingMultipleWriteLocations) Legt das Flag fest, um Schreibvorgänge an beliebigen Standorten (Regionen) für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst zu aktivieren. Wenn der Wert dieser Eigenschaft true ist, leitet das SDK Schreibvorgänge an verfügbare beschreibbare Speicherorte des georeplizierten Datenbankkontos weiter. Schreibbare Standorte werden nach der PreferredLocations-Eigenschaft sortiert. Das Festlegen des Eigenschaftswerts auf true hat keine Auswirkung, bis EnableMultipleWriteLocations in DatabaseAccount ebenfalls auf true festgelegt ist. Der Standardwert ist false, der angibt, dass Schreibvorgänge in der PreferredLocations-Eigenschaft an die erste Region weitergeleitet werden, wenn es sich um eine Schreibregion oder die primäre Kontoregion handelt, wenn keine PreferredLocations angegeben sind. Der Wert sollte mit Ihrer Kontokonfiguration übereinstimmen. Während der Clientlebensdauer können Schreibvorgänge den regionalen Endpunkt ändern, falls unter beschriebene Ereignisse auftreten. https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability
String	toString()

Details zum Konstruktor

ConnectionPolicy

public ConnectionPolicy()

Konstruktor.

Details zur Methode

getConnectionMode

public ConnectionMode getConnectionMode()

Ruft den im Client verwendeten Verbindungsmodus ab.

Returns:

der Verbindungsmodus.

GetDefault

public static ConnectionPolicy GetDefault()

Ruft die Standardverbindungsrichtlinie ab.

Returns:

die Standardverbindungsrichtlinie.

getEnableEndpointDiscovery

public boolean getEnableEndpointDiscovery()

Ruft das Flag ab, um die Endpunktermittlung für georeplizierte Datenbankkonten zu aktivieren.

Returns:

ob die Endpunktermittlung aktiviert ist.

getIdleConnectionTimeoutInMillis

public int getIdleConnectionTimeoutInMillis()

Ruft den Wert des Timeouts für eine Verbindung im Leerlauf ab, der Standardwert ist 60 Sekunden.

Returns:

Timeout für Leerlaufverbindungen.

getMaxPoolSize

public int getMaxPoolSize()

Ruft den Wert der Verbindungspoolgröße ab, die der Client verwendet.

Returns:

Verbindungspoolgröße.

getMediaReadMode

public MediaReadMode getMediaReadMode()

Ruft den Downloadmodus für Anlageninhalte (auch als Medien bezeichnet) ab.

Returns:

der Medienlesemodus.

getMediaRequestTimeoutInMillis

public int getMediaRequestTimeoutInMillis()

Ruft die Zeit ab, die auf die Antwort vom Netzwerkpeer für Vorgänge mit Anlageninhalten (auch als Medien bezeichnet) gewartet werden soll, oder legt diese fest.

Returns:

das Medienanforderungstimeout in Millisekunden.

getPreferredLocations

public List getPreferredLocations()

Ruft die bevorzugten Speicherorte für georeplizierte Datenbankkonten ab.

Returns:

die Liste der bevorzugten Standorte.

getProxy

public InetSocketAddress getProxy()

Ruft die InetSocketAddress des Proxyservers ab.

Returns:

der Wert von proxyHost.

getRequestTimeoutInMillis

public int getRequestTimeoutInMillis()

Ruft das Anforderungstimeout (Zeit zum Warten auf die Antwort vom Netzwerkpeer) in Millisekunden ab.

Returns:

das Anforderungstimeout in Millisekunden.

getRetryOptions

public RetryOptions getRetryOptions()

Ruft die Wiederholungsrichtlinienoptionen ab, die dem DocumentClient-instance zugeordnet sind.

Returns:

die retryOptions-instance.

getUserAgentSuffix

public String getUserAgentSuffix()

Ruft den Wert des Benutzer-Agent-Suffixs ab.

Returns:

der Wert des Suffixs "User-Agent".

isEnableReadRequestsFallback

public Boolean isEnableReadRequestsFallback()

Ruft ab, ob Lesevorgänge in mehrere Regionen gelangen sollen, die für ein Konto des Azure Cosmos DB-Diensts konfiguriert sind.

Der Standardwert ist null.

Wenn diese Eigenschaft nicht festgelegt ist, ist der Standardwert true für alle anderen Konsistenzebenen als bounded Staleness. Der Standardwert ist false für Bounded Staleness. 1. enableEndpointDiscovery ist wahr 2. Das Azure Cosmos DB-Konto verfügt über mehrere Regionen

Returns:

flag, damit Lesevorgänge in mehrere Regionen wechseln können, die für ein Konto des Azure Cosmos DB-Diensts konfiguriert sind.

isUsingMultipleWriteLocations

public boolean isUsingMultipleWriteLocations()

Ruft das Flag ab, um Schreibvorgänge an beliebigen Speicherorten (Regionen) für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst zu aktivieren.

Wenn der Wert dieser Eigenschaft true ist, leitet das SDK Schreibvorgänge an verfügbare beschreibbare Speicherorte des georeplizierten Datenbankkontos weiter. Beschreibbare Speicherorte werden von der PreferredLocations-Eigenschaft sortiert. Das Festlegen des Eigenschaftswerts auf true hat keine Auswirkungen, bis EnableMultipleWriteLocations in DatabaseAccount ebenfalls auf true festgelegt ist.

Der Standardwert ist false, der angibt, dass Schreibvorgänge in der PreferredLocations-Eigenschaft an die erste Region weitergeleitet werden, wenn es sich um eine Schreibregion oder die primäre Kontoregion handelt, wenn keine PreferredLocations angegeben sind.

Der Wert sollte mit Ihrer Kontokonfiguration übereinstimmen.

Während der Clientlebensdauer können Schreibvorgänge den regionalen Endpunkt im Fall eines Ereignisses ändern, das unter https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability

Returns:

Flag, um Schreibvorgänge an beliebigen Speicherorten (Regionen) für georeplizierte Datenbankkonten zu aktivieren.

setConnectionMode

public void setConnectionMode(ConnectionMode connectionMode)

Legt den im Client verwendeten Verbindungsmodus fest.

Parameters:

connectionMode - der Verbindungsmodus.

setEnableEndpointDiscovery

public void setEnableEndpointDiscovery(boolean enableEndpointDiscovery)

Legt das Flag fest, um die Endpunktermittlung für georeplizierte Datenbankkonten zu aktivieren.

Wenn EnableEndpointDiscovery true ist, ermittelt das SDK automatisch die aktuellen Schreib- und Leseregionen, um sicherzustellen, dass Anforderungen basierend auf der Funktion der Region und den Vorlieben des Benutzers an die richtige Region gesendet werden.

Der Standardwert für diese Eigenschaft ist true, was angibt, dass die Endpunktermittlung aktiviert ist.

Parameters:

enableEndpointDiscovery - true, wenn EndpointDiscovery aktiviert ist.

setEnableReadRequestsFallback

public void setEnableReadRequestsFallback(Boolean enableReadRequestsFallback)

Legt fest, ob Lesevorgänge in mehrere Regionen gelangen sollen, die für ein Konto des Azure Cosmos DB-Diensts konfiguriert sind.

Der Standardwert ist null.

Wenn diese Eigenschaft nicht festgelegt ist, ist der Standardwert true für alle anderen Konsistenzebenen als bounded Staleness. Der Standardwert ist false für Bounded Staleness. 1. enableEndpointDiscovery ist wahr 2. Das Azure Cosmos DB-Konto verfügt über mehrere Regionen

Parameters:

enableReadRequestsFallback - flag, damit Lesevorgänge in mehrere Regionen wechseln können, die für ein Konto des Azure Cosmos DB-Diensts konfiguriert sind.

setIdleConnectionTimeoutInMillis

public void setIdleConnectionTimeoutInMillis(int idleConnectionTimeoutInMillis)

legt den Wert des Timeouts für eine Verbindung im Leerlauf fest. Danach wird die Verbindung automatisch geschlossen.

Parameters:

idleConnectionTimeoutInMillis - das Timeout für eine Leerlaufverbindung in Sekunden.

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize)

Legt den Wert der Verbindungspoolgröße fest, der Standardwert ist 1000.

Parameters:

maxPoolSize - Der Wert der Verbindungspoolgröße.

setMediaReadMode

public void setMediaReadMode(MediaReadMode mediaReadMode)

Legt den Downloadmodus für Anlageninhalte (auch als Medien bezeichnet) fest.

Parameters:

mediaReadMode - der Medienlesemodus.

setMediaRequestTimeoutInMillis

public void setMediaRequestTimeoutInMillis(int mediaRequestTimeoutInMillis)

Ruft die Zeit ab, die auf eine Antwort vom Netzwerkpeer für Vorgänge mit Anlageninhalten (auch als Medien bezeichnet) wartet, oder legt diese fest.

Parameters:

mediaRequestTimeoutInMillis - das Medienanforderungstimeout in Millisekunden.

setPreferredLocations

public void setPreferredLocations(List preferredLocations)

Legt die bevorzugten Speicherorte für georeplizierte Datenbankkonten fest. Beispiel: "USA, Osten" als bevorzugter Standort.

Wenn EnableEndpointDiscovery true ist und PreferredRegions nicht leer ist, verwendet das SDK die Speicherorte in der Sammlung lieber in der Angegebenen Reihenfolge für die Ausführung von Vorgängen.

Wenn EnableEndpointDiscovery auf false festgelegt ist, wird diese Eigenschaft ignoriert.

Parameters:

preferredLocations - die Liste der bevorzugten Standorte.

setProxy

public void setProxy(String proxyHost, int proxyPort)

Dadurch wird die InetSocketAddress für den Proxyserver erstellt. Alle Anforderungen an cosmoDB werden von dieser Adresse weitergeleitet.

Parameters:

proxyHost - Der Proxyserverhost.

proxyPort - Der Proxyserverport.

setRequestTimeoutInMillis

public void setRequestTimeoutInMillis(int requestTimeoutInMillis)

Legt das Anforderungstimeout (Zeit zum Warten auf die Antwort vom Netzwerkpeer) in Millisekunden fest. Der Standardwert ist 60 Sekunden.

Parameters:

requestTimeoutInMillis - das Anforderungstimeout in Millisekunden.

setRetryOptions

public void setRetryOptions(RetryOptions retryOptions)

Legt die Wiederholungsrichtlinienoptionen fest, die dem DocumentClient-instance zugeordnet sind.

Eigenschaften in der RetryOptions-Klasse ermöglichen es der Anwendung, die integrierten Wiederholungsrichtlinien anzupassen. Diese Eigenschaft ist optional. Wenn es nicht festgelegt ist, verwendet das SDK die Standardwerte zum Konfigurieren der Wiederholungsrichtlinien. Weitere Informationen finden Sie unter RetryOptions-Klasse.

Parameters:

retryOptions - die retryOptions-instance.

setUserAgentSuffix

public void setUserAgentSuffix(String userAgentSuffix)

legt den Wert des Suffixs user-agent fest.

Parameters:

userAgentSuffix - Der Wert, der an den User-Agent-Header angefügt werden soll, wird zu Überwachungszwecken verwendet.

setUsingMultipleWriteLocations

public void setUsingMultipleWriteLocations(boolean usingMultipleWriteLocations)

Legt das Flag fest, um Schreibvorgänge an beliebigen Standorten (Regionen) für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst zu aktivieren.

Wenn der Wert dieser Eigenschaft true ist, leitet das SDK Schreibvorgänge an verfügbare beschreibbare Speicherorte des georeplizierten Datenbankkontos weiter. Schreibbare Standorte werden nach der PreferredLocations-Eigenschaft sortiert. Das Festlegen des Eigenschaftswerts auf true hat keine Auswirkung, bis EnableMultipleWriteLocations in DatabaseAccount ebenfalls auf true festgelegt ist.

Der Standardwert ist false, der angibt, dass Schreibvorgänge in der PreferredLocations-Eigenschaft an die erste Region weitergeleitet werden, wenn es sich um eine Schreibregion oder die primäre Kontoregion handelt, wenn keine PreferredLocations angegeben sind.

Der Wert sollte mit Ihrer Kontokonfiguration übereinstimmen.

Während der Clientlebensdauer können Schreibvorgänge den regionalen Endpunkt ändern, falls unter beschriebene Ereignisse auftreten. https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability

Parameters:

usingMultipleWriteLocations - Flag, um Schreibvorgänge an beliebigen Standorten (Regionen) für georeplizierte Datenbankkonten zu aktivieren.

toString

public String toString()