Package com.azure.storage.blob.models

Enum ConsistentReadControl

java.lang.Object

java.lang.Enum<ConsistentReadControl>

com.azure.storage.blob.models.ConsistentReadControl

All Implemented Interfaces:

Serializable, Comparable<ConsistentReadControl>, java.lang.constant.Constable

public enum ConsistentReadControl
extends Enum<ConsistentReadControl>

Defines values to indicate what strategy the SDK should use when reading from a blob to ensure the view of the data is consistent and not changed during the read. NONE ETAG VERSION_ID

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ETAG	Default value.
NONE	No consistent read control.
VERSION_ID	Consistent control based on versionId.

Method Summary

Modifier and Type	Method	Description
static ConsistentReadControl	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ConsistentReadControl[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final ConsistentReadControl NONE

No consistent read control. The client will honor user provided MatchConditions.getIfMatch() and BlobClientBase.getVersionId().

ETAG

public static final ConsistentReadControl ETAG

Default value. Consistent read control based on eTag. If MatchConditions.getIfMatch() is set, the client will honor this value. Otherwise, MatchConditions.getIfMatch() is set to the latest eTag. Note: Modification of the base blob will result in an IOException or a BlobStorageException if eTag is the only form of consistent read control being employed.

VERSION_ID

public static final ConsistentReadControl VERSION_ID

Consistent control based on versionId. Note: Versioning must be supported by the account to use this value. If BlobClientBase.getVersionId() is set, the client will honor this value. Otherwise, BlobClientBase.getVersionId() is set to the latest versionId. Note: Modification of the base blob will not result in an Exception and allow you to continue reading the entirety of the appropriate version of the blob determined at the time of opening the InputStream but it may no longer be the latest data.

Method Details

values

public static ConsistentReadControl[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConsistentReadControl valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null