ConnectionPolicy クラス

パッケージ:

com.microsoft.azure.cosmosdb

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

public class ConnectionPolicy

Azure Cosmos DB データベース サービスの DocumentClient に関連付けられている接続ポリシーを表します。

コンストラクターの概要

コンストラクター	説明
ConnectionPolicy()	コンストラクターです。

メソッドの概要

修飾子と型	メソッドと説明
ConnectionMode	getConnectionMode() クライアントで使用される接続モードを取得します。
ConnectionPolicy	GetDefault() 既定の接続ポリシーを取得します。
boolean	getEnableEndpointDiscovery() geo レプリケートされたデータベース アカウントのエンドポイント検出を有効にするフラグを取得します。
int	getIdleConnectionTimeoutInMillis() アイドル状態の接続のタイムアウトの値を取得します。既定値は 60 秒です。
int	getMaxPoolSize() クライアントが使用している接続プール サイズの値を取得します。
MediaReadMode	getMediaReadMode() 添付ファイルのコンテンツ (メディアとも呼ばれます) のダウンロード モードを取得します。
int	getMediaRequestTimeoutInMillis() 添付ファイル コンテンツ (メディア) 操作のネットワーク ピアからの応答を待機する時間を取得または設定します。
List<String>	getPreferredLocations() geo レプリケートされたデータベース アカウントの優先する場所を取得します
InetSocketAddress	getProxy() プロキシ サーバーの InetSocketAddress を取得します。
int	getRequestTimeoutInMillis() 要求タイムアウト (ネットワーク ピアからの応答を待機する時間) をミリ秒単位で取得します。
RetryOptions	getRetryOptions() DocumentClient インスタンスに関連付けられている再試行ポリシー オプションを取得します。
String	getUserAgentSuffix() ユーザー エージェント サフィックスの値を取得します。
Boolean	isEnableReadRequestsFallback() Azure Cosmos DB サービスのアカウントで構成された複数のリージョンへの読み取りを許可するかどうかを取得します。 既定値は null です。 このプロパティが設定されていない場合、境界付き制約以外のすべての整合性レベルの既定値は true、境界付き制約の既定値は false です。 1. enableEndpointDiscovery は true 2 です。 Azure Cosmos DB アカウントに複数のリージョンがある
boolean	isUsingMultipleWriteLocations() Azure Cosmos DB サービス内の geo レプリケートされたデータベース アカウントの任意の場所 (リージョン) での書き込みを有効にするフラグを取得します。 このプロパティの値が true の場合、SDK は geo レプリケートされたデータベース アカウントの使用可能な書き込み可能な場所に書き込み操作を送信します。 書き込み可能な場所は、PreferredLocations プロパティによって並べ替えられます。 DatabaseAccount の EnableMultipleWriteLocations も true に設定されるまで、プロパティ値を true に設定しても効果はありません。 既定値は false で、書き込みリージョンの場合は PreferredLocations プロパティの最初のリージョンに、PreferredLocations が指定されていない場合はプライマリ アカウント リージョンに書き込みが送信されることを示します。 この値は、アカウント構成と一致している必要があります。 クライアントの有効期間中、書き込みでは、 で説明されているイベントの場合にリージョン エンドポイントを変更できます https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability
void	setConnectionMode(ConnectionMode connectionMode) クライアントで使用される接続モードを設定します。
void	setEnableEndpointDiscovery(boolean enableEndpointDiscovery) geo レプリケートされたデータベース アカウントのエンドポイント検出を有効にするフラグを設定します。 EnableEndpointDiscovery が true の場合、SDK は現在の書き込みリージョンと読み取りリージョンを自動的に検出し、リージョンの機能とユーザーの設定に基づいて要求が正しいリージョンに送信されるようにします。 このプロパティの既定値は、エンドポイント検出が有効になっていることを示す true です。
void	setEnableReadRequestsFallback(Boolean enableReadRequestsFallback) Azure Cosmos DB サービスのアカウントで構成された複数のリージョンへの読み取りを許可するかどうかを設定します。 既定値は null です。 このプロパティが設定されていない場合、境界付き制約以外のすべての整合性レベルの既定値は true、境界付き制約の既定値は false です。 1. enableEndpointDiscovery は true 2 です。 Azure Cosmos DB アカウントに複数のリージョンがある
void	setIdleConnectionTimeoutInMillis(int idleConnectionTimeoutInMillis) は、アイドル状態の接続のタイムアウトの値を設定します。 その後、接続は自動的に閉じられます。
void	setMaxPoolSize(int maxPoolSize) 接続プール サイズの値を設定します。既定値は 1000 です。
void	setMediaReadMode(MediaReadMode mediaReadMode) 添付ファイルのコンテンツ (メディアとも呼ばれます) のダウンロード モードを設定します。
void	setMediaRequestTimeoutInMillis(int mediaRequestTimeoutInMillis) 添付ファイル コンテンツ (メディア) 操作のネットワーク ピアからの応答を待機する時間を取得または設定します。
void	setPreferredLocations(List<String> preferredLocations) geo レプリケートされたデータベース アカウントの優先する場所を設定します。 たとえば、優先する場所として "米国東部" とします。 EnableEndpointDiscovery が true で PreferredRegions が空でない場合、SDK では、操作を実行するために指定された順序でコレクション内の場所を使用します。 EnableEndpointDiscovery が false に設定されている場合、このプロパティは無視されます。
void	setProxy(String proxyHost, int proxyPort) これにより、プロキシ サーバーの InetSocketAddress が作成され、cosmosDB へのすべての要求がこのアドレスからルーティングされます。
void	setRequestTimeoutInMillis(int requestTimeoutInMillis) 要求タイムアウト (ネットワーク ピアからの応答を待機する時間) をミリ秒単位で設定します。 既定値は 60 秒です。
void	setRetryOptions(RetryOptions retryOptions) DocumentClient インスタンスに関連付けられている再試行ポリシー オプションを設定します。 RetryOptions クラスのプロパティを使用すると、アプリケーションで組み込みの再試行ポリシーをカスタマイズできます。 このプロパティは省略可能です。 設定されていない場合、SDK は再試行ポリシーの構成に既定値を使用します。 詳細については、「RetryOptions クラス」を参照してください。
void	setUserAgentSuffix(String userAgentSuffix) は、ユーザー エージェント サフィックスの値を設定します。
void	setUsingMultipleWriteLocations(boolean usingMultipleWriteLocations) フラグを設定して、Azure Cosmos DB サービス内の geo レプリケートされたデータベース アカウントの任意の場所 (リージョン) に対する書き込みを有効にします。 このプロパティの値が true の場合、SDK は geo レプリケートされたデータベース アカウントの使用可能な書き込み可能な場所に書き込み操作を送信します。 書き込み可能な場所は、PreferredLocations プロパティによって並べ替えられます。 DatabaseAccount の EnableMultipleWriteLocations も true に設定されるまで、プロパティ値を true に設定しても効果はありません。 既定値は false で、書き込みリージョンの場合は PreferredLocations プロパティの最初のリージョンに、PreferredLocations が指定されていない場合はプライマリ アカウント リージョンに書き込みが送信されることを示します。 この値は、アカウント構成と一致している必要があります。 クライアントの有効期間中、書き込みでは、 で説明されているイベントの場合にリージョン エンドポイントを変更できます https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability
String	toString()

コンストラクターの詳細

ConnectionPolicy

public ConnectionPolicy()

コンストラクターです。

メソッドの詳細

getConnectionMode

public ConnectionMode getConnectionMode()

クライアントで使用される接続モードを取得します。

戻り値:

接続モード。

GetDefault

public static ConnectionPolicy GetDefault()

既定の接続ポリシーを取得します。

戻り値:

既定の接続ポリシー。

getEnableEndpointDiscovery

public boolean getEnableEndpointDiscovery()

geo レプリケートされたデータベース アカウントのエンドポイント検出を有効にするフラグを取得します。

戻り値:

エンドポイント検出が有効になっているかどうか。

getIdleConnectionTimeoutInMillis

public int getIdleConnectionTimeoutInMillis()

アイドル状態の接続のタイムアウトの値を取得します。既定値は 60 秒です。

戻り値:

アイドル状態の接続タイムアウト。

getMaxPoolSize

public int getMaxPoolSize()

クライアントが使用している接続プール サイズの値を取得します。

戻り値:

接続プールのサイズ。

getMediaReadMode

public MediaReadMode getMediaReadMode()

添付ファイルのコンテンツ (メディアとも呼ばれます) のダウンロード モードを取得します。

戻り値:

メディア読み取りモード。

getMediaRequestTimeoutInMillis

public int getMediaRequestTimeoutInMillis()

添付ファイル コンテンツ (メディア) 操作のネットワーク ピアからの応答を待機する時間を取得または設定します。

戻り値:

メディア要求のタイムアウト (ミリ秒単位)。

getPreferredLocations

public List getPreferredLocations()

geo レプリケートされたデータベース アカウントの優先する場所を取得します

戻り値:

優先する場所の一覧。

getProxy

public InetSocketAddress getProxy()

プロキシ サーバーの InetSocketAddress を取得します。

戻り値:

proxyHost の値。

getRequestTimeoutInMillis

public int getRequestTimeoutInMillis()

要求タイムアウト (ネットワーク ピアからの応答を待機する時間) をミリ秒単位で取得します。

戻り値:

要求タイムアウト (ミリ秒単位)。

getRetryOptions

public RetryOptions getRetryOptions()

DocumentClient インスタンスに関連付けられている再試行ポリシー オプションを取得します。

戻り値:

RetryOptions インスタンス。

getUserAgentSuffix

public String getUserAgentSuffix()

ユーザー エージェント サフィックスの値を取得します。

戻り値:

user-agent サフィックスの値。

isEnableReadRequestsFallback

public Boolean isEnableReadRequestsFallback()

Azure Cosmos DB サービスのアカウントで構成された複数のリージョンへの読み取りを許可するかどうかを取得します。

既定値は null です。

このプロパティが設定されていない場合、境界付き制約以外のすべての整合性レベルの既定値は true、境界付き制約の既定値は false です。 1. enableEndpointDiscovery は true 2 です。 Azure Cosmos DB アカウントに複数のリージョンがある

戻り値:

フラグを使用して、Azure Cosmos DB サービスのアカウントで構成された複数のリージョンに読み取りを行えるようにします。

isUsingMultipleWriteLocations

public boolean isUsingMultipleWriteLocations()

Azure Cosmos DB サービス内の geo レプリケートされたデータベース アカウントの任意の場所 (リージョン) での書き込みを有効にするフラグを取得します。

このプロパティの値が true の場合、SDK は geo レプリケートされたデータベース アカウントの使用可能な書き込み可能な場所に書き込み操作を送信します。 書き込み可能な場所は、PreferredLocations プロパティによって並べ替えられます。 DatabaseAccount の EnableMultipleWriteLocations も true に設定されるまで、プロパティ値を true に設定しても効果はありません。

既定値は false で、書き込みリージョンの場合は PreferredLocations プロパティの最初のリージョンに、PreferredLocations が指定されていない場合はプライマリ アカウント リージョンに書き込みが送信されることを示します。

この値は、アカウント構成と一致している必要があります。

クライアントの有効期間中、書き込みでは、 で説明されているイベントの場合にリージョン エンドポイントを変更できます https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability

戻り値:

geo レプリケートされたデータベース アカウントの任意の場所 (リージョン) での書き込みを有効にするフラグ。

setConnectionMode

public void setConnectionMode(ConnectionMode connectionMode)

クライアントで使用される接続モードを設定します。

パラメーター:

connectionMode - 接続モード。

setEnableEndpointDiscovery

public void setEnableEndpointDiscovery(boolean enableEndpointDiscovery)

geo レプリケートされたデータベース アカウントのエンドポイント検出を有効にするフラグを設定します。

EnableEndpointDiscovery が true の場合、SDK は現在の書き込みリージョンと読み取りリージョンを自動的に検出し、リージョンの機能とユーザーの設定に基づいて要求が正しいリージョンに送信されるようにします。

このプロパティの既定値は、エンドポイント検出が有効になっていることを示す true です。

パラメーター:

enableEndpointDiscovery - EndpointDiscovery が有効になっている場合は true。

setEnableReadRequestsFallback

public void setEnableReadRequestsFallback(Boolean enableReadRequestsFallback)

Azure Cosmos DB サービスのアカウントで構成された複数のリージョンへの読み取りを許可するかどうかを設定します。

既定値は null です。

このプロパティが設定されていない場合、境界付き制約以外のすべての整合性レベルの既定値は true、境界付き制約の既定値は false です。 1. enableEndpointDiscovery は true 2 です。 Azure Cosmos DB アカウントに複数のリージョンがある

パラメーター:

enableReadRequestsFallback - フラグを使用して、Azure Cosmos DB サービスのアカウントで構成された複数のリージョンに読み取りを行えるようにします。

setIdleConnectionTimeoutInMillis

public void setIdleConnectionTimeoutInMillis(int idleConnectionTimeoutInMillis)

は、アイドル状態の接続のタイムアウトの値を設定します。 その後、接続は自動的に閉じられます。

パラメーター:

idleConnectionTimeoutInMillis - アイドル状態の接続のタイムアウト (秒単位)。

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize)

接続プール サイズの値を設定します。既定値は 1000 です。

パラメーター:

maxPoolSize - 接続プール サイズの値。

setMediaReadMode

public void setMediaReadMode(MediaReadMode mediaReadMode)

添付ファイルのコンテンツ (メディアとも呼ばれます) のダウンロード モードを設定します。

パラメーター:

mediaReadMode - メディア読み取りモード。

setMediaRequestTimeoutInMillis

public void setMediaRequestTimeoutInMillis(int mediaRequestTimeoutInMillis)

添付ファイル コンテンツ (メディア) 操作のネットワーク ピアからの応答を待機する時間を取得または設定します。

パラメーター:

mediaRequestTimeoutInMillis - メディア要求のタイムアウト (ミリ秒単位)。

setPreferredLocations

public void setPreferredLocations(List preferredLocations)

geo レプリケートされたデータベース アカウントの優先する場所を設定します。 たとえば、優先する場所として "米国東部" とします。

EnableEndpointDiscovery が true で PreferredRegions が空でない場合、SDK では、操作を実行するために指定された順序でコレクション内の場所を使用します。

EnableEndpointDiscovery が false に設定されている場合、このプロパティは無視されます。

パラメーター:

preferredLocations - 優先する場所の一覧。

setProxy

public void setProxy(String proxyHost, int proxyPort)

これにより、プロキシ サーバーの InetSocketAddress が作成され、cosmosDB へのすべての要求がこのアドレスからルーティングされます。

パラメーター:

proxyHost - プロキシ サーバー ホスト。

proxyPort - プロキシ サーバーのポート。

setRequestTimeoutInMillis

public void setRequestTimeoutInMillis(int requestTimeoutInMillis)

要求タイムアウト (ネットワーク ピアからの応答を待機する時間) をミリ秒単位で設定します。 既定値は 60 秒です。

パラメーター:

requestTimeoutInMillis - 要求タイムアウト (ミリ秒単位)。

setRetryOptions

public void setRetryOptions(RetryOptions retryOptions)

DocumentClient インスタンスに関連付けられている再試行ポリシー オプションを設定します。

RetryOptions クラスのプロパティを使用すると、アプリケーションで組み込みの再試行ポリシーをカスタマイズできます。 このプロパティは省略可能です。 設定されていない場合、SDK は再試行ポリシーの構成に既定値を使用します。 詳細については、「RetryOptions クラス」を参照してください。

パラメーター:

retryOptions - RetryOptions インスタンス。

setUserAgentSuffix

public void setUserAgentSuffix(String userAgentSuffix)

は、ユーザー エージェント サフィックスの値を設定します。

パラメーター:

userAgentSuffix - user-agent ヘッダーに追加される値。これは監視目的で使用されます。

setUsingMultipleWriteLocations

public void setUsingMultipleWriteLocations(boolean usingMultipleWriteLocations)

フラグを設定して、Azure Cosmos DB サービス内の geo レプリケートされたデータベース アカウントの任意の場所 (リージョン) に対する書き込みを有効にします。

このプロパティの値が true の場合、SDK は geo レプリケートされたデータベース アカウントの使用可能な書き込み可能な場所に書き込み操作を送信します。 書き込み可能な場所は、PreferredLocations プロパティによって並べ替えられます。 DatabaseAccount の EnableMultipleWriteLocations も true に設定されるまで、プロパティ値を true に設定しても効果はありません。

既定値は false で、書き込みリージョンの場合は PreferredLocations プロパティの最初のリージョンに、PreferredLocations が指定されていない場合はプライマリ アカウント リージョンに書き込みが送信されることを示します。

この値は、アカウント構成と一致している必要があります。

クライアントの有効期間中、書き込みでは、 で説明されているイベントの場合にリージョン エンドポイントを変更できます https://docs.microsoft.com/azure/cosmos-db/troubleshoot-sdk-availability

パラメーター:

usingMultipleWriteLocations - geo レプリケートされたデータベース アカウントの任意の場所 (リージョン) での書き込みを有効にするフラグ。

toString

public String toString()