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.protocolrecords;
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>The request sent by clients to get <em>queue information</em>
027     * from the <code>ResourceManager</code>.</p>
028     *
029     * @see ClientRMProtocol#getQueueInfo(GetQueueInfoRequest)
030     */
031    @Public
032    @Stable
033    public interface GetQueueInfoRequest {
034      /**
035       * Get the <em>queue name</em> for which to get queue information.
036       * @return <em>queue name</em> for which to get queue information
037       */
038      String getQueueName();
039      
040      /**
041       * Set the <em>queue name</em> for which to get queue information
042       * @param queueName <em>queue name</em> for which to get queue information
043       */
044      void setQueueName(String queueName);
045    
046      /**
047       * Is information about <em>active applications<e/m> required?
048       * @return <code>true</code> if applications' information is to be included,
049       *         else <code>false</code>
050       */
051      boolean getIncludeApplications();
052    
053      /**
054       * Should we get fetch information about <em>active applications</em>?
055       * @param includeApplications fetch information about <em>active 
056       *                            applications</em>?
057       */
058      void setIncludeApplications(boolean includeApplications);
059    
060      /**
061       * Is information about <em>child queues</em> required?
062       * @return <code>true</code> if information about child queues is required,
063       *         else <code>false</code>
064       */
065      boolean getIncludeChildQueues();
066      
067      /**
068       * Should we fetch information about <em>child queues</em>?
069       * @param includeChildQueues fetch information about <em>child queues</em>?
070       */
071      void setIncludeChildQueues(boolean includeChildQueues);
072    
073      /**
074       * Is information on the entire <em>child queue hierarchy</em> required?
075       * @return <code>true</code> if information about entire hierarchy is 
076       *         required, <code>false</code> otherwise
077       */
078      boolean getRecursive();
079      
080      /**
081       * Should we fetch information on the entire <em>child queue hierarchy</em>?
082       * @param recursive fetch information on the entire <em>child queue 
083       *                  hierarchy</em>?
084       */
085      void setRecursive(boolean recursive);
086    }
087