Class ListCommand

shell/src/main/java/alluxio/cli/job/command/ListCommand.java:34–86

Lists the job ids in the history.

 * Lists the job ids in the history.
 */
@ThreadSafe
@PublicApi
public final class ListCommand extends AbstractFileSystemCommand {
  private static final Logger LOG = LoggerFactory.getLogger(ListCommand.class);

  /**
   * Creates the job list command.
   *
   * @param fsContext the Alluxio filesystem client
   */
  public ListCommand(FileSystemContext fsContext) {
    super(fsContext);
  }

  @Override
  public String getCommandName() {
    return "ls";
  }

  @Override
  public void validateArgs(CommandLine cl) throws InvalidArgumentException {
    CommandUtils.checkNumOfArgsEquals(this, cl, 0);
  }

  @Override
  public int run(CommandLine cl) {
    try (CloseableResource<JobMasterClient> client = JobContext
        .create(mFsContext.getClusterConf(), mFsContext.getClientContext().getUserState())
        .acquireMasterClientResource()) {
      List<JobInfo> jobInfos = client.get().listDetailed();
      for (JobInfo jobInfo : jobInfos) {
        System.out.println(String.format("%-15s %-10s %-10s", jobInfo.getId(), jobInfo.getName(),
            jobInfo.getStatus()));
      }
    } catch (Exception e) {
      LOG.error("Failed to list the jobs ", e);
      System.out.println("Failed to list the jobs");
      return -1;
    }
    return 0;
  }

  @Override
  public String getUsage() {
    return "ls";
  }

  @Override
  public String getDescription() {
    return "Prints the IDs of the most recent jobs, running and finished,"
        + " in the history up to the capacity set in alluxio.job.master.job.capacity";
  }
}