alluxio.client

Enum ReadType

java.lang.Object

java.lang.Enum<ReadType>

alluxio.client.ReadType

All Implemented Interfaces:

Serializable, Comparable<ReadType>

@PublicApi
 @ThreadSafe
public enum ReadType
extends Enum<ReadType>

Convenience modes for commonly used read types. For finer grained control over data storage, advanced users may specify AlluxioStorageType and UnderStorageType.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CACHE Read the file and cache it in the highest tier of a local worker.
CACHE_PROMOTE Read the file and cache it in a local worker.
NO_CACHE Read the file and skip Alluxio storage.

Method Summary

Modifier and Type	Method and Description
static ReadType	fromProto(ReadPType readPType)
static ReadType	fromString(String text) Creates an instance type from the string.
AlluxioStorageType	getAlluxioStorageType()
int	getValue()
boolean	isCache()
boolean	isPromote()
ReadPType	toProto()
static ReadType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReadType[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_CACHE

public static final ReadType NO_CACHE

Read the file and skip Alluxio storage. This read type will not cause any data migration or eviction in Alluxio storage.

CACHE

public static final ReadType CACHE

Read the file and cache it in the highest tier of a local worker. This read type will not move data between tiers of Alluxio Storage. Users should use CACHE_PROMOTE for more optimized performance with tiered storage.

CACHE_PROMOTE

public static final ReadType CACHE_PROMOTE

Read the file and cache it in a local worker. Additionally, if the file was in Alluxio storage, it will be promoted to the top storage layer.

Method Detail

values

public static ReadType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReadType c : ReadType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ReadType 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

getAlluxioStorageType

public AlluxioStorageType getAlluxioStorageType()

Returns:

the AlluxioStorageType associated with this read type

getValue

public int getValue()

Returns:

the read type value

isCache

public boolean isCache()

Returns:

true if the read type is CACHE, false otherwise

isPromote

public boolean isPromote()

Returns:

true if the read type is CACHE_PROMOTE, false otherwise

fromProto

public static ReadType fromProto(ReadPType readPType)

Parameters:

readPType - proto type

Returns:

wire type for given proto type

toProto

public ReadPType toProto()

Returns:

proto representation of this instance

fromString

public static ReadType fromString(String text)

Creates an instance type from the string. This method is case insensitive.

Parameters:

text - the instance type in string

Returns:

the created instance