Uses of Class
alluxio.annotation.PublicApi

Packages that use PublicApi

Package	Description
alluxio
alluxio.cli
alluxio.cli.docgen
alluxio.cli.fs.command
alluxio.cli.fsadmin.command
alluxio.cli.job.command
alluxio.client
alluxio.client.block
alluxio.client.block.policy
alluxio.client.block.policy.options
alluxio.client.file
alluxio.client.file.options
alluxio.conf
alluxio.security.authorization
alluxio.security.group
alluxio.underfs
alluxio.underfs.options
alluxio.wire
alluxio.worker.block.allocator
alluxio.worker.block.annotator
alluxio.worker.block.evictor	Set of evictors for evicting or moving blocks to other locations.
alluxio.worker.block.reviewer

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.
class	ClientContext A ClientContext contains information required and pertaining to making network connections and performing operations with remote Alluxio processes.

Uses of PublicApi in alluxio.cli

Classes in alluxio.cli with annotations of type PublicApi

Modifier and Type	Class and Description
class	GetConf Utility for printing Alluxio configuration.
class	LogLevel Sets or gets the log level for the specified server.
class	ValidateConf Validate the Alluxio configuration.
class	Version The version of the current build.

Uses of PublicApi in alluxio.cli.docgen

Classes in alluxio.cli.docgen with annotations of type PublicApi

Modifier and Type	Class and Description
class	ConfigurationDocGenerator CSV_FILE_DIR utility to generate property keys to csv files.
class	MetricsDocGenerator Generates metric key information in docs.

Uses of PublicApi in alluxio.cli.fs.command

Classes in alluxio.cli.fs.command with annotations of type PublicApi

Modifier and Type	Class and Description
class	CatCommand Prints the file's contents to the console.
class	CheckConsistencyCommand Command for checking the consistency of a file or folder between Alluxio and the under storage.
class	ChecksumCommand Calculates the MD5 checksum for a file.
class	ChgrpCommand Changes the group of a file or directory specified by args.
class	ChmodCommand Changes the permission of a file or directory specified by args.
class	ChownCommand Changes the owner of a file or directory specified by args.
class	CopyFromLocalCommand Copies the specified file specified by "source path" to the path specified by "remote path".
class	CopyToLocalCommand Copies a file or a directory from the Alluxio filesystem to the local filesystem.
class	CountCommand Displays the number of folders and files matching the specified prefix in args.
class	CpCommand Copies a file or a directory in the Alluxio filesystem.
class	DistributedCpCommand Copies a file or directory specified by args.
class	DistributedLoadCommand Loads a file or directory in Alluxio space, makes it resident in memory.
class	DuCommand Displays the size of a file or a directory specified by argv.
class	FileSystemCommandUtils Common util methods for executing commands.
class	FreeCommand Frees the given file or folder from Alluxio storage (recursively freeing all children if a folder).
class	GetCapacityBytesCommand Gets the capacity of the FileSystem.
class	GetFaclCommand Displays ACL info of a path.
class	GetSyncPathListCommand This class represents a getSyncPathList Command.
class	GetUsedBytesCommand Gets number of bytes used in the FileSystem.
class	HeadCommand Prints the file's first n bytes (by default, 1KB) to the console.
class	HelpCommand Command for print help message for the given command.
class	LeaderCommand Deprecated. This command will be deprecated as of v3.0, use MasterInfoCommand
class	LoadCommand Loads a file or directory in Alluxio space, making it resident in Alluxio.
class	LoadMetadataCommand Loads metadata about a path in the UFS to Alluxio.
class	LocationCommand Displays a list of hosts that have the file specified in args stored.
class	LsCommand Displays information for the path specified in args.
class	MasterInfoCommand Prints information regarding master fault tolerance such as leader address, list of master addresses, and the configured Zookeeper address.
class	MkdirCommand Creates a new directory specified by the path in args, including any parent folders that are required.
class	MountCommand Mounts a UFS path onto an Alluxio path.
class	MvCommand Renames a file or directory specified by args.
class	PersistCommand Persists files or directories currently stored only in Alluxio to the UnderFileSystem.
class	PinCommand Pins the given file or folder (recursively pinning all children if a folder).
class	RmCommand Removes the file specified by argv.
class	SetFaclCommand Displays ACL info of a path.
class	SetReplicationCommand Changes the replication level of a file or directory specified by args.
class	SetTtlCommand Sets a new TTL value for the file at path both of the TTL value and the path are specified by args.
class	StartSyncCommand Start a polling sync of a particular path.
class	StatCommand Displays the path's info.
class	StopSyncCommand This class represents a stop sync command.
class	TailCommand Prints the file's last n bytes (by default, 1KB) to the console.
class	TouchCommand Creates a 0 byte file specified by argv.
class	UnmountCommand Unmounts an Alluxio path.
class	UnpinCommand Unpins the given file or folder (recursively unpinning all children if a folder).
class	UnsetTtlCommand Unsets the TTL value for the given path.
class	UpdateMountCommand Update options for an Alluxio mount point.

Uses of PublicApi in alluxio.cli.fsadmin.command

Classes in alluxio.cli.fsadmin.command with annotations of type PublicApi

Modifier and Type	Class and Description
class	BackupCommand Command for backing up Alluxio master metadata.
class	DoctorCommand Shows errors or warnings that users should pay attention to.
class	GetBlockInfoCommand Command for getting information from a block id.
class	JournalCommand Command for seeing/managing quorum state of embedded journal.
class	MetricsCommand Command for managing Alluxio metric system.
class	PathConfCommand Manages path level configuration.
class	ReportCommand Reports Alluxio running cluster information.
class	UfsCommand Update attributes for an existing mount point.
class	UpdateConfCommand Update config for an existing service.

Uses of PublicApi in alluxio.cli.job.command

Classes in alluxio.cli.job.command with annotations of type PublicApi

Modifier and Type	Class and Description
class	CancelCommand Cancels a job asynchronously.
class	LeaderCommand Prints the current leader master host name.
class	ListCommand Lists the job ids in the history.
class	StatCommand Displays the status of the job.

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	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	AlluxioFileInStream An implementation of FileInStream for data stored in Alluxio.
class	FileOutStream An abstraction of the output stream API in Alluxio to write data to a file or a block.
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	OutStreamOptions Method options for writing a file.

Uses of PublicApi in alluxio.conf

Classes in alluxio.conf with annotations of type PublicApi

Modifier and Type	Interface and Description
interface	AlluxioConfiguration Alluxio configuration.
class	PropertyKey Configuration property keys.
class	Source The source of a configuration property.

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

Classes in alluxio.underfs with annotations of type PublicApi

Modifier and Type	Interface and Description
interface	UnderFileSystem Alluxio stores data into an under layer file system.
class	UnderFileSystemConfiguration Ufs configuration properties, including ufs specific configuration and global configuration.
interface	UnderFileSystemFactory Interface for under file system factories.

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	BlockLocationInfo The file block with location information.
class	CommandType Types for file system commands.
class	FileBlockInfo The file block information.
class	LoadMetadataType Types for loading metadata.
class	MountPointInfo The mount point information.
class	SyncPointInfo This class represents the state of a sync point, whether the intial syncing is done, in progress or not going to be done.
class	TieredIdentity Class representing a node's tier identity.
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.annotator

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

Modifier and Type	Interface and Description
interface	BlockAnnotator<T extends BlockSortedField> Interface for providers that annotates blocks for sorting.
interface	BlockSortedField Used by BlockAnnotator implementations to embed sorted-fields per blocks.

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.

Uses of PublicApi in alluxio.worker.block.reviewer

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

Modifier and Type	Interface and Description
interface	Reviewer (Experimental) The API is subject to change in the future.