com.microsoft.azure.storage.table

Class TableRequestOptions

java.lang.Object

com.microsoft.azure.storage.RequestOptions

com.microsoft.azure.storage.table.TableRequestOptions

public class TableRequestOptions
extends RequestOptions

Represents a set of timeout, payload format, and retry policy options that may be specified for a table operation request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TableRequestOptions.EncryptionResolver The interface whose function is used to get the value indicating whether a property should be encrypted or not given the partition key, row key, and the property name.
static interface	TableRequestOptions.PropertyResolver The interface whose function is used to get the for an entity property given the partition key, row, key, and the property name, if the interface is implemented

Constructor Summary

Constructors

Constructor and Description
TableRequestOptions() Creates an instance of the TableRequestOptions
TableRequestOptions(TableRequestOptions other) Creates an instance of the RequestOptions class by copying values from another TableRequestOptions instance.

Method Summary

Modifier and Type	Method and Description
protected static void	applyDefaults(TableRequestOptions modifiedOptions) Applies defaults to the options passed in.
protected void	assertNoEncryptionPolicyOrStrictMode() Assert that if validation is on, an encryption policy is not specified.
protected void	assertPolicyIfRequired() Assert that if strict mode is on, an encryption policy is specified.
protected void	clearEncryption() Clears the encryption properties on this TableRequestOptions object.
Boolean	getDateBackwardCompatibility() Gets whether the client should look to correct Date values stored on a TableEntity that may have been written using versions of this library prior to 2.0.0, see setDateBackwardCompatibility(Boolean).
TableEncryptionPolicy	getEncryptionPolicy() Gets the encryption policy to use for this request.
TableRequestOptions.EncryptionResolver	getEncryptionResolver() Gets the interface that contains a function which is used to get the value indicating whether a property should be encrypted or not given the partition key, row key, and the property name.
TableRequestOptions.PropertyResolver	getPropertyResolver() Gets the interface that contains a function which is used to get the for an entity property given the partition key, row, key, and the property name.
TablePayloadFormat	getTablePayloadFormat() Gets the TablePayloadFormat to be used.
protected static TableRequestOptions	populateAndApplyDefaults(TableRequestOptions options, CloudTableClient client) Initializes the values for this TableRequestOptions instance, if they are currently null, using the values specified in the CloudTableClient parameter.
void	setDateBackwardCompatibility(Boolean dateBackwardCompatibility) Sets whether the client should look to correct Date values stored on a TableEntity that may have been written using versions of this library prior to 2.0.0.
void	setEncryptionPolicy(TableEncryptionPolicy encryptionPolicy) Sets the TableEncryptionPolicy object to use for this request.
void	setEncryptionResolver(TableRequestOptions.EncryptionResolver encryptionResolver) Sets the interface that contains a function which is used to get the value indicating whether a property should be encrypted or not given the partition key, row key, and the property name.
void	setPropertyResolver(TableRequestOptions.PropertyResolver propertyResolver) Sets the interface that contains a function which is used to get the for an entity property given the partition key, row, key, and the property name.
void	setTablePayloadFormat(TablePayloadFormat payloadFormat) Sets the TablePayloadFormat to be used.

Methods inherited from class com.microsoft.azure.storage.RequestOptions

applyBaseDefaultsInternal, getLocationMode, getMaximumExecutionTimeInMs, getOperationExpiryTimeInMs, getRetryPolicyFactory, getTimeoutIntervalInMs, populateRequestOptions, requireEncryption, setLocationMode, setMaximumExecutionTimeInMs, setRequireEncryption, setRetryPolicyFactory, setTimeoutIntervalInMs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableRequestOptions

public TableRequestOptions()

Creates an instance of the TableRequestOptions

TableRequestOptions

public TableRequestOptions(TableRequestOptions other)

Creates an instance of the RequestOptions class by copying values from another TableRequestOptions instance.

Parameters:

other - A TableRequestOptions object that represents the request options to copy.

Method Detail

populateAndApplyDefaults

protected static final TableRequestOptions populateAndApplyDefaults(TableRequestOptions options,
                                                                    CloudTableClient client)

Initializes the values for this TableRequestOptions instance, if they are currently null, using the values specified in the CloudTableClient parameter.

Parameters:

options - A TableRequestOptions object which represents the input options to copy from when applying defaults.

client - A CloudTableClient object from which to copy the timeout and retry policy.

Returns:

A TableRequestOptions object.

clearEncryption

protected void clearEncryption()

Clears the encryption properties on this TableRequestOptions object. Useful for operations for which encryption does not make sense, such as CreateTable.

applyDefaults

protected static void applyDefaults(TableRequestOptions modifiedOptions)

Applies defaults to the options passed in.

Parameters:

modifiedOptions - The options to apply defaults to.

getTablePayloadFormat

public TablePayloadFormat getTablePayloadFormat()

Gets the TablePayloadFormat to be used. For more information about TablePayloadFormat defaults, see setTablePayloadFormat(TablePayloadFormat).

Returns:

The TablePayloadFormat used by this TableRequest.

getPropertyResolver

public TableRequestOptions.PropertyResolver getPropertyResolver()

Gets the interface that contains a function which is used to get the for an entity property given the partition key, row, key, and the property name. For more information about the TableRequestOptions.PropertyResolver defaults, see setPropertyResolver(PropertyResolver).

Returns:

The current TableRequestOptions.PropertyResolver object.

getDateBackwardCompatibility

public Boolean getDateBackwardCompatibility()

Gets whether the client should look to correct Date values stored on a TableEntity that may have been written using versions of this library prior to 2.0.0, see setDateBackwardCompatibility(Boolean).

See here for more details.

Returns:

true if dateBackwardCompatibility is enabled; otherwise, false

getEncryptionPolicy

public TableEncryptionPolicy getEncryptionPolicy()

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

Returns:

An TableEncryptionPolicy object that represents the current encryption policy.

getEncryptionResolver

public TableRequestOptions.EncryptionResolver getEncryptionResolver()

Gets the interface that contains a function which is used to get the value indicating whether a property should be encrypted or not given the partition key, row key, and the property name. For more information about the TableRequestOptions.EncryptionResolver defaults, see setEncryptionResolver(EncryptionResolver).

Returns:

The current TableRequestOptions.PropertyResolver object.

setTablePayloadFormat

public void setTablePayloadFormat(TablePayloadFormat payloadFormat)

Sets the TablePayloadFormat to be used.

The default TablePayloadFormat is set in the client and is by default TablePayloadFormat.Json. You can change the TablePayloadFormat on this request by setting this property. You can also change the value on the CloudTableClient.getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that TablePayloadFormat.

Parameters:

payloadFormat - Specifies the TablePayloadFormat to set.

setPropertyResolver

public void setPropertyResolver(TableRequestOptions.PropertyResolver propertyResolver)

Sets the interface that contains a function which is used to get the for an entity property given the partition key, row, key, and the property name.

The default TableRequestOptions.PropertyResolver is set in the client and is by default null, indicating not to use a property resolver. You can change the TableRequestOptions.PropertyResolver on this request by setting this property. You can also change the value on the CloudTableClient.getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that TableRequestOptions.PropertyResolver.

Parameters:

propertyResolver - Specifies the TableRequestOptions.PropertyResolver to set.

setDateBackwardCompatibility

public void setDateBackwardCompatibility(Boolean dateBackwardCompatibility)

Sets whether the client should look to correct Date values stored on a TableEntity that may have been written using versions of this library prior to 2.0.0.

dateBackwardCompatibility is by default false, indicating a post 2.0.0 version or mixed- platform usage. You can change the dateBackwardCompatibility on this request by setting this property. You can also change the value on the CloudTableClient.getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that dateBackwardCompatibility.

See here for more details.

Parameters:

dateBackwardCompatibility - true to enable dateBackwardCompatibility; otherwise, false

setEncryptionPolicy

public void setEncryptionPolicy(TableEncryptionPolicy encryptionPolicy)

Sets the TableEncryptionPolicy object to use for this request.

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

Parameters:

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

setEncryptionResolver

public void setEncryptionResolver(TableRequestOptions.EncryptionResolver encryptionResolver)

Sets the interface that contains a function which is used to get the value indicating whether a property should be encrypted or not given the partition key, row key, and the property name. A TableRequestOptions.EncryptionResolver is required if a TableEncryptionPolicy is specified.

You can change the TableRequestOptions.EncryptionResolver on this request by setting this property. You can also change the value on the TableServiceClient#getDefaultRequestOptions() object so that all subsequent requests made via the service client will use that TableRequestOptions.EncryptionResolver.

Parameters:

propertyResolver - Specifies the TableRequestOptions.PropertyResolver to set.

assertNoEncryptionPolicyOrStrictMode

protected void assertNoEncryptionPolicyOrStrictMode()

Assert that if validation is on, an encryption policy is not specified.

assertPolicyIfRequired

protected void assertPolicyIfRequired()

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