AbstractDistributedJobCommand (Alluxio Shell 300 API)

java.lang.Object
- alluxio.cli.fs.command.AbstractFileSystemCommand
- - alluxio.cli.fs.command.AbstractDistributedJobCommand

All Implemented Interfaces:

alluxio.cli.Command, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

DistributedCpCommand, DistributedLoadCommand, DistributedMvCommand
```
public abstract class AbstractDistributedJobCommand
extends AbstractFileSystemCommand
```
The base class for all the distributed job based Command classes. It provides handling for submitting multiple jobs and handling retries of them.

Field Summary

Fields
Modifier and Type	Field	Description
`protected static org.apache.commons.cli.Option`	`ASYNC_OPTION`
`protected static int`	`DEFAULT_ACTIVE_JOBS`
`protected int`	`mActiveJobs`
`protected alluxio.client.job.JobMasterClient`	`mClient`
`protected java.util.List<JobAttempt>`	`mSubmittedJobAttempts`

Fields inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand
mFileSystem, mFsContext

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractDistributedJobCommand(alluxio.client.file.FileSystemContext fsContext)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`drain()`
`int`	`getCompletedCmdCount()`	Gets the number of completed commands.
`int`	`getCompletedCount()`	Gets the number of completed jobs.
`int`	`getFailedCmdCount()`	Gets the number of failed commands.
`int`	`getFailedCount()`	Gets the number of failed jobs.
`java.util.Set<java.lang.String>`	`getFailedFiles()`	Gets failed files.
`void`	`postProcessing(long jobControlId)`	Do post-processing on the command information, including printing file paths and statistics.
`protected void`	`processFailures(java.lang.String arg, java.util.Set<java.lang.String> failures, java.lang.String logFileLocation)`
`protected long`	`submit(alluxio.job.CmdConfig cmdConfig)`
`void`	`waitForCmd(long jobControlId)`	Waits for command to complete.
`protected void`	`waitJob()`	Waits for at least one job to complete.

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
close, getCommandName, getDescription, getOptions, getSubCommands, getUsage, hasSubCommand, parseAndValidateArgs, run, validateArgs

Field Detail

DEFAULT_ACTIVE_JOBS
```
protected static final int DEFAULT_ACTIVE_JOBS
```
See Also:

Constant Field Values

ASYNC_OPTION

protected static final org.apache.commons.cli.Option ASYNC_OPTION

mSubmittedJobAttempts

protected java.util.List<JobAttempt> mSubmittedJobAttempts

mActiveJobs
```
protected int mActiveJobs
```

mClient

protected final alluxio.client.job.JobMasterClient mClient

Constructor Detail

AbstractDistributedJobCommand

protected AbstractDistributedJobCommand(alluxio.client.file.FileSystemContext fsContext)

Method Detail
- drain
```
protected void drain()
```
- submit
```
protected long submit(alluxio.job.CmdConfig cmdConfig)
```
- waitJob
```
protected void waitJob()
```
  Waits for at least one job to complete.
- waitForCmd
```
public void waitForCmd(long jobControlId)
```
  Waits for command to complete.
  
  Parameters:
  
  jobControlId -
- postProcessing
```
public void postProcessing(long jobControlId)
```
  Do post-processing on the command information, including printing file paths and statistics.
  
  Parameters:
  
  jobControlId -
- processFailures
```
protected void processFailures(java.lang.String arg,
                               java.util.Set<java.lang.String> failures,
                               java.lang.String logFileLocation)
```
- getCompletedCount
```
public int getCompletedCount()
```
  Gets the number of completed jobs.
  
  Returns:
  
  the number of completed job
- getFailedCount
```
public int getFailedCount()
```
  Gets the number of failed jobs.
  
  Returns:
  
  number of failed jobs
- getFailedCmdCount
```
public int getFailedCmdCount()
```
  Gets the number of failed commands.
  
  Returns:
  
  number of failed commands
- getCompletedCmdCount
```
public int getCompletedCmdCount()
```
  Gets the number of completed commands.
  
  Returns:
  
  the number of completed commands
- getFailedFiles
```
public java.util.Set<java.lang.String> getFailedFiles()
```
  Gets failed files.
  
  Returns:
  
  failed files