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 * <p>
027 * <code>QueueACL</code> enumerates the various ACLs for queues.
028 * </p>
029 * 
030 * <p>
031 * The ACL is one of:
032 * <ul>
033 * <li>{@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the
034 * queue.</li>
035 * <li>{@link #ADMINISTER_QUEUE} - ACL to administer the queue.</li>
036 * </ul>
037 * </p>
038 * 
039 * @see QueueInfo
040 * @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)
041 */
042@Public
043@Stable
044public enum QueueACL {
045  /**
046   * ACL to submit applications to the queue.
047   */
048  SUBMIT_APPLICATIONS,
049  
050  /**
051   * ACL to administer the queue.
052   */
053  ADMINISTER_QUEUE,
054}