org.apache.hadoop.yarn.api.protocolrecords
Interface GetQueueInfoRequest


@InterfaceAudience.Public
@InterfaceStability.Stable
public interface GetQueueInfoRequest

The request sent by clients to get queue information from the ResourceManager.

See Also:
ClientRMProtocol.getQueueInfo(GetQueueInfoRequest)

Method Summary
 boolean getIncludeApplications()
          Is information about active applications required?
 boolean getIncludeChildQueues()
          Is information about child queues required?
 String getQueueName()
          Get the queue name for which to get queue information.
 boolean getRecursive()
          Is information on the entire child queue hierarchy required?
 void setIncludeApplications(boolean includeApplications)
          Should we get fetch information about active applications?
 void setIncludeChildQueues(boolean includeChildQueues)
          Should we fetch information about child queues?
 void setQueueName(String queueName)
          Set the queue name for which to get queue information
 void setRecursive(boolean recursive)
          Should we fetch information on the entire child queue hierarchy?
 

Method Detail

getQueueName

String getQueueName()
Get the queue name for which to get queue information.

Returns:
queue name for which to get queue information

setQueueName

void setQueueName(String queueName)
Set the queue name for which to get queue information

Parameters:
queueName - queue name for which to get queue information

getIncludeApplications

boolean getIncludeApplications()
Is information about active applications required?

Returns:
true if applications' information is to be included, else false

setIncludeApplications

void setIncludeApplications(boolean includeApplications)
Should we get fetch information about active applications?

Parameters:
includeApplications - fetch information about active applications?

getIncludeChildQueues

boolean getIncludeChildQueues()
Is information about child queues required?

Returns:
true if information about child queues is required, else false

setIncludeChildQueues

void setIncludeChildQueues(boolean includeChildQueues)
Should we fetch information about child queues?

Parameters:
includeChildQueues - fetch information about child queues?

getRecursive

boolean getRecursive()
Is information on the entire child queue hierarchy required?

Returns:
true if information about entire hierarchy is required, false otherwise

setRecursive

void setRecursive(boolean recursive)
Should we fetch information on the entire child queue hierarchy?

Parameters:
recursive - fetch information on the entire child queue hierarchy?


Copyright © 2012 Apache Software Foundation. All Rights Reserved.