你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

BlobRequestOptions 类

  • 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()

断言如果启用严格模式,则指定加密策略。

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()

获取用于写入单个 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)

设置是否应在请求重试尝试时吸收条件故障。 此选项仅在 CloudAppendBlob upload 和 openWrite 方法中使用。 默认情况下,它设置为 。 仅针对单个编写器方案将此项设置为 。

可以通过设置此属性更改此请求的 absorbConditionalErrorsOnRetry 值。 还可以更改 对象上的 getDefaultRequestOptions() 值,以便通过服务客户端发出的所有后续请求都将使用该 absorbConditionalErrorsOnRetry 值。

void setCommitWriteOnInputStreamException(boolean commitWriteOnInputStreamException)

一个 ,它定义从 和使用 读取时处理异常的行为。 如果已从流中读取到异常点的数据将被刷新,并将使用该数据提交新的 Blob。 否则,上传将中止,并且不会提交任何数据。

默认值为“00 - 不存在任何授权信息” 。

void setConcurrentRequestCount(final Integer concurrentRequestCount)

设置每个操作的并发请求数。

默认并发请求计数在客户端中设置,默认为 1,表示不并发。 可以通过设置此属性更改此请求的并发请求计数。 还可以更改 对象上的 getDefaultRequestOptions() 值,以便通过服务客户端发出的所有后续请求都将使用该并发请求计数。

void setCustomerProvidedKey(BlobCustomerProvidedKey key)

设置要用于此请求的 BlobCustomerProvidedKey 对象。 大多数向 Blob 存储上传、下载和复制请求以及提取属性和元数据时,都支持客户提供的密钥加密。

void setDisableContentMD5Validation(final Boolean disableContentMD5Validation)

设置下载 和 BlobInputStream 方法是否应忽略 Blob 的 ContentMD5 标头。

默认 disableContentMD5Validation 值在客户端中设置,默认情况下为 。 可以通过设置此属性更改此请求的 disableContentMD5Validation 值。 还可以更改 对象上的 getDefaultRequestOptions() 值,以便通过服务客户端发出的所有后续请求都将使用该 disableContentMD5Validation 值。

void setEncryptionPolicy(BlobEncryptionPolicy encryptionPolicy)

设置要用于此请求的 BlobEncryptionPolicy 对象。

默认的 BlobEncryptionPolicy 在客户端中设置,默认为 null,表示没有加密。 可以通过设置此属性更改此请求上的 BlobEncryptionPolicy。 还可以更改 对象上的 getDefaultRequestOptions() 值,以便通过服务客户端发出的所有后续请求都将使用该 BlobEncryptionPolicy。

void setSingleBlobPutThresholdInBytes(final Integer singleBlobPutThresholdInBytes)

设置用于编写要使用的单个 Blob 的阈值大小。

默认阈值大小在客户端中设置,默认为 32MB。 可以通过设置此属性来更改此请求的阈值大小。 还可以更改 对象上的值, 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 存储上传、下载和复制请求以及提取属性和元数据时,都支持客户提供的密钥加密。

继承成员

构造函数详细信息

BlobRequestOptions

public BlobRequestOptions()

创建 类的实例。

BlobRequestOptions

public BlobRequestOptions(final BlobRequestOptions other)

通过从另一个实例复制值来创建 类的实例。

参数:

other - 一个 BlobRequestOptions 对象,表示要复制的 Blob 请求选项。

方法详细信息

applyDefaults

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

将默认值应用于传入的选项。

参数:

modifiedOptions - 要应用的选项默认为 。
blobtype

assertNoEncryptionPolicyOrStrictMode

protected void assertNoEncryptionPolicyOrStrictMode()

断言如果验证处于打开状态,则不指定加密策略。

assertPolicyIfRequired

protected void assertPolicyIfRequired()

断言如果启用严格模式,则指定加密策略。

getAbsorbConditionalErrorsOnRetry

public Boolean getAbsorbConditionalErrorsOnRetry()

指示是否应在请求的重试尝试时消除条件故障。 有关在重试默认值上吸收持续错误的详细信息,请参阅 setAbsorbConditionalErrorsOnRetry(final Boolean absorbConditionalErrorsOnRetry)

返回:

absorbConditionalErrorsOnRetry

getCommitWriteOnInputStreamException

public boolean getCommitWriteOnInputStreamException()

一个 ,它定义从 和使用 读取时处理异常的行为。 如果已从流中读取到异常点的数据将被刷新,并将使用该数据提交新的 Blob。 否则,上传将中止,并且不会提交任何数据。

有关默认值的详细信息,请参阅 setCommitWriteOnInputStreamException(boolean commitWriteOnInputStreamException)

返回:

true 如果发生异常时将提交数据,则为 ;否则为 false

getConcurrentRequestCount

public Integer getConcurrentRequestCount()

获取每个操作同时请求的并发数。 有关并发请求计数默认值的详细信息,请参阅 setConcurrentRequestCount(final Integer concurrentRequestCount)

返回:

concurrentRequestCount

getCustomerProvidedKey

public BlobCustomerProvidedKey getCustomerProvidedKey()

获取要用于此请求的客户提供的密钥。

返回:

一个 BlobCustomerProvidedKey 表示当前客户提供的密钥的 对象。

getDisableContentMD5Validation

public Boolean getDisableContentMD5Validation()

获取下载和 BlobInputStream 方法是否应忽略 Blob 的 ContentMD5 标头。 有关禁用内容 MD5 验证默认值的详细信息,请参阅 setDisableContentMD5Validation(final Boolean disableContentMD5Validation)

返回:

disableContentMD5Validation

getEncryptionPolicy

public BlobEncryptionPolicy getEncryptionPolicy()

获取要用于此请求的加密策略。 有关加密策略默认值的详细信息,请参阅 setEncryptionPolicy(BlobEncryptionPolicy encryptionPolicy)

返回:

一个 BlobEncryptionPolicy 表示当前加密策略的 对象。

getSingleBlobPutThresholdInBytes

public Integer getSingleBlobPutThresholdInBytes()

获取用于写入单个 Blob 的阈值大小。 有关阈值默认值的详细信息,请参阅 setSingleBlobPutThresholdInBytes(final Integer singleBlobPutThresholdInBytes)

返回:

可以作为单个 Blob 上传的 Blob 的最大大小(以字节为单位),范围为 1 到 64 MB(含)。 如果 Blob 大小高于阈值,则会将其作为块上传。

getSkipEtagLocking

public boolean getSkipEtagLocking()

警告:在 Blob 下载中自动使用 etag 锁定,以确保 Blob 在下载时不会更改。 跳过此验证,风险自担。

获取是否应跳过 Blob 下载上的 etag 锁定和验证。

返回:

true 如果启用跳过,则为 ;否则为 false

getStoreBlobContentMD5

public Boolean getStoreBlobContentMD5()

获取是否应在上传时设置 Blob 的 ContentMD5 标头。 页 Blob 不支持此字段。 有关存储 Blob 内容 MD5 默认值的详细信息,请参阅 setStoreBlobContentMD5(final Boolean storeBlobContentMD5)

返回:

storeBlobContentMD5

getUseTransactionalContentMD5

public Boolean getUseTransactionalContentMD5()

获取范围 PUT 或 GET 操作是否将使用 Content-MD5 标头来强制实施事务安全性。 所有部分 Blob 上传或下载将限制为 4 MB。 有关事务性内容 MD5 默认值的详细信息,请参阅 setUseTransactionalContentMD5(final Boolean useTransactionalContentMD5)

返回:

useTransactionalContentMD5

getValidateEncryptionPolicy

protected boolean getValidateEncryptionPolicy()

获取客户提供的密钥,用于复制请求的源。

返回:

一个 BlobCustomerProvidedKey 对象,表示源的客户提供的密钥。 获取一个值,该值指示是否应验证加密策略的存在。

populateAndApplyDefaults

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

如果 ,则使用来自指定客户端的并发请求计数,为其他所有内容设置默认值,并按父类中的定义设置默认值。

参数:

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)

如果 ,则使用来自指定客户端的并发请求计数,为其他所有内容设置默认值,并按父类中的定义设置默认值。

参数:

options - 应用默认值时要从中复制的输入选项
blobType - 当前操作的 BlobType
client - 一个 CloudBlobClient 对象,表示用于设置默认超时间隔和重试策略的服务客户端(如果为 null)。 此外, 的 concurrentRequestCount 默认值为 1
setStartTime - 是否初始化 startTimeInMs 字段

setAbsorbConditionalErrorsOnRetry

public void setAbsorbConditionalErrorsOnRetry(final Boolean absorbConditionalErrorsOnRetry)

设置是否应在请求重试尝试时吸收条件故障。 此选项仅在 CloudAppendBlob upload 和 openWrite 方法中使用。 默认情况下,它设置为 。 仅针对单个编写器方案将此项设置为 。

可以通过设置此属性更改此请求的 absorbConditionalErrorsOnRetry 值。 还可以更改 对象上的 getDefaultRequestOptions() 值,以便通过服务客户端发出的所有后续请求都将使用该 absorbConditionalErrorsOnRetry 值。

参数:

absorbConditionalErrorsOnRetry - 要设置的 absorbConditionalErrorsOnRetry

setCommitWriteOnInputStreamException

public void setCommitWriteOnInputStreamException(boolean commitWriteOnInputStreamException)

一个 ,它定义从 和使用 读取时处理异常的行为。 如果已从流中读取到异常点的数据将被刷新,并将使用该数据提交新的 Blob。 否则,上传将中止,并且不会提交任何数据。

默认值为“00 - 不存在任何授权信息” 。

参数:

commitWriteOnInputStreamException - 如果在发生异常时将提交数据,则使用 true ;否则为 false

setConcurrentRequestCount

public void setConcurrentRequestCount(final Integer concurrentRequestCount)

设置每个操作的并发请求数。

默认并发请求计数在客户端中设置,默认为 1,表示不并发。 可以通过设置此属性更改此请求的并发请求计数。 还可以更改 对象上的 getDefaultRequestOptions() 值,以便通过服务客户端发出的所有后续请求都将使用该并发请求计数。

参数:

concurrentRequestCount - 要设置的 concurrentRequestCount

setCustomerProvidedKey

public void setCustomerProvidedKey(BlobCustomerProvidedKey key)

设置要用于此请求的 BlobCustomerProvidedKey 对象。 大多数向 Blob 存储上传、下载和复制请求以及提取属性和元数据时,都支持客户提供的密钥加密。

参数:

key - 发出服务请求时要使用的 BlobCustomerProvidedKey 对象。

setDisableContentMD5Validation

public void setDisableContentMD5Validation(final Boolean disableContentMD5Validation)

设置下载 和 BlobInputStream 方法是否应忽略 Blob 的 ContentMD5 标头。

默认 disableContentMD5Validation 值在客户端中设置,默认情况下为 。 可以通过设置此属性更改此请求的 disableContentMD5Validation 值。 还可以更改 对象上的 getDefaultRequestOptions() 值,以便通过服务客户端发出的所有后续请求都将使用该 disableContentMD5Validation 值。

参数:

disableContentMD5Validation - 要设置的 disableContentMD5Validation

setEncryptionPolicy

public void setEncryptionPolicy(BlobEncryptionPolicy encryptionPolicy)

设置要用于此请求的 BlobEncryptionPolicy 对象。

默认的 BlobEncryptionPolicy 在客户端中设置,默认为 null,表示没有加密。 可以通过设置此属性更改此请求上的 BlobEncryptionPolicy。 还可以更改 对象上的 getDefaultRequestOptions() 值,以便通过服务客户端发出的所有后续请求都将使用该 BlobEncryptionPolicy。

参数:

encryptionPolicy - 发出服务请求时要使用的 BlobEncryptionPolicy 对象。

setSingleBlobPutThresholdInBytes

public void setSingleBlobPutThresholdInBytes(final Integer singleBlobPutThresholdInBytes)

设置用于编写要使用的单个 Blob 的阈值大小。

默认阈值大小在客户端中设置,默认为 32MB。 可以通过设置此属性来更改此请求的阈值大小。 还可以更改 对象上的值, getDefaultRequestOptions() 以便通过服务客户端发出的所有后续请求都将使用该阈值大小。

参数:

singleBlobPutThresholdInBytes - 可以作为单个 Blob 上传的 Blob 的最大大小(以字节为单位),范围为 1 MB 到 64 MB(含)。 如果 Blob 大小高于阈值,则会将其作为块上传。

引发:

IllegalArgumentException - 如果 minimumReadSize 小于 1 MB 或大于 64 MB。

setSkipEtagLocking

public void setSkipEtagLocking(boolean skipEtagLocking)

警告:在 Blob 下载中自动使用 etag 锁定,以确保 Blob 在下载时不会更改。 跳过此验证,风险自担。

设置是否应跳过 Blob 下载的 etag 锁定和验证。

参数:

skipEtagLocking - 使用 true 跳过 etag 锁定和验证;否则为 false

setStoreBlobContentMD5

public void setStoreBlobContentMD5(final Boolean storeBlobContentMD5)

设置是否应在上传时设置 Blob 的 ContentMD5 标头。 页 Blob 不支持此字段。

默认 storeBlobContentMD5 值在客户端中设置,默认为块 Blob。 可以通过设置此属性更改此请求的 storeBlobContentMD5 值。 还可以更改 对象上的值, getDefaultRequestOptions() 以便通过服务客户端发出的所有后续请求都将使用该 storeBlobContentMD5 值。

参数:

storeBlobContentMD5 - 要设置的 storeBlobContentMD5

setUseTransactionalContentMD5

public void setUseTransactionalContentMD5(final Boolean useTransactionalContentMD5)

设置范围 PUT 或 GET 操作是使用 Content-MD5 标头来强制实施事务安全性。 所有部分 Blob 上传或下载将限制为 4 MB。

默认的 useTransactionalContentMD5 值在客户端中设置,默认情况下为 。 可以通过设置此属性更改此请求的 useTransactionalContentMD5 值。 还可以更改 对象上的值, getDefaultRequestOptions() 以便通过服务客户端发出的所有后续请求都将使用使用TransactionalContentMD5 值。

参数:

useTransactionalContentMD5 - 要设置的 useTransactionalContentMD5

setValidateEncryptionPolicy

protected void setValidateEncryptionPolicy(boolean validateEncryptionPolicy)

设置要用于源 Blob 的 BlobCustomerProvidedKey 对象。 大多数向 Blob 存储上传、下载和复制请求以及提取属性和元数据时,都支持客户提供的密钥加密。

参数:

validateEncryptionPolicy - 使用 true 要求验证;否则为 false

适用于