submarine-master/submarine-commons/commons-runtime/src/main/java/org/apache/submarine/commons/runtime/api/JobState.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.submarine.commons.runtime.api;

/**
 * State of training job
 */
public enum JobState {
  /**
   * Job accepted by scheduler and start running
   */
  RUNNING,

  /**
   * Job killed by user
   */
  KILLED,

  /**
   * Job failed
   */
  FAILED,

  /**
   * Job succeeded
   */
  SUCCEEDED,

  /**
   * Job paused by user
   */
  PAUSED;

  public static boolean isFinal(JobState state) {
    return state == KILLED || state == SUCCEEDED || state == FAILED;
  }
}
