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.
• QueueConfigurations of the queue.

See Also:

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

Constructor Summary

Constructors

Constructor and Description
QueueInfo()

Method Summary

Modifier and Type	Method and Description
abstract Set<String>	getAccessibleNodeLabels() Get the accessible node labels of the queue.
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 String	getDefaultNodeLabelExpression() Get the default node label expression of the queue, this takes affect only when the ApplicationSubmissionContext and ResourceRequest don't specify their NodeLabelExpression.
abstract Boolean	getIntraQueuePreemptionDisabled() Get the intra-queue preemption status of the queue.
abstract float	getMaximumCapacity() Get the maximum capacity of the queue.
abstract int	getMaxParallelApps() Get the configured max parallel apps of the queue.
abstract long	getMaxResourceMemory() Get the maximum resource Memory.
abstract int	getMaxResourceVCore() Get the maximum resource VCore.
abstract int	getMaxRunningApp() Get the MaxRunningApp.
abstract long	getMinResourceMemory() Get the minimum resource Memory.
abstract int	getMinResourceVCore() Get the minimum resource VCore.
abstract Boolean	getPreemptionDisabled() Get the preemption status of the queue.
abstract Map<String,org.apache.hadoop.yarn.api.records.QueueConfigurations>	getQueueConfigurations() Get the per-node-label queue configurations of the queue.
abstract String	getQueueName() Get the name of the queue.
abstract String	getQueuePath() Get the path of the queue.
abstract QueueState	getQueueState() Get the QueueState of the queue.
abstract QueueStatistics	getQueueStatistics() Get the queue stats for the queue
abstract long	getReservedResourceMemory() Get the reserved resource Memory.
abstract int	getReservedResourceVCore() Get the reserved resource VCore.
abstract String	getSchedulerType() Get Scheduler type.
abstract long	getSteadyFairShareMemory() Get the SteadyFairShare Memory.
abstract int	getSteadyFairShareVCore() Get the SteadyFairShare VCore.
abstract String	getSubClusterId() Get the SubClusterId.
abstract float	getWeight() Get the configured weight of the queue.
abstract void	setDefaultNodeLabelExpression(String defaultLabelExpression)
abstract void	setQueueStatistics(QueueStatistics queueStatistics) Set the queue statistics for 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

getQueuePath

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

Get the path of the queue.

Returns:

path 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

getWeight

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

Get the configured weight of the queue.

Returns:

configured weight of the queue

getMaxParallelApps

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract int getMaxParallelApps()

Get the configured max parallel apps of the queue.

Returns:

configured max parallel apps 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

getAccessibleNodeLabels

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract Set<String> getAccessibleNodeLabels()

Get the accessible node labels of the queue.

Returns:

accessible node labels of the queue

getDefaultNodeLabelExpression

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

Get the default node label expression of the queue, this takes affect only when the ApplicationSubmissionContext and ResourceRequest don't specify their NodeLabelExpression.

Returns:

default node label expression of the queue

setDefaultNodeLabelExpression

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract void setDefaultNodeLabelExpression(String defaultLabelExpression)

getQueueStatistics

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract QueueStatistics getQueueStatistics()

Get the queue stats for the queue

Returns:

queue stats of the queue

setQueueStatistics

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract void setQueueStatistics(QueueStatistics queueStatistics)

Set the queue statistics for the queue

Parameters:

queueStatistics - the queue statistics

getPreemptionDisabled

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract Boolean getPreemptionDisabled()

Get the preemption status of the queue.

Returns:

if property is not in proto, return null; otherwise, return preemption status of the queue

getQueueConfigurations

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract Map<String,org.apache.hadoop.yarn.api.records.QueueConfigurations> getQueueConfigurations()

Get the per-node-label queue configurations of the queue.

Returns:

the per-node-label queue configurations of the queue.

getIntraQueuePreemptionDisabled

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract Boolean getIntraQueuePreemptionDisabled()

Get the intra-queue preemption status of the queue.

Returns:

if property is not in proto, return null; otherwise, return intra-queue preemption status of the queue

getSchedulerType

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

Get Scheduler type.

Returns:

SchedulerType.

getMinResourceVCore

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract int getMinResourceVCore()

Get the minimum resource VCore.

Returns:

minimum resource VCore.

getMinResourceMemory

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract long getMinResourceMemory()

Get the minimum resource Memory.

Returns:

minimum resource Memory.

getMaxResourceVCore

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract int getMaxResourceVCore()

Get the maximum resource VCore.

Returns:

maximum resource VCore.

getMaxResourceMemory

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract long getMaxResourceMemory()

Get the maximum resource Memory.

Returns:

maximum resource Memory.

getReservedResourceVCore

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract int getReservedResourceVCore()

Get the reserved resource VCore.

Returns:

reserved resource VCore.

getReservedResourceMemory

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract long getReservedResourceMemory()

Get the reserved resource Memory.

Returns:

reserved resource Memory.

getSteadyFairShareVCore

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract int getSteadyFairShareVCore()

Get the SteadyFairShare VCore.

Returns:

SteadyFairShare VCore.

getSteadyFairShareMemory

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract long getSteadyFairShareMemory()

Get the SteadyFairShare Memory.

Returns:

SteadyFairShare Memory.

getSubClusterId

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

Get the SubClusterId.

Returns:

the SubClusterId.

getMaxRunningApp

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract int getMaxRunningApp()

Get the MaxRunningApp.

Returns:

The number of MaxRunningApp.