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

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 套接字 keep-alive。 使用 禁用 keep-alive;否则。 有关 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 对象中的值填充第一个 requestOptions 对象中的任何 null 字段。
Boolean	requireEncryption() 获取一个值，该值指示是否必须加密写入和读取的所有数据。 用于加密/解密事务的数据;否则。 有关需要加密默认值的详细信息，请参阅 setRequireEncryption(Boolean requireEncryption)。
void	setDisableHttpsSocketKeepAlive(Boolean disableHttpsSocketKeepAlive) 设置一个值以指示是否应禁用 https 套接字保持连接。 使用 禁用 keep-alive;否则 默认值在客户端中设置，默认情况下为 true，表示将禁用 https 套接字保持连接。 可以通过设置此属性来更改此请求的值。 还可以更改 对象上的 getDefaultRequestOptions() 值，以便通过服务客户端发出的所有后续请求都将使用适当的值。 在 https 套接字上设置保持活动状态是解决 JVM 中的 bug，即重试请求时不遵循连接超时。 在这些情况下，可以选择使用套接字保持活动状态作为回退。 遗憾的是，超时值必须取自 JVM 属性，而不是在本地配置。 因此，在极少数情况下，JVM 配置了极短的保持连接时间，启用 keep-alives 可能没有好处，以免它们干扰长时间运行的数据传输操作。
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 套接字 keep-alive。 使用 禁用 keep-alive;否则。 有关 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 对象中的值填充第一个 requestOptions 对象中的任何 null 字段。

Parameters:

modifiedOptions

clientOptions

setStartTime

requireEncryption

public Boolean requireEncryption()

获取一个值，该值指示是否必须加密写入和读取的所有数据。 用于加密/解密事务的数据;否则。 有关需要加密默认值的详细信息，请参阅 setRequireEncryption(Boolean requireEncryption)。

Returns:

一个 值，该值指示是否必须加密写入和读取的所有数据。

setDisableHttpsSocketKeepAlive

public void setDisableHttpsSocketKeepAlive(Boolean disableHttpsSocketKeepAlive)

设置一个值以指示是否应禁用 https 套接字保持连接。 使用 禁用 keep-alive;否则

默认值在客户端中设置，默认情况下为 true，表示将禁用 https 套接字保持连接。 可以通过设置此属性来更改此请求的值。 还可以更改 对象上的 getDefaultRequestOptions() 值，以便通过服务客户端发出的所有后续请求都将使用适当的值。

在 https 套接字上设置保持活动状态是解决 JVM 中的 bug，即重试请求时不遵循连接超时。 在这些情况下，可以选择使用套接字保持活动状态作为回退。 遗憾的是，超时值必须取自 JVM 属性，而不是在本地配置。 因此，在极少数情况下，JVM 配置了极短的保持连接时间，启用 keep-alives 可能没有好处，以免它们干扰长时间运行的数据传输操作。

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 - 要用于此请求的超时（以毫秒为单位）。