<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /**<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT>     * or more contributor license agreements.  See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT>     * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT>     * regarding copyright ownership.  The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT>     * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT>     * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT>     * with the License.  You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT>     *<a name="line.9"></a>
<FONT color="green">010</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT>     *<a name="line.11"></a>
<FONT color="green">012</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT>     * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT>     * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT>     */<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    package org.apache.hadoop.yarn.api.protocolrecords;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    import org.apache.hadoop.classification.InterfaceAudience.Public;<a name="line.21"></a>
<FONT color="green">022</FONT>    import org.apache.hadoop.classification.InterfaceStability.Stable;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.apache.hadoop.yarn.api.ClientRMProtocol;<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>    /**<a name="line.25"></a>
<FONT color="green">026</FONT>     * &lt;p&gt;The request sent by clients to get &lt;em&gt;queue information&lt;/em&gt;<a name="line.26"></a>
<FONT color="green">027</FONT>     * from the &lt;code&gt;ResourceManager&lt;/code&gt;.&lt;/p&gt;<a name="line.27"></a>
<FONT color="green">028</FONT>     *<a name="line.28"></a>
<FONT color="green">029</FONT>     * @see ClientRMProtocol#getQueueInfo(GetQueueInfoRequest)<a name="line.29"></a>
<FONT color="green">030</FONT>     */<a name="line.30"></a>
<FONT color="green">031</FONT>    @Public<a name="line.31"></a>
<FONT color="green">032</FONT>    @Stable<a name="line.32"></a>
<FONT color="green">033</FONT>    public interface GetQueueInfoRequest {<a name="line.33"></a>
<FONT color="green">034</FONT>      /**<a name="line.34"></a>
<FONT color="green">035</FONT>       * Get the &lt;em&gt;queue name&lt;/em&gt; for which to get queue information.<a name="line.35"></a>
<FONT color="green">036</FONT>       * @return &lt;em&gt;queue name&lt;/em&gt; for which to get queue information<a name="line.36"></a>
<FONT color="green">037</FONT>       */<a name="line.37"></a>
<FONT color="green">038</FONT>      String getQueueName();<a name="line.38"></a>
<FONT color="green">039</FONT>      <a name="line.39"></a>
<FONT color="green">040</FONT>      /**<a name="line.40"></a>
<FONT color="green">041</FONT>       * Set the &lt;em&gt;queue name&lt;/em&gt; for which to get queue information<a name="line.41"></a>
<FONT color="green">042</FONT>       * @param queueName &lt;em&gt;queue name&lt;/em&gt; for which to get queue information<a name="line.42"></a>
<FONT color="green">043</FONT>       */<a name="line.43"></a>
<FONT color="green">044</FONT>      void setQueueName(String queueName);<a name="line.44"></a>
<FONT color="green">045</FONT>    <a name="line.45"></a>
<FONT color="green">046</FONT>      /**<a name="line.46"></a>
<FONT color="green">047</FONT>       * Is information about &lt;em&gt;active applications&lt;e/m&gt; required?<a name="line.47"></a>
<FONT color="green">048</FONT>       * @return &lt;code&gt;true&lt;/code&gt; if applications' information is to be included,<a name="line.48"></a>
<FONT color="green">049</FONT>       *         else &lt;code&gt;false&lt;/code&gt;<a name="line.49"></a>
<FONT color="green">050</FONT>       */<a name="line.50"></a>
<FONT color="green">051</FONT>      boolean getIncludeApplications();<a name="line.51"></a>
<FONT color="green">052</FONT>    <a name="line.52"></a>
<FONT color="green">053</FONT>      /**<a name="line.53"></a>
<FONT color="green">054</FONT>       * Should we get fetch information about &lt;em&gt;active applications&lt;/em&gt;?<a name="line.54"></a>
<FONT color="green">055</FONT>       * @param includeApplications fetch information about &lt;em&gt;active <a name="line.55"></a>
<FONT color="green">056</FONT>       *                            applications&lt;/em&gt;?<a name="line.56"></a>
<FONT color="green">057</FONT>       */<a name="line.57"></a>
<FONT color="green">058</FONT>      void setIncludeApplications(boolean includeApplications);<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>      /**<a name="line.60"></a>
<FONT color="green">061</FONT>       * Is information about &lt;em&gt;child queues&lt;/em&gt; required?<a name="line.61"></a>
<FONT color="green">062</FONT>       * @return &lt;code&gt;true&lt;/code&gt; if information about child queues is required,<a name="line.62"></a>
<FONT color="green">063</FONT>       *         else &lt;code&gt;false&lt;/code&gt;<a name="line.63"></a>
<FONT color="green">064</FONT>       */<a name="line.64"></a>
<FONT color="green">065</FONT>      boolean getIncludeChildQueues();<a name="line.65"></a>
<FONT color="green">066</FONT>      <a name="line.66"></a>
<FONT color="green">067</FONT>      /**<a name="line.67"></a>
<FONT color="green">068</FONT>       * Should we fetch information about &lt;em&gt;child queues&lt;/em&gt;?<a name="line.68"></a>
<FONT color="green">069</FONT>       * @param includeChildQueues fetch information about &lt;em&gt;child queues&lt;/em&gt;?<a name="line.69"></a>
<FONT color="green">070</FONT>       */<a name="line.70"></a>
<FONT color="green">071</FONT>      void setIncludeChildQueues(boolean includeChildQueues);<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>      /**<a name="line.73"></a>
<FONT color="green">074</FONT>       * Is information on the entire &lt;em&gt;child queue hierarchy&lt;/em&gt; required?<a name="line.74"></a>
<FONT color="green">075</FONT>       * @return &lt;code&gt;true&lt;/code&gt; if information about entire hierarchy is <a name="line.75"></a>
<FONT color="green">076</FONT>       *         required, &lt;code&gt;false&lt;/code&gt; otherwise<a name="line.76"></a>
<FONT color="green">077</FONT>       */<a name="line.77"></a>
<FONT color="green">078</FONT>      boolean getRecursive();<a name="line.78"></a>
<FONT color="green">079</FONT>      <a name="line.79"></a>
<FONT color="green">080</FONT>      /**<a name="line.80"></a>
<FONT color="green">081</FONT>       * Should we fetch information on the entire &lt;em&gt;child queue hierarchy&lt;/em&gt;?<a name="line.81"></a>
<FONT color="green">082</FONT>       * @param recursive fetch information on the entire &lt;em&gt;child queue <a name="line.82"></a>
<FONT color="green">083</FONT>       *                  hierarchy&lt;/em&gt;?<a name="line.83"></a>
<FONT color="green">084</FONT>       */<a name="line.84"></a>
<FONT color="green">085</FONT>      void setRecursive(boolean recursive);<a name="line.85"></a>
<FONT color="green">086</FONT>    }<a name="line.86"></a>
<FONT color="green">087</FONT>    <a name="line.87"></a>




























































</PRE>
</BODY>
</HTML>
