yarn/src/main/java/org/apache/hama/bsp/Job.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hama.bsp;

import org.apache.hadoop.yarn.exceptions.YarnException;

import java.io.IOException;

/**
 * Main interface to interact with the job. Provides only getters.
 */
public interface Job {

  public enum JobState {
    NEW, RUNNING, SUCCESS, FAILED, KILLED
  }

  public enum BSPPhase {
    COMPUTATION, COMMUNICATION
  }

  public JobState startJob() throws Exception;

  public void cleanup() throws YarnException, IOException;

  JobState getState();

  BSPPhase getBSPPhase();

  int getTotalBSPTasks();

}