org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in org.apache.hadoop.shaded.com.liance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org.apache.hadoop.shaded.org.licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.shaded.org.apache.hadoop.yarn.api.protocolrecords;
import org.apache.hadoop.shaded.org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.shaded.org.apache.hadoop.classification.InterfaceStability.Stable;
import org.apache.hadoop.shaded.org.apache.hadoop.yarn.api.ApplicationClientProtocol;
import org.apache.hadoop.shaded.org.apache.hadoop.yarn.util.Records;
/**
* The request sent by clients to get queue information
* from the ResourceManager.
*
* @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)
*/
@Public
@Stable
public abstract class GetQueueInfoRequest {
@Public
@Stable
public static GetQueueInfoRequest
newInstance(String queueName, boolean includeApplications,
boolean includeChildQueues, boolean recursive) {
GetQueueInfoRequest request = Records.newRecord(GetQueueInfoRequest.class);
request.setQueueName(queueName);
request.setIncludeApplications(includeApplications);
request.setIncludeChildQueues(includeChildQueues);
request.setRecursive(recursive);
return request;
}
/**
* Get the queue name for which to get queue information.
* @return queue name for which to get queue information
*/
@Public
@Stable
public abstract String getQueueName();
/**
* Set the queue name for which to get queue information
* @param queueName queue name for which to get queue information
*/
@Public
@Stable
public abstract void setQueueName(String queueName);
/**
* Is information about active applications required?
* @return true if applications' information is to be included,
* else false
*/
@Public
@Stable
public abstract boolean getIncludeApplications();
/**
* Should we get fetch information about active applications?
* @param includeApplications fetch information about active
* applications?
*/
@Public
@Stable
public abstract void setIncludeApplications(boolean includeApplications);
/**
* Is information about child queues required?
* @return true if information about child queues is required,
* else false
*/
@Public
@Stable
public abstract boolean getIncludeChildQueues();
/**
* Should we fetch information about child queues?
* @param includeChildQueues fetch information about child queues?
*/
@Public
@Stable
public abstract void setIncludeChildQueues(boolean includeChildQueues);
/**
* Is information on the entire child queue hierarchy required?
* @return true if information about entire hierarchy is
* required, false otherwise
*/
@Public
@Stable
public abstract boolean getRecursive();
/**
* Should we fetch information on the entire child queue hierarchy?
* @param recursive fetch information on the entire child queue
* hierarchy?
*/
@Public
@Stable
public abstract void setRecursive(boolean recursive);
}