org.apache.hadoop.yarn.api.records
Class QueueInfo

java.lang.Object
  extended by org.apache.hadoop.yarn.api.records.QueueInfo

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract class QueueInfo
extends Object

QueueInfo is a report of the runtime information of the queue.

It includes information such as:

See Also:
QueueState, ApplicationClientProtocol.getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)

Constructor Summary
QueueInfo()
           
 
Method Summary
abstract  List<ApplicationReport> getApplications()
          Get the running applications of the queue.
abstract  float getCapacity()
          Get the configured capacity of the queue.
abstract  List<QueueInfo> getChildQueues()
          Get the child queues of the queue.
abstract  float getCurrentCapacity()
          Get the current capacity of the queue.
abstract  float getMaximumCapacity()
          Get the maximum capacity of the queue.
abstract  String getQueueName()
          Get the name of the queue.
abstract  QueueState getQueueState()
          Get the QueueState of the queue.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QueueInfo

public QueueInfo()
Method Detail

getQueueName

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract String getQueueName()
Get the name of the queue.

Returns:
name of the queue

getCapacity

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract float getCapacity()
Get the configured capacity of the queue.

Returns:
configured capacity of the queue

getMaximumCapacity

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract float getMaximumCapacity()
Get the maximum capacity of the queue.

Returns:
maximum capacity of the queue

getCurrentCapacity

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract float getCurrentCapacity()
Get the current capacity of the queue.

Returns:
current capacity of the queue

getChildQueues

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract List<QueueInfo> getChildQueues()
Get the child queues of the queue.

Returns:
child queues of the queue

getApplications

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract List<ApplicationReport> getApplications()
Get the running applications of the queue.

Returns:
running applications of the queue

getQueueState

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract QueueState getQueueState()
Get the QueueState of the queue.

Returns:
QueueState of the queue


Copyright © 2013 Apache Software Foundation. All Rights Reserved.