Uses of Class
alluxio.annotation.PublicApi

Packages that use PublicApi

Package	Description
alluxio
alluxio.client
alluxio.client.block
alluxio.client.block.policy
alluxio.client.block.policy.options
alluxio.client.file
alluxio.client.file.options
alluxio.client.file.policy
alluxio.client.keyvalue
alluxio.client.lineage
alluxio.client.lineage.options
alluxio.hadoop
alluxio.hadoop.mapreduce
alluxio.job
alluxio.security.authorization
alluxio.security.group
alluxio.underfs.options
alluxio.wire
alluxio.worker.block.allocator
alluxio.worker.block.evictor	Set of evictors for evicting or moving blocks to other locations.

Uses of PublicApi in alluxio

Classes in alluxio with annotations of type PublicApi

Modifier and Type	Class and Description
class	AlluxioURI This class represents a URI in the Alluxio system.

Uses of PublicApi in alluxio.client

Classes in alluxio.client with annotations of type PublicApi

Modifier and Type	Class and Description
class	ReadType Convenience modes for commonly used read types.
class	WriteType Write types for creating a file in Alluxio.

Uses of PublicApi in alluxio.client.block

Classes in alluxio.client.block with annotations of type PublicApi

Modifier and Type	Class and Description
class	BlockWorkerInfo Information of an active block worker.

Uses of PublicApi in alluxio.client.block.policy

Classes in alluxio.client.block.policy with annotations of type PublicApi

Modifier and Type	Interface and Description
interface	BlockLocationPolicy Interface for determining the Alluxio worker location to serve a block write or UFS block read.

Uses of PublicApi in alluxio.client.block.policy.options

Classes in alluxio.client.block.policy.options with annotations of type PublicApi

Modifier and Type	Class and Description
class	CreateOptions Method options for creating a BlockLocationPolicy.
class	GetWorkerOptions Method options for BlockLocationPolicy.getWorker(GetWorkerOptions).

Uses of PublicApi in alluxio.client.file

Classes in alluxio.client.file with annotations of type PublicApi

Modifier and Type	Class and Description
class	BaseFileSystem Default implementation of the FileSystem interface.
class	FileInStream A streaming API to read a file.
class	FileOutStream Provides a streaming API to write a file.
interface	FileSystem Basic file system interface supporting metadata operations and data operations.
class	URIStatus Wrapper around FileInfo.

Uses of PublicApi in alluxio.client.file.options

Classes in alluxio.client.file.options with annotations of type PublicApi

Modifier and Type	Class and Description
class	CreateDirectoryOptions Method options for creating a directory.
class	CreateFileOptions Method options for creating a file.
class	DeleteOptions Method options for deleting a file.
class	ExistsOptions Method options for checking the existence of a path.
class	FreeOptions Method options for freeing space.
class	GetStatusOptions Method options for getting the status of a path.
class	ListStatusOptions Method options for listing the status.
class	LoadMetadataOptions Deprecated. since version 1.1 and will be removed in version 2.0
class	MountOptions Method options for mounting a path.
class	OpenFileOptions Method options for opening a file for reading.
class	OutStreamOptions Method options for writing a file.
class	RenameOptions Method options for renaming a file or a directory.
class	SetAttributeOptions Method options for setting any number of a path's attributes.
class	UnmountOptions Method options for unmounting a path.
class	UpdateUfsModeOptions Method options for updating operation mode of a ufs path.

Uses of PublicApi in alluxio.client.file.policy

Classes in alluxio.client.file.policy with annotations of type PublicApi

Modifier and Type	Interface and Description
interface	FileWriteLocationPolicy Interface for the location policy of which workers a file's blocks are written into.

Uses of PublicApi in alluxio.client.keyvalue

Classes in alluxio.client.keyvalue with annotations of type PublicApi

Modifier and Type	Class and Description
class	BaseKeyValueSystem Default implementation of the KeyValueSystem interface.
interface	KeyValueIterable Interface to be implemented in classes that support iterating over key-value pairs.
interface	KeyValueIterator Iterator to iterate over key-value pairs in KeyValueSystem or its partitions.
interface	KeyValueStoreReader Interface for readers which accesses key-value stores in Alluxio.
interface	KeyValueStoreWriter Interface for writers which create new key-value stores in Alluxio.
interface	KeyValueSystem Client to access or create key-value stores in Alluxio.

Uses of PublicApi in alluxio.client.lineage

Classes in alluxio.client.lineage with annotations of type PublicApi

Modifier and Type	Class and Description
class	AbstractLineageClient Alluxio Lineage client.
class	AlluxioLineage A LineageClient implementation.
class	LineageFileOutStream A stream API to write a file when lineage is enabled.
class	LineageFileSystem Alluxio lineage file system client.

Uses of PublicApi in alluxio.client.lineage.options

Classes in alluxio.client.lineage.options with annotations of type PublicApi

Modifier and Type	Class and Description
class	CreateLineageOptions Method options for creating a lineage.
class	DeleteLineageOptions The method option for deleting a lineage.
class	GetLineageInfoListOptions The method option for retrieving a list of lineage information.

Uses of PublicApi in alluxio.hadoop

Classes in alluxio.hadoop with annotations of type PublicApi

Modifier and Type	Class and Description
class	FileSystem An Alluxio client API compatible with Apache Hadoop FileSystem interface.

Uses of PublicApi in alluxio.hadoop.mapreduce

Classes in alluxio.hadoop.mapreduce with annotations of type PublicApi

Modifier and Type	Class and Description
class	KeyValueInputFormat Implementation of org.apache.hadoop.mapred.InputFormat for MapReduce programs to access KeyValueSystem.
class	KeyValueOutputCommitter Extension of FileOutputCommitter where creating, completing, or deleting a KeyValueSystem in different phases of a job's or task's lifecycle is considered.
class	KeyValueOutputFormat An OutputFormat implementation to let MapReduce job write to a key-value store under the MapReduce output directory.

Uses of PublicApi in alluxio.job

Classes in alluxio.job with annotations of type PublicApi

Modifier and Type	Class and Description
class	CommandLineJob A job that wraps a programmed run by command line.
class	Job A Job that can run at Alluxio.
class	JobConf A job configuration.

Uses of PublicApi in alluxio.security.authorization

Classes in alluxio.security.authorization with annotations of type PublicApi

Modifier and Type	Class and Description
class	Mode POSIX style file/directory access mode.
static class	Mode.Bits Mode bits.

Uses of PublicApi in alluxio.security.group

Classes in alluxio.security.group with annotations of type PublicApi

Modifier and Type	Interface and Description
interface	GroupMappingService Interface for Alluxio user-to-groups mapping.

Uses of PublicApi in alluxio.underfs.options

Classes in alluxio.underfs.options with annotations of type PublicApi

Modifier and Type	Class and Description
class	CreateOptions Method options for creating a file in UnderFileSystem.
class	DeleteOptions Method options for deleting a directory in UnderFileSystem.
class	FileLocationOptions Method options for file locations in UnderFileSystem.
class	ListOptions Method options for listing a directory in UnderFileSystem.
class	MkdirsOptions Method options for mkdirs in UnderFileSystem.
class	OpenOptions Method options for file locations in UnderFileSystem.

Uses of PublicApi in alluxio.wire

Classes in alluxio.wire with annotations of type PublicApi

Modifier and Type	Class and Description
class	BlockInfo The block information.
class	BlockLocation The location of a block.
class	CommandLineJobInfo The lineage command-line job information.
class	CommonOptions Common method options.
class	FileBlockInfo The file block information.
class	JobConfInfo The lineage command-line job configuration.
class	LineageInfo The lineage information.
class	LoadMetadataType Types for loading metadata.
class	TieredIdentity Class representing a node's tier identity.
class	TtlAction Represents the file action to take when its TTL expires.
class	WorkerNetAddress The network address of a worker.

Uses of PublicApi in alluxio.worker.block.allocator

Classes in alluxio.worker.block.allocator with annotations of type PublicApi

Modifier and Type	Interface and Description
interface	Allocator Interface for the allocation policy of Alluxio managed data.

Uses of PublicApi in alluxio.worker.block.evictor

Classes in alluxio.worker.block.evictor with annotations of type PublicApi

Modifier and Type	Interface and Description
interface	Evictor Interface for the eviction policy in Alluxio.