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.protocolrecords;
020
021import org.apache.hadoop.classification.InterfaceAudience.Private;
022import org.apache.hadoop.classification.InterfaceAudience.Public;
023import org.apache.hadoop.classification.InterfaceStability.Stable;
024import org.apache.hadoop.classification.InterfaceStability.Unstable;
025import org.apache.hadoop.yarn.api.ApplicationClientProtocol;
026import org.apache.hadoop.yarn.api.records.QueueInfo;
027import org.apache.hadoop.yarn.util.Records;
028
029/**
030 * <p>The response sent by the <code>ResourceManager</code> to a client
031 * requesting information about queues in the system.</p>
032 *
033 * <p>The response includes a {@link QueueInfo} which has details such as
034 * queue name, used/total capacities, running applications, child queues etc
035 * .</p>
036 * 
037 * @see QueueInfo
038 * @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)
039 */
040@Public
041@Stable
042public abstract class GetQueueInfoResponse {
043
044  @Private
045  @Unstable
046  public static GetQueueInfoResponse newInstance(QueueInfo queueInfo) {
047    GetQueueInfoResponse response = Records.newRecord(GetQueueInfoResponse.class);
048    response.setQueueInfo(queueInfo);
049    return response;
050  }
051
052  /**
053   * Get the <code>QueueInfo</code> for the specified queue.
054   * @return <code>QueueInfo</code> for the specified queue
055   */
056  @Public
057  @Stable
058  public abstract QueueInfo getQueueInfo();
059  
060  @Private
061  @Unstable
062  public abstract void setQueueInfo(QueueInfo queueInfo);
063}