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    
019    package org.apache.hadoop.yarn.api.records;
020    
021    import org.apache.hadoop.classification.InterfaceAudience.Public;
022    import org.apache.hadoop.classification.InterfaceStability.Stable;
023    import org.apache.hadoop.yarn.api.ClientRMProtocol;
024    
025    /**
026     * <p>State of a Queue.</p>
027     * 
028     * <p>A queue is one of:
029     *   <ul>
030     *     <li>{@link #RUNNING} - normal state.</li> 
031     *     <li>{@link #STOPPED} - not accepting new application submissions.
032     *   </ul>
033     * </p>
034     * 
035     * @see QueueInfo
036     * @see ClientRMProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)
037     */
038    @Public
039    @Stable
040    public enum QueueState {
041      /**
042       * Stopped - Not accepting submissions of new applications.
043       */
044      STOPPED,
045      
046      /**
047       * Running - normal operation.
048       */
049      RUNNING
050    }