Share via

QueueRequestOptions Class

  • Reference
Package:
com.microsoft.azure.storage.queue
  • java.lang.Object
    • RequestOptions
      • com.microsoft.azure.storage.queue.QueueRequestOptions

public class QueueRequestOptions extends RequestOptions

Represents a set of options that may be specified on a queue request.

Constructor Summary

Constructor Description
QueueRequestOptions()

Initializes a new instance of the QueueRequestOptions class.

QueueRequestOptions(final QueueRequestOptions other)

Initializes a new instance of the QueueRequestOptions class as a copy of another QueueRequestOptions instance.

Method Summary

Modifier and Type Method and Description
void applyDefaults(QueueRequestOptions modifiedOptions)

Applies defaults to the options passed in.
void assertPolicyIfRequired()

Assert that if strict mode is on, an encryption policy is specified.

QueueEncryptionPolicy getEncryptionPolicy()

Gets the encryption policy to use for this request. For more information about the encryption policy defaults, see setEncryptionPolicy(QueueEncryptionPolicy encryptionPolicy).
final QueueRequestOptions populateAndApplyDefaults(QueueRequestOptions options, final CloudQueueClient client)

Populates the default timeout and retry policy from client if they are not set.
void setEncryptionPolicy(QueueEncryptionPolicy encryptionPolicy)

Sets the QueueEncryptionPolicy object to use for this request.

The default QueueEncryptionPolicy is set in the client and is by default null, indicating no encryption. You can change the QueueEncryptionPolicy on this request by setting this property. You can also change the value on the getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that QueueEncryptionPolicy.

Inherited Members

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)

Constructor Details

QueueRequestOptions

public QueueRequestOptions()

Initializes a new instance of the QueueRequestOptions class.

QueueRequestOptions

public QueueRequestOptions(final QueueRequestOptions other)

Initializes a new instance of the QueueRequestOptions class as a copy of another QueueRequestOptions instance.

Parameters:

other - The QueueRequestOptions object to copy the values from.

Method Details

applyDefaults

protected static void applyDefaults(QueueRequestOptions modifiedOptions)

Applies defaults to the options passed in.

Parameters:

modifiedOptions - The options to apply defaults to.

assertPolicyIfRequired

protected void assertPolicyIfRequired()

Assert that if strict mode is on, an encryption policy is specified.

getEncryptionPolicy

public QueueEncryptionPolicy getEncryptionPolicy()

Gets the encryption policy to use for this request. For more information about the encryption policy defaults, see setEncryptionPolicy(QueueEncryptionPolicy encryptionPolicy).

Returns:

An QueueEncryptionPolicy object that represents the current encryption policy.

populateAndApplyDefaults

protected static final QueueRequestOptions populateAndApplyDefaults(QueueRequestOptions options, final CloudQueueClient client)

Populates the default timeout and retry policy from client if they are not set.

Parameters:

options - The input options to copy from when applying defaults
client - The CloudQueueClient service client to populate the default values from.

setEncryptionPolicy

public void setEncryptionPolicy(QueueEncryptionPolicy encryptionPolicy)

Sets the QueueEncryptionPolicy object to use for this request.

The default QueueEncryptionPolicy is set in the client and is by default null, indicating no encryption. You can change the QueueEncryptionPolicy on this request by setting this property. You can also change the value on the getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that QueueEncryptionPolicy.

Parameters:

encryptionPolicy - the QueueEncryptionPolicy object to use when making service requests.

Applies to