RequestOptions クラス

パッケージ:

com.microsoft.azure.storage

• java.lang.Object
• • com.microsoft.azure.storage.RequestOptions

public class RequestOptions

特定の要求の処理中に使用するオプションを表します。

コンストラクターの概要

コンストラクター	説明
RequestOptions()	クラスのインスタンスを作成します。
RequestOptions(final RequestOptions other)	別のインスタンスから値をコピーして、 クラスのインスタンスを作成します。

メソッドの概要

修飾子と型	メソッドと説明
void	applyBaseDefaultsInternal(final RequestOptions modifiedOptions) クライアントから既定のタイムアウト、再試行ポリシー、および場所モード (null の場合) を設定します。
Boolean	disableHttpsSocketKeepAlive() https ソケットのキープアライブを無効にするかどうかを示す値を取得します。 キープアライブを無効にするには、 を使用します。それ以外の場合は 。 disableHttpsSocketKeepAlive の既定値の詳細については、次を参照してください。 getDefaultRequestOptions()
final LocationMode	getLocationMode() この要求の既定の場所モードを取得します。 場所モードの詳細については、「」を参照してください setLocationMode(final LocationMode locationMode)。
Integer	getMaximumExecutionTimeInMs() この要求の最大実行時間を取得します。 最大実行時間の既定値の詳細については、「」を参照してください setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs)。
Long	getOperationExpiryTimeInMs() 内部使用のために予約されています。 この操作の有効期限が切れる時刻を返します。 これは、操作の開始時刻と最大実行時間を加算して計算され、最大実行時間が null の場合は null になります。 最大実行時間の詳細については、「」を参照してください setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs)。
final RetryPolicyFactory	getRetryPolicyFactory() この要求に使用する再試行ポリシーを取得します。 再試行ポリシーの既定値の詳細については、「」を参照してください setRetryPolicyFactory(final RetryPolicyFactory retryPolicyFactory)。
final Integer	getTimeoutIntervalInMs() この要求のタイムアウト値を返します。 タイムアウトの既定値の詳細については、「」を参照してください setTimeoutIntervalInMs(final Integer timeoutIntervalInMs)。
void	populateRequestOptions(RequestOptions modifiedOptions, final RequestOptions clientOptions, final boolean setStartTime) 最初の requestOptions オブジェクト内の null フィールドに、2 番目の requestOptions オブジェクトの値を設定します。
Boolean	requireEncryption() 書き込みおよび読み取りのすべてのデータを暗号化する必要があるかどうかを示す値を取得します。 トランザクションのデータを暗号化/暗号化解除するために使用します。それ以外の場合は 。 暗号化の既定値を要求する方法の詳細については、「」を参照してください setRequireEncryption(Boolean requireEncryption)。
void	setDisableHttpsSocketKeepAlive(Boolean disableHttpsSocketKeepAlive) https ソケットのキープアライブを無効にするかどうかを示す値を設定します。 キープアライブを無効にするには、 を使用します。それ以外の場合は、 既定値はクライアントで設定され、既定では true で、https ソケットのキープアライブが無効になっていることを示します。 このプロパティを設定することで、この要求の値を変更できます。 また、 オブジェクトの の値を getDefaultRequestOptions() 変更して、サービス クライアントを介して後続のすべての要求が適切な値を使用するようにすることもできます。 https ソケットでキープアライブを設定すると、再試行された要求で接続タイムアウトが受け入れられない JVM のバグを回避できます。 そのような場合は、フォールバックとしてソケットキープアライブを使用することを選択できます。 残念ながら、タイムアウト値は、ローカルで構成するのではなく、JVM プロパティから取得する必要があります。 したがって、まれに JVM がキープアライブ時間を積極的に短く構成している場合、実行時間の長いデータ転送操作に干渉しないようにキープアライブの使用を有効にすることは有益ではない可能性があります。
void	setLocationMode(final LocationMode locationMode) この要求の を LocationMode 設定します。 既定値 LocationMode はクライアントで設定され、既定 PRIMARY_ONLYでは です。 この要求で を LocationMode 変更するには、このプロパティを設定します。 また、 オブジェクトの値を getDefaultRequestOptions() 変更して、サービス クライアントを介して後続のすべての要求でその を LocationMode使用するようにすることもできます。
void	setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs) この要求を行うときに使用する最大実行時間を設定します。 最大実行時間間隔は、クライアントが要求の構築を開始した時点で開始されます。 最大実行時間は、データのアップロード中、データのダウンロード中、再試行の実行前に断続的にチェックされます。 最大実行時間に達するまで、サービスは引き続きアップロード、ダウンロード、再試行を行います。 その時点で、部分的なアップロードまたはダウンロードは取り消され、例外がスローされます。 既定の最大実行はクライアントで設定され、既定では null で、最大時間は設定されません。 このプロパティを設定することで、この要求の最大実行時間を変更できます。 また、 オブジェクトの値を getDefaultRequestOptions() 変更して、サービス クライアントを介して後続のすべての要求が最大実行時間を使用するようにすることもできます。
void	setRequireEncryption(Boolean requireEncryption) 書き込みおよび読み取りのすべてのデータを暗号化する必要があるかどうかを示す値を設定します。 トランザクションのデータを暗号化/暗号化解除するために使用します。それ以外の場合は 。 既定値はクライアントで設定され、既定では false で、暗号化は必要ないことを示します。 このプロパティを設定することで、この要求の値を変更できます。 サービス クライアントを介して後続のすべての要求で適切な値が getDefaultRequestOptions() 使用されるように、オブジェクトの値を変更することもできます。
final void	setRetryPolicyFactory(final RetryPolicyFactory retryPolicyFactory) この要求に使用する RetryPolicyFactory オブジェクトを設定します。 既定の RetryPolicyFactory はクライアントで設定され、既定 RetryExponentialRetryでは です。 この要求で RetryPolicyFactory を変更するには、このプロパティを設定します。 また、 オブジェクトの値を getDefaultRequestOptions() 変更して、サービス クライアントを介して後続のすべての要求がその RetryPolicyFactory を使用するようにすることもできます。
final void	setTimeoutIntervalInMs(final Integer timeoutIntervalInMs) この要求を行うときに使用するタイムアウトを設定します。 サーバーのタイムアウト間隔は、サービスによって完全な要求が受信された時点で開始され、サーバーは応答の処理を開始します。 クライアントに応答が返される前にタイムアウト間隔が経過すると、操作はタイムアウトになります。要求が再試行された場合、タイムアウト間隔は再試行ごとにリセットされます。 既定のサーバー タイムアウトはクライアントで設定され、既定では null であり、サーバー タイムアウトがないことを示します。 この要求のサーバー タイムアウトは、このプロパティを設定することで変更できます。 また、 オブジェクトの値を getDefaultRequestOptions() 変更して、サービス クライアントを介して後続のすべての要求がそのサーバー タイムアウトを使用するようにすることもできます。

コンストラクターの詳細

RequestOptions

public RequestOptions()

クラスのインスタンスを作成します。

RequestOptions

public RequestOptions(final RequestOptions other)

別のインスタンスから値をコピーして、 クラスのインスタンスを作成します。

Parameters:

other - RequestOptionsコピーする要求オプションを表す オブジェクト。

メソッドの詳細

applyBaseDefaultsInternal

protected static void applyBaseDefaultsInternal(final RequestOptions modifiedOptions)

クライアントから既定のタイムアウト、再試行ポリシー、および場所モード (null の場合) を設定します。

Parameters:

modifiedOptions - 既定値を適用するときにコピーする入力オプション

disableHttpsSocketKeepAlive

public Boolean disableHttpsSocketKeepAlive()

https ソケットのキープアライブを無効にするかどうかを示す値を取得します。 キープアライブを無効にするには、 を使用します。それ以外の場合は 。 disableHttpsSocketKeepAlive の既定値の詳細については、次を参照してください。 getDefaultRequestOptions()

Returns:

https ソケットのキープアライブを無効にするかどうかを示す 値。

getLocationMode

public final LocationMode getLocationMode()

この要求の既定の場所モードを取得します。 場所モードの詳細については、「」を参照してください setLocationMode(final LocationMode locationMode)。

Returns:

LocationModeこの要求の場所モードを表す オブジェクト。

getMaximumExecutionTimeInMs

public Integer getMaximumExecutionTimeInMs()

この要求の最大実行時間を取得します。 最大実行時間の既定値の詳細については、「」を参照してください setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs)。

Returns:

この要求の現在の最大実行時間 (ミリ秒単位)。

getOperationExpiryTimeInMs

public Long getOperationExpiryTimeInMs()

内部使用のために予約されています。

この操作の有効期限が切れる時刻を返します。 これは、操作の開始時刻と最大実行時間を加算して計算され、最大実行時間が null の場合は null になります。 最大実行時間の詳細については、「」を参照してください setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs)。

Returns:

この要求の現在の操作の有効期限 (ミリ秒単位)。

getRetryPolicyFactory

public final RetryPolicyFactory getRetryPolicyFactory()

この要求に使用する再試行ポリシーを取得します。 再試行ポリシーの既定値の詳細については、「」を参照してください setRetryPolicyFactory(final RetryPolicyFactory retryPolicyFactory)。

Returns:

現在の RetryPolicyFactory 再試行ポリシーを表す オブジェクト。

getTimeoutIntervalInMs

public final Integer getTimeoutIntervalInMs()

この要求のタイムアウト値を返します。 タイムアウトの既定値の詳細については、「」を参照してください setTimeoutIntervalInMs(final Integer timeoutIntervalInMs)。

Returns:

この要求の現在のタイムアウト値 (ミリ秒単位)。

populateRequestOptions

protected static void populateRequestOptions(RequestOptions modifiedOptions, final RequestOptions clientOptions, final boolean setStartTime)

最初の requestOptions オブジェクト内の null フィールドに、2 番目の requestOptions オブジェクトの値を設定します。

Parameters:

modifiedOptions

clientOptions

setStartTime

requireEncryption

public Boolean requireEncryption()

書き込みおよび読み取りのすべてのデータを暗号化する必要があるかどうかを示す値を取得します。 トランザクションのデータを暗号化/暗号化解除するために使用します。それ以外の場合は 。 暗号化の既定値を要求する方法の詳細については、「」を参照してください setRequireEncryption(Boolean requireEncryption)。

Returns:

書き込みおよび読み取りのすべてのデータを暗号化する必要があるかどうかを示す 値。

setDisableHttpsSocketKeepAlive

public void setDisableHttpsSocketKeepAlive(Boolean disableHttpsSocketKeepAlive)

https ソケットのキープアライブを無効にするかどうかを示す値を設定します。 キープアライブを無効にするには、 を使用します。それ以外の場合は、

既定値はクライアントで設定され、既定では true で、https ソケットのキープアライブが無効になっていることを示します。 このプロパティを設定することで、この要求の値を変更できます。 また、 オブジェクトの の値を getDefaultRequestOptions() 変更して、サービス クライアントを介して後続のすべての要求が適切な値を使用するようにすることもできます。

https ソケットでキープアライブを設定すると、再試行された要求で接続タイムアウトが受け入れられない JVM のバグを回避できます。 そのような場合は、フォールバックとしてソケットキープアライブを使用することを選択できます。 残念ながら、タイムアウト値は、ローカルで構成するのではなく、JVM プロパティから取得する必要があります。 したがって、まれに JVM がキープアライブ時間を積極的に短く構成している場合、実行時間の長いデータ転送操作に干渉しないようにキープアライブの使用を有効にすることは有益ではない可能性があります。

Parameters:

disableHttpsSocketKeepAlive - https ソケットのキープアライブを無効にするかどうかを示す 値。

setLocationMode

public void setLocationMode(final LocationMode locationMode)

この要求の を LocationMode 設定します。

既定値 LocationMode はクライアントで設定され、既定 PRIMARY_ONLYでは です。 この要求で を LocationMode 変更するには、このプロパティを設定します。 また、 オブジェクトの値を getDefaultRequestOptions() 変更して、サービス クライアントを介して後続のすべての要求でその を LocationMode使用するようにすることもできます。

Parameters:

locationMode - 設定する locationMode

setMaximumExecutionTimeInMs

public void setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs)

この要求を行うときに使用する最大実行時間を設定します。

最大実行時間間隔は、クライアントが要求の構築を開始した時点で開始されます。 最大実行時間は、データのアップロード中、データのダウンロード中、再試行の実行前に断続的にチェックされます。 最大実行時間に達するまで、サービスは引き続きアップロード、ダウンロード、再試行を行います。 その時点で、部分的なアップロードまたはダウンロードは取り消され、例外がスローされます。

既定の最大実行はクライアントで設定され、既定では null で、最大時間は設定されません。 このプロパティを設定することで、この要求の最大実行時間を変更できます。 また、 オブジェクトの値を getDefaultRequestOptions() 変更して、サービス クライアントを介して後続のすべての要求が最大実行時間を使用するようにすることもできます。

Parameters:

maximumExecutionTimeInMs - この要求に使用する最大実行時間 (ミリ秒単位)。

setRequireEncryption

public void setRequireEncryption(Boolean requireEncryption)

書き込みおよび読み取りのすべてのデータを暗号化する必要があるかどうかを示す値を設定します。 トランザクションのデータを暗号化/暗号化解除するために使用します。それ以外の場合は 。

既定値はクライアントで設定され、既定では false で、暗号化は必要ないことを示します。 このプロパティを設定することで、この要求の値を変更できます。 サービス クライアントを介して後続のすべての要求で適切な値が getDefaultRequestOptions() 使用されるように、オブジェクトの値を変更することもできます。

Parameters:

requireEncryption - 書き込みおよび読み取りのすべてのデータを暗号化する必要があるかどうかを示す 値。

setRetryPolicyFactory

public final void setRetryPolicyFactory(final RetryPolicyFactory retryPolicyFactory)

この要求に使用する RetryPolicyFactory オブジェクトを設定します。

既定の RetryPolicyFactory はクライアントで設定され、既定 RetryExponentialRetryでは です。 この要求で RetryPolicyFactory を変更するには、このプロパティを設定します。 また、 オブジェクトの値を getDefaultRequestOptions() 変更して、サービス クライアントを介して後続のすべての要求がその RetryPolicyFactory を使用するようにすることもできます。

Parameters:

retryPolicyFactory - サービス要求を行うときに使用する RetryPolicyFactory オブジェクト。

setTimeoutIntervalInMs

public final void setTimeoutIntervalInMs(final Integer timeoutIntervalInMs)

この要求を行うときに使用するタイムアウトを設定します。

サーバーのタイムアウト間隔は、サービスによって完全な要求が受信された時点で開始され、サーバーは応答の処理を開始します。 クライアントに応答が返される前にタイムアウト間隔が経過すると、操作はタイムアウトになります。要求が再試行された場合、タイムアウト間隔は再試行ごとにリセットされます。

既定のサーバー タイムアウトはクライアントで設定され、既定では null であり、サーバー タイムアウトがないことを示します。 この要求のサーバー タイムアウトは、このプロパティを設定することで変更できます。 また、 オブジェクトの値を getDefaultRequestOptions() 変更して、サービス クライアントを介して後続のすべての要求がそのサーバー タイムアウトを使用するようにすることもできます。

Parameters:

timeoutIntervalInMs - この要求に使用するタイムアウト (ミリ秒単位)。