001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.apache.hadoop.yarn.api.records;
020
021import org.apache.hadoop.classification.InterfaceAudience.Public;
022import org.apache.hadoop.classification.InterfaceStability.Stable;
023import org.apache.hadoop.yarn.api.ApplicationClientProtocol;
024
025/**
026 * State of a Queue.
027 * <p>
028 * A queue is in one of:
029 * <ul>
030 *   <li>{@link #RUNNING} - normal state.</li>
031 *   <li>{@link #STOPPED} - not accepting new application submissions.</li>
032 * </ul>
033 * 
034 * @see QueueInfo
035 * @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)
036 */
037@Public
038@Stable
039public enum QueueState {
040  /**
041   * Stopped - Not accepting submissions of new applications.
042   */
043  STOPPED,
044  
045  /**
046   * Running - normal operation.
047   */
048  RUNNING
049}