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