BlobRequestOptions クラス

  • リファレンス
パッケージ:
com.microsoft.azure.storage.blob
  • java.lang.Object

public class BlobRequestOptions extends RequestOptions

要求で指定できる一連のオプションを表します。

コンストラクターの概要

コンストラクター 説明
BlobRequestOptions()

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

BlobRequestOptions(final BlobRequestOptions other)

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

メソッドの概要

修飾子と型 メソッドと説明
void applyDefaults(final BlobRequestOptions modifiedOptions, final BlobType blobtype)

渡されたオプションに既定値を適用します。
void assertNoEncryptionPolicyOrStrictMode()

検証がオンの場合、暗号化ポリシーが指定されていないことをアサートします。

void assertPolicyIfRequired()

strict モードがオンの場合は、暗号化ポリシーが指定されていることをアサートします。

Boolean getAbsorbConditionalErrorsOnRetry()

要求の再試行時に条件付きエラーを吸収するかどうかを示します。 再試行の既定値での条件付きエラーの吸収の詳細については、「」を参照してください setAbsorbConditionalErrorsOnRetry(final Boolean absorbConditionalErrorsOnRetry)。
boolean getCommitWriteOnInputStreamException()

からの読み取りと を使用する場合の例外処理の動作を定義する 。 ストリームから例外の時点まで読み取られたデータがフラッシュされ、そのデータで新しい BLOB がコミットされる場合。 それ以外の場合、アップロードは中止され、データはコミットされません。

既定値の詳細については、「」を参照してください setCommitWriteOnInputStreamException(boolean commitWriteOnInputStreamException)。
Integer getConcurrentRequestCount()

操作ごとの同時要求の同時実行数を取得します。 同時要求数の既定値の詳細については、「」を参照してください setConcurrentRequestCount(final Integer concurrentRequestCount)。
BlobCustomerProvidedKey getCustomerProvidedKey()

この要求に使用する顧客指定のキーを取得します。
Boolean getDisableContentMD5Validation()

ダウンロードと BlobInputStream メソッドが BLOB の ContentMD5 ヘッダーを無視するかどうかを取得します。 コンテンツ MD5 検証の既定値を無効にする方法の詳細については、次を参照してください。 setDisableContentMD5Validation(final Boolean disableContentMD5Validation)
BlobEncryptionPolicy getEncryptionPolicy()

この要求に使用する暗号化ポリシーを取得します。 暗号化ポリシーの既定値の詳細については、「」を参照してください setEncryptionPolicy(BlobEncryptionPolicy encryptionPolicy)。
Integer getSingleBlobPutThresholdInBytes()

1 つの BLOB の書き込みに使用されるしきい値サイズを取得します。 しきい値サイズの既定値の詳細については、「」を参照してください setSingleBlobPutThresholdInBytes(final Integer singleBlobPutThresholdInBytes)。
boolean getSkipEtagLocking()

警告: BLOB のダウンロードで etag ロックが自動的に使用され、BLOB がダウンロード途中で変更されないようにします。 この検証は自己責任でスキップしてください。

BLOB ダウンロードの etag ロックと検証をスキップするかどうかを取得します。
Boolean getStoreBlobContentMD5()

アップロード時に BLOB の ContentMD5 ヘッダーを設定する必要があるかどうかを取得します。 このフィールドは、ページ BLOB ではサポートされていません。 BLOB コンテンツ MD5 の既定値の格納の詳細については、次を参照してください。 setStoreBlobContentMD5(final Boolean storeBlobContentMD5)
Boolean getUseTransactionalContentMD5()

範囲 PUT または GET 操作で Content-MD5 ヘッダーを使用してトランザクション セキュリティを適用するかどうかを取得します。 BLOB の部分的なアップロードまたはダウンロードはすべて 4 MB に制限されます。 トランザクション コンテンツ MD5 の既定値の詳細については、「」を参照してください setUseTransactionalContentMD5(final Boolean useTransactionalContentMD5)。
boolean getValidateEncryptionPolicy()

コピー要求のソースで使用する顧客指定のキーを取得します。
final BlobRequestOptions populateAndApplyDefaults(final BlobRequestOptions options, final BlobType blobType, final CloudBlobClient client)

の場合は、指定したクライアントからの同時要求数を使用して、それ以外のすべてに既定値を設定し、親クラスで定義されている既定値を設定します。
final BlobRequestOptions populateAndApplyDefaults(final BlobRequestOptions options, final BlobType blobType, final CloudBlobClient client, final boolean setStartTime)

の場合は、指定したクライアントからの同時要求数を使用して、それ以外のすべてに既定値を設定し、親クラスで定義されている既定値を設定します。
void setAbsorbConditionalErrorsOnRetry(final Boolean absorbConditionalErrorsOnRetry)

要求の再試行時に条件付きエラーを吸収するかどうかを設定します。 このオプションは、upload メソッドと openWrite メソッドでのみ使用 CloudAppendBlob されます。 既定では、 は に設定されています。 これは、単一ライター シナリオの場合にのみ に設定します。

このプロパティを設定すると、この要求で absorbConditionalErrorsOnRetry 値を変更できます。 オブジェクトの値を変更して、サービス クライアント経由で getDefaultRequestOptions() 行われた後続のすべての要求で absorbConditionalErrorsOnRetry 値が使用されるようにすることもできます。
void setCommitWriteOnInputStreamException(boolean commitWriteOnInputStreamException)

からの読み取りと を使用する場合の例外処理の動作を定義する 。 ストリームから例外の時点まで読み取られたデータがフラッシュされ、そのデータで新しい BLOB がコミットされる場合。 それ以外の場合、アップロードは中止され、データはコミットされません。

既定値は［<すべて>］です。
void setConcurrentRequestCount(final Integer concurrentRequestCount)

操作ごとの同時要求の同時実行数を設定します。

既定の同時実行要求数はクライアントで設定され、既定では 1 であり、コンカレンシーがないことを示します。 このプロパティを設定すると、この要求の同時要求数を変更できます。 また、サービス クライアントを介して行われた後続のすべての要求で、その同時要求数が使用されるように、オブジェクトの値 getDefaultRequestOptions() を変更することもできます。
void setCustomerProvidedKey(BlobCustomerProvidedKey key)

この要求に使用する BlobCustomerProvidedKey オブジェクトを設定します。 顧客が提供するキー暗号化は、BLOB ストレージへのほとんどのアップロード、ダウンロード、コピー要求、およびプロパティとメタデータのフェッチでサポートされています。
void setDisableContentMD5Validation(final Boolean disableContentMD5Validation)

ダウンロードと BlobInputStream メソッドで BLOB の ContentMD5 ヘッダーを無視するかどうかを設定します。

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

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

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

使用する 1 つの BLOB の書き込みに使用するしきい値サイズを設定します。

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

警告: BLOB のダウンロードで etag ロックが自動的に使用され、BLOB がダウンロード途中で変更されないようにします。 この検証は自己責任でスキップしてください。

BLOB ダウンロードの etag ロックと検証をスキップするかどうかを設定します。
void setStoreBlobContentMD5(final Boolean storeBlobContentMD5)

アップロード時に BLOB の ContentMD5 ヘッダーを設定するかどうかを設定します。 このフィールドは、ページ BLOB ではサポートされていません。

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

範囲 PUT または GET 操作で Content-MD5 ヘッダーを使用してトランザクション セキュリティを適用するかどうかを設定します。 BLOB の部分的なアップロードまたはダウンロードはすべて 4 MB に制限されます。

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

ソース BLOB に使用する BlobCustomerProvidedKey オブジェクトを設定します。 お客様が提供するキー暗号化は、BLOB ストレージへのほとんどのアップロード、ダウンロード、コピー要求、およびプロパティとメタデータのフェッチでサポートされています。

継承メンバー

RequestOptions.applyBaseDefaultsInternal(final RequestOptions modifiedOptions) RequestOptions.disableHttpsSocketKeepAlive() RequestOptions.getLocationMode() RequestOptions.getMaximumExecutionTimeInMs() RequestOptions.getOperationExpiryTimeInMs() RequestOptions.getRetryPolicyFactory() RequestOptions.getTimeoutIntervalInMs() RequestOptions.populateRequestOptions(RequestOptions modifiedOptions, final RequestOptions clientOptions, final boolean setStartTime) RequestOptions.RequestOptions() RequestOptions.RequestOptions(final RequestOptions other) RequestOptions.requireEncryption() RequestOptions.setDisableHttpsSocketKeepAlive(Boolean disableHttpsSocketKeepAlive) RequestOptions.setLocationMode(final LocationMode locationMode) RequestOptions.setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs) RequestOptions.setRequireEncryption(Boolean requireEncryption) RequestOptions.setRetryPolicyFactory(final RetryPolicyFactory retryPolicyFactory) RequestOptions.setTimeoutIntervalInMs(final Integer timeoutIntervalInMs)

コンストラクターの詳細

BlobRequestOptions

public BlobRequestOptions()

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

BlobRequestOptions

public BlobRequestOptions(final BlobRequestOptions other)

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

Parameters:

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

メソッドの詳細

applyDefaults

protected static void applyDefaults(final BlobRequestOptions modifiedOptions, final BlobType blobtype)

渡されたオプションに既定値を適用します。

Parameters:

modifiedOptions - 既定値を適用するオプション。
blobtype

assertNoEncryptionPolicyOrStrictMode

protected void assertNoEncryptionPolicyOrStrictMode()

検証がオンの場合、暗号化ポリシーが指定されていないことをアサートします。

assertPolicyIfRequired

protected void assertPolicyIfRequired()

strict モードがオンの場合は、暗号化ポリシーが指定されていることをアサートします。

getAbsorbConditionalErrorsOnRetry

public Boolean getAbsorbConditionalErrorsOnRetry()

要求の再試行時に条件付きエラーを吸収するかどうかを示します。 再試行の既定値での条件付きエラーの吸収の詳細については、「」を参照してください setAbsorbConditionalErrorsOnRetry(final Boolean absorbConditionalErrorsOnRetry)。

Returns:

absorbConditionalErrorsOnRetry

getCommitWriteOnInputStreamException

public boolean getCommitWriteOnInputStreamException()

からの読み取りと を使用する場合の例外処理の動作を定義する 。 ストリームから例外の時点まで読み取られたデータがフラッシュされ、そのデータで新しい BLOB がコミットされる場合。 それ以外の場合、アップロードは中止され、データはコミットされません。

既定値の詳細については、「」を参照してください setCommitWriteOnInputStreamException(boolean commitWriteOnInputStreamException)。

Returns:

true 例外時にデータがコミットされる場合。それ以外の場合は false。

getConcurrentRequestCount

public Integer getConcurrentRequestCount()

操作ごとの同時要求の同時実行数を取得します。 同時要求数の既定値の詳細については、「」を参照してください setConcurrentRequestCount(final Integer concurrentRequestCount)。

Returns:

concurrentRequestCount

getCustomerProvidedKey

public BlobCustomerProvidedKey getCustomerProvidedKey()

この要求に使用する顧客指定のキーを取得します。

Returns:

現在の BlobCustomerProvidedKey 顧客が指定したキーを表す オブジェクト。

getDisableContentMD5Validation

public Boolean getDisableContentMD5Validation()

ダウンロードと BlobInputStream メソッドが BLOB の ContentMD5 ヘッダーを無視するかどうかを取得します。 コンテンツ MD5 検証の既定値を無効にする方法の詳細については、次を参照してください。 setDisableContentMD5Validation(final Boolean disableContentMD5Validation)

Returns:

disableContentMD5Validation

getEncryptionPolicy

public BlobEncryptionPolicy getEncryptionPolicy()

この要求に使用する暗号化ポリシーを取得します。 暗号化ポリシーの既定値の詳細については、「」を参照してください setEncryptionPolicy(BlobEncryptionPolicy encryptionPolicy)。

Returns:

現在の BlobEncryptionPolicy 暗号化ポリシーを表す オブジェクト。

getSingleBlobPutThresholdInBytes

public Integer getSingleBlobPutThresholdInBytes()

1 つの BLOB の書き込みに使用されるしきい値サイズを取得します。 しきい値サイズの既定値の詳細については、「」を参照してください setSingleBlobPutThresholdInBytes(final Integer singleBlobPutThresholdInBytes)。

Returns:

1 つの BLOB としてアップロードできる BLOB の最大サイズ (バイト単位)。 BLOB サイズがしきい値を超える場合は、ブロックとしてアップロードされます。

getSkipEtagLocking

public boolean getSkipEtagLocking()

警告: BLOB のダウンロードで etag ロックが自動的に使用され、BLOB がダウンロード途中で変更されないようにします。 この検証は自己責任でスキップしてください。

BLOB ダウンロードの etag ロックと検証をスキップするかどうかを取得します。

Returns:

true スキップが有効な場合は 。それ以外の場合は false。

getStoreBlobContentMD5

public Boolean getStoreBlobContentMD5()

アップロード時に BLOB の ContentMD5 ヘッダーを設定する必要があるかどうかを取得します。 このフィールドは、ページ BLOB ではサポートされていません。 BLOB コンテンツ MD5 の既定値の格納の詳細については、次を参照してください。 setStoreBlobContentMD5(final Boolean storeBlobContentMD5)

Returns:

storeBlobContentMD5

getUseTransactionalContentMD5

public Boolean getUseTransactionalContentMD5()

範囲 PUT または GET 操作で Content-MD5 ヘッダーを使用してトランザクション セキュリティを適用するかどうかを取得します。 BLOB の部分的なアップロードまたはダウンロードはすべて 4 MB に制限されます。 トランザクション コンテンツ MD5 の既定値の詳細については、「」を参照してください setUseTransactionalContentMD5(final Boolean useTransactionalContentMD5)。

Returns:

useTransactionalContentMD5

getValidateEncryptionPolicy

protected boolean getValidateEncryptionPolicy()

コピー要求のソースで使用する顧客指定のキーを取得します。

Returns:

BlobCustomerProvidedKeyソースの顧客が指定したキーを表す オブジェクト。 暗号化ポリシーの存在を検証する必要があるかどうかを示す 値を取得します。

populateAndApplyDefaults

protected static final BlobRequestOptions populateAndApplyDefaults(final BlobRequestOptions options, final BlobType blobType, final CloudBlobClient client)

の場合は、指定したクライアントからの同時要求数を使用して、それ以外のすべてに既定値を設定し、親クラスで定義されている既定値を設定します。

Parameters:

options - 既定値を適用するときにコピーする入力オプション
blobType - 現在の操作の BlobType
client - 既定のCloudBlobClientタイムアウト間隔と再試行ポリシーを設定するために使用されるサービス クライアントを表す オブジェクト (の場合)。null さらに、 の既定値 concurrentRequestCount は です 1。

populateAndApplyDefaults

protected static final BlobRequestOptions populateAndApplyDefaults(final BlobRequestOptions options, final BlobType blobType, final CloudBlobClient client, final boolean setStartTime)

の場合は、指定したクライアントからの同時要求数を使用して、それ以外のすべてに既定値を設定し、親クラスで定義されている既定値を設定します。

Parameters:

options - 既定値を適用するときにコピーする入力オプション
blobType - 現在の操作の BlobType
client - 既定のCloudBlobClientタイムアウト間隔と再試行ポリシーを設定するために使用されるサービス クライアントを表す オブジェクト (の場合)。null さらに、 の既定値 concurrentRequestCount は です 1。
setStartTime - startTimeInMs フィールドを初期化するかどうか

setAbsorbConditionalErrorsOnRetry

public void setAbsorbConditionalErrorsOnRetry(final Boolean absorbConditionalErrorsOnRetry)

要求の再試行時に条件付きエラーを吸収するかどうかを設定します。 このオプションは、upload メソッドと openWrite メソッドでのみ使用 CloudAppendBlob されます。 既定では、 は に設定されています。 これは、単一ライター シナリオの場合にのみ に設定します。

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

Parameters:

absorbConditionalErrorsOnRetry - 設定する absorbConditionalErrorsOnRetry

setCommitWriteOnInputStreamException

public void setCommitWriteOnInputStreamException(boolean commitWriteOnInputStreamException)

からの読み取りと を使用する場合の例外処理の動作を定義する 。 ストリームから例外の時点まで読み取られたデータがフラッシュされ、そのデータで新しい BLOB がコミットされる場合。 それ以外の場合、アップロードは中止され、データはコミットされません。

既定値は［<すべて>］です。

Parameters:

commitWriteOnInputStreamException - データが例外時にコミットされる場合は を使用します。それ以外の場合falseは を使用trueします。

setConcurrentRequestCount

public void setConcurrentRequestCount(final Integer concurrentRequestCount)

操作ごとの同時要求の同時実行数を設定します。

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

Parameters:

concurrentRequestCount - 設定する concurrentRequestCount

setCustomerProvidedKey

public void setCustomerProvidedKey(BlobCustomerProvidedKey key)

この要求に使用する BlobCustomerProvidedKey オブジェクトを設定します。 顧客が提供するキー暗号化は、BLOB ストレージへのほとんどのアップロード、ダウンロード、コピー要求、およびプロパティとメタデータのフェッチでサポートされています。

Parameters:

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

setDisableContentMD5Validation

public void setDisableContentMD5Validation(final Boolean disableContentMD5Validation)

ダウンロードと BlobInputStream メソッドで BLOB の ContentMD5 ヘッダーを無視するかどうかを設定します。

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

Parameters:

disableContentMD5Validation - 設定する disableContentMD5Validation

setEncryptionPolicy

public void setEncryptionPolicy(BlobEncryptionPolicy encryptionPolicy)

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

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

Parameters:

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

setSingleBlobPutThresholdInBytes

public void setSingleBlobPutThresholdInBytes(final Integer singleBlobPutThresholdInBytes)

使用する 1 つの BLOB の書き込みに使用するしきい値サイズを設定します。

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

Parameters:

singleBlobPutThresholdInBytes - 1 つの BLOB としてアップロードできる BLOB の最大サイズ (バイト単位)。 BLOB サイズがしきい値を超える場合は、ブロックとしてアップロードされます。

Throws:

IllegalArgumentException - が 1 MB 未満または 64 MB を超える場合 minimumReadSize 。

setSkipEtagLocking

public void setSkipEtagLocking(boolean skipEtagLocking)

警告: BLOB のダウンロードで etag ロックが自動的に使用され、BLOB がダウンロード途中で変更されないようにします。 この検証は自己責任でスキップしてください。

BLOB ダウンロードの etag ロックと検証をスキップするかどうかを設定します。

Parameters:

skipEtagLocking - etag のロックと検証をスキップする場合は を使用 true します。それ以外の場合 falseは 。

setStoreBlobContentMD5

public void setStoreBlobContentMD5(final Boolean storeBlobContentMD5)

アップロード時に BLOB の ContentMD5 ヘッダーを設定するかどうかを設定します。 このフィールドは、ページ BLOB ではサポートされていません。

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

Parameters:

storeBlobContentMD5 - 設定する storeBlobContentMD5

setUseTransactionalContentMD5

public void setUseTransactionalContentMD5(final Boolean useTransactionalContentMD5)

範囲 PUT または GET 操作で Content-MD5 ヘッダーを使用してトランザクション セキュリティを適用するかどうかを設定します。 BLOB の部分的なアップロードまたはダウンロードはすべて 4 MB に制限されます。

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

Parameters:

useTransactionalContentMD5 - 設定する useTransactionalContentMD5

setValidateEncryptionPolicy

protected void setValidateEncryptionPolicy(boolean validateEncryptionPolicy)

ソース BLOB に使用する BlobCustomerProvidedKey オブジェクトを設定します。 お客様が提供するキー暗号化は、BLOB ストレージへのほとんどのアップロード、ダウンロード、コピー要求、およびプロパティとメタデータのフェッチでサポートされています。

Parameters:

validateEncryptionPolicy - 検証を要求する場合は を使用します。それ以外の場合は falseを使用trueします。

適用対象