alluxio.cli.fs.command

Class DistributedLoadCommand

java.lang.Object

alluxio.cli.fs.command.AbstractFileSystemCommand

alluxio.cli.fs.command.AbstractDistributedJobCommand

alluxio.cli.fs.command.DistributedLoadCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

@ThreadSafe
 @PublicApi
public final class DistributedLoadCommand
extends AbstractDistributedJobCommand

Loads a file or directory in Alluxio space, makes it resident in memory.

Field Summary

Fields inherited from class alluxio.cli.fs.command.AbstractDistributedJobCommand

DEFAULT_ACTIVE_JOBS, mActiveJobs, mClient, mSubmittedJobAttempts, WAIT_OPTION

Fields inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand

mFileSystem, mFsContext

Constructor Summary

Constructors

Constructor and Description
DistributedLoadCommand(FileSystemContext fsContext) Constructs a new instance to load a file or directory in Alluxio space.

Method Summary

Modifier and Type	Method and Description
void	close() Used to close resources created by commands.
String	getCommandName() Gets the command name as input from the shell.
String	getDescription()
org.apache.commons.cli.Options	getOptions()
String	getUsage()
int	run(org.apache.commons.cli.CommandLine cl) Runs the command.
Long	runDistLoad(AlluxioURI filePath, int replication, int batchSize, Set<String> workerSet, Set<String> excludedWorkerSet, Set<String> localityIds, Set<String> excludedLocalityIds, boolean directCache) Run the actual distributedLoad command.
void	validateArgs(org.apache.commons.cli.CommandLine cl) Checks if the arguments are valid or throw InvalidArgumentException.

Methods inherited from class alluxio.cli.fs.command.AbstractDistributedJobCommand

drain, getCompletedCmdCount, getCompletedCount, getFailedCmdCount, getFailedFiles, submit, waitForCmd, waitJob

Methods inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand

processHeader, runPlainPath, runWildCardCmd

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.cli.Command

getSubCommands, hasSubCommand, parseAndValidateArgs

Constructor Detail

DistributedLoadCommand

public DistributedLoadCommand(FileSystemContext fsContext)

Constructs a new instance to load a file or directory in Alluxio space.

Parameters:

fsContext - the filesystem of Alluxio

Method Detail

getCommandName

public String getCommandName()

Description copied from interface: Command

Gets the command name as input from the shell.

Returns:

the command name

getOptions

public org.apache.commons.cli.Options getOptions()

Returns:

the supported Options of the command

validateArgs

public void validateArgs(org.apache.commons.cli.CommandLine cl)
                  throws InvalidArgumentException

Description copied from interface: Command

Checks if the arguments are valid or throw InvalidArgumentException.

Parameters:

cl - the parsed command line for the arguments

Throws:

InvalidArgumentException - when arguments are not valid

getUsage

public String getUsage()

Returns:

the usage information of the command

getDescription

public String getDescription()

Returns:

the description information of the command

run

public int run(org.apache.commons.cli.CommandLine cl)
        throws AlluxioException,
               IOException

Description copied from interface: Command

Runs the command.

Parameters:

cl - the parsed command line for the arguments

Returns:

the result of running the command

Throws:

AlluxioException

IOException

runDistLoad

public Long runDistLoad(AlluxioURI filePath,
                        int replication,
                        int batchSize,
                        Set<String> workerSet,
                        Set<String> excludedWorkerSet,
                        Set<String> localityIds,
                        Set<String> excludedLocalityIds,
                        boolean directCache)

Run the actual distributedLoad command.

Parameters:

filePath - file path to load

replication - Number of block replicas of each loaded file

batchSize - Batch size for loading

workerSet - A set of worker hosts to load data

excludedWorkerSet - A set of worker hosts can not to load data

localityIds - The locality identify set

excludedLocalityIds - A set of worker locality identify can not to load data

directCache - use direct cache request or cache through read

Returns:

job Control ID

close

public void close()
           throws IOException

Description copied from interface: Command

Used to close resources created by commands.

Throws:

IOException - if closing resources fails