org.apache.hadoop.yarn.api.records

Class QueueInfo

java.lang.Object

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:

• Queue name.
• Capacity of the queue.
• Maximum capacity of the queue.
• Current capacity of the queue.
• Child queues.
• Running applications.
• QueueState of the queue.

See Also:

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

Constructor Summary

Constructors

Constructor and Description
QueueInfo()

Method Summary

Methods

Modifier and Type	Method and Description
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	getQueueLabel()
abstract String	getQueueLabelPolicy()
abstract String	getQueueName() Get the name of the queue.
abstract QueueState	getQueueState() Get the QueueState of the queue.
static QueueInfo	newInstance(String queueName, float capacity, float maximumCapacity, float currentCapacity, List<QueueInfo> childQueues, List<ApplicationReport> applications, QueueState queueState)
static QueueInfo	newInstance(String queueName, float capacity, float maximumCapacity, float currentCapacity, List<QueueInfo> childQueues, List<ApplicationReport> applications, QueueState queueState, String label, String labelPolicy)
abstract void	setApplications(List<ApplicationReport> applications)
abstract void	setCapacity(float capacity)
abstract void	setChildQueues(List<QueueInfo> childQueues)
abstract void	setCurrentCapacity(float currentCapacity)
abstract void	setMaximumCapacity(float maximumCapacity)
abstract void	setQueueLabel(String queueLabel)
abstract void	setQueueLabelPolicy(String queueLabelPolicy)
abstract void	setQueueName(String queueName)
abstract void	setQueueState(QueueState queueState)

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

newInstance

@InterfaceAudience.Private
@InterfaceStability.Unstable
public static QueueInfo newInstance(String queueName,
                                                                          float capacity,
                                                                          float maximumCapacity,
                                                                          float currentCapacity,
                                                                          List<QueueInfo> childQueues,
                                                                          List<ApplicationReport> applications,
                                                                          QueueState queueState)

newInstance

@InterfaceAudience.Private
@InterfaceStability.Unstable
public static QueueInfo newInstance(String queueName,
                                                                          float capacity,
                                                                          float maximumCapacity,
                                                                          float currentCapacity,
                                                                          List<QueueInfo> childQueues,
                                                                          List<ApplicationReport> applications,
                                                                          QueueState queueState,
                                                                          String label,
                                                                          String labelPolicy)

getQueueName

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract String getQueueName()

Get the name of the queue.

Returns:

name of the queue

setQueueName

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setQueueName(String queueName)

getCapacity

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract float getCapacity()

Get the configured capacity of the queue.

Returns:

configured capacity of the queue

setCapacity

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setCapacity(float capacity)

getMaximumCapacity

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract float getMaximumCapacity()

Get the maximum capacity of the queue.

Returns:

maximum capacity of the queue

setMaximumCapacity

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setMaximumCapacity(float maximumCapacity)

getCurrentCapacity

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract float getCurrentCapacity()

Get the current capacity of the queue.

Returns:

current capacity of the queue

setCurrentCapacity

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setCurrentCapacity(float currentCapacity)

getChildQueues

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract List<QueueInfo> getChildQueues()

Get the child queues of the queue.

Returns:

child queues of the queue

setChildQueues

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setChildQueues(List<QueueInfo> childQueues)

getApplications

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract List<ApplicationReport> getApplications()

Get the running applications of the queue.

Returns:

running applications of the queue

setApplications

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setApplications(List<ApplicationReport> applications)

getQueueState

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract QueueState getQueueState()

Get the QueueState of the queue.

Returns:

QueueState of the queue

setQueueState

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setQueueState(QueueState queueState)

getQueueLabel

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract String getQueueLabel()

setQueueLabel

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setQueueLabel(String queueLabel)

getQueueLabelPolicy

@InterfaceAudience.Public
@InterfaceStability.Unstable
public abstract String getQueueLabelPolicy()

setQueueLabelPolicy

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setQueueLabelPolicy(String queueLabelPolicy)