GetQueueInfoResponse (Apache Hadoop YARN API 3.5.0 API)
Description: declaration: package: org.apache.hadoop.yarn.api.protocolrecords, class: GetQueueInfoResponse

Package org.apache.hadoop.yarn.api.protocolrecords

# Class GetQueueInfoResponse

java.lang.Object
org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse

@Public @Stable public abstract class GetQueueInfoResponse extends Object
The response sent by the `ResourceManager` to a client requesting information about queues in the system.

The response includes a `QueueInfo` which has details such as queue name, used/total capacities, running applications, child queues etc.

See Also:
  - `QueueInfo`
  - `ApplicationClientProtocol.getQueueInfo(GetQueueInfoRequest)`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `GetQueueInfoResponse()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `abstract QueueInfo`
  `getQueueInfo()`
  Get the `QueueInfo` for the specified queue.
  `static GetQueueInfoResponse`
  `newInstance(QueueInfo queueInfo)`
  `abstract void`
  `setQueueInfo(QueueInfo queueInfo)`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### GetQueueInfoResponse

    public GetQueueInfoResponse()

- ## Method Details

  - ### newInstance

    @Private @Unstable public static GetQueueInfoResponse newInstance(QueueInfo queueInfo)

  - ### getQueueInfo

    @Public @Stable public abstract QueueInfo getQueueInfo()
    Get the `QueueInfo` for the specified queue.
    Returns:
      `QueueInfo` for the specified queue

  - ### setQueueInfo

    @Private @Unstable public abstract void setQueueInfo(QueueInfo queueInfo)