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

@InterfaceAudience.Public
@InterfaceStability.Stable
public interface QueueInfo

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, ClientRMProtocol.getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)

Method Summary

List<ApplicationReport>	getApplications() Get the running applications of the queue.
float	getCapacity() Get the configured capacity of the queue.
List<QueueInfo>	getChildQueues() Get the child queues of the queue.
float	getCurrentCapacity() Get the current capacity of the queue.
float	getMaximumCapacity() Get the maximum capacity of the queue.
String	getQueueName() Get the name of the queue.
QueueState	getQueueState() Get the QueueState of the queue.

Method Detail

getQueueName

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

Get the name of the queue.

Returns:

name of the queue

getCapacity

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

Get the configured capacity of the queue.

Returns:

configured capacity of the queue

getMaximumCapacity

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

Get the maximum capacity of the queue.

Returns:

maximum capacity of the queue

getCurrentCapacity

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

Get the current capacity of the queue.

Returns:

current capacity of the queue

getChildQueues

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

Get the child queues of the queue.

Returns:

child queues of the queue

getApplications

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

Get the running applications of the queue.

Returns:

running applications of the queue

getQueueState

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

Get the QueueState of the queue.

Returns:

QueueState of the queue