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

Class QueryFederationQueuePoliciesRequest

java.lang.Object

org.apache.hadoop.yarn.server.api.protocolrecords.QueryFederationQueuePoliciesRequest

@Private
@Unstable
public abstract class QueryFederationQueuePoliciesRequest
extends Object

Request for querying Federation Queue Policies. It includes several query conditions such as queue, queues, pageSize, and currentPage. queue: The specific queue name or identifier to query the Federation Queue Policy for. queues: A list of queue names or identifiers for which to query the Federation Queue Policies. pageSize: The number of policies to display per page. currentPage: The current page number.

Constructor Summary

Constructors

Constructor	Description
QueryFederationQueuePoliciesRequest()

Method Summary

Modifier and Type	Method	Description
abstract int	getCurrentPage()	Returns the current page number in the FederationQueuePolicies pagination.
abstract int	getPageSize()	Retrieves the page size.
abstract String	getQueue()	Retrieves the queue.
abstract List<String>	getQueues()	Retrieves a list of queues.
static QueryFederationQueuePoliciesRequest	newInstance(int pageSize, int currentPage, String queue, List<String> queues)
abstract void	setCurrentPage(int currentPage)	Sets the current page in the FederationQueuePolicies pagination.
abstract void	setPageSize(int pageSize)	Sets the page size for FederationQueuePolicies pagination.
abstract void	setQueue(String queue)	Sets the queue to the specified value.
abstract void	setQueues(List<String> queues)	Sets the list of queues to the specified values.

Methods inherited from class java.lang.Object

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

Constructor Details

QueryFederationQueuePoliciesRequest

public QueryFederationQueuePoliciesRequest()

Method Details

newInstance

@Private
@Unstable
public static QueryFederationQueuePoliciesRequest newInstance(int pageSize,
 int currentPage,
 String queue,
 List<String> queues)

setPageSize

@Private
@Unstable
public abstract void setPageSize(int pageSize)

Sets the page size for FederationQueuePolicies pagination.

Parameters:

pageSize - The number of policies to display per page.

getPageSize

@Public
@Unstable
public abstract int getPageSize()

Retrieves the page size.

Returns:

The number of policies to display per page.

setCurrentPage

@Private
@Unstable
public abstract void setCurrentPage(int currentPage)

Sets the current page in the FederationQueuePolicies pagination.

Parameters:

currentPage - The current page number.

getCurrentPage

@Public
@Unstable
public abstract int getCurrentPage()

Returns the current page number in the FederationQueuePolicies pagination.

Returns:

The current page number.

getQueue

@Public
@Unstable
public abstract String getQueue()

Retrieves the queue.

Returns:

The name or identifier of the current queue.

setQueue

@Private
@Unstable
public abstract void setQueue(String queue)

Sets the queue to the specified value. We will use the fully qualified name matching for queues. For example, if the user inputs 'a', we will match queues that contain 'a' in their fully qualified names, such as 'root.a', 'root.b.a', and so on.

Parameters:

queue - queue name.

getQueues

@Public
@Unstable
public abstract List<String> getQueues()

Retrieves a list of queues. This part contains exact matches, which will match the queues contained in the list.

Returns:

A list of queue names or identifiers.

setQueues

@Private
@Unstable
public abstract void setQueues(List<String> queues)

Sets the list of queues to the specified values.

Parameters:

queues - A list of queue names or identifiers to set.