@InterfaceAudience.Public @InterfaceStability.Stable public abstract class GetApplicationsRequest extends Object
The request from clients to get a report of Applications
in the cluster from the ResourceManager.
ApplicationBaseProtocol.getApplications(GetApplicationsRequest)| Constructor and Description |
|---|
GetApplicationsRequest() |
| Modifier and Type | Method and Description |
|---|---|
abstract EnumSet<YarnApplicationState> |
getApplicationStates()
Get the application states to filter applications on
|
abstract Set<String> |
getApplicationTypes()
Get the application types to filter applications on
|
static GetApplicationsRequest |
newInstance() |
static GetApplicationsRequest |
newInstance(ApplicationsRequestScope scope)
The request from clients to get a report of Applications matching the
giving application types in the cluster from the
ResourceManager. |
static GetApplicationsRequest |
newInstance(ApplicationsRequestScope scope,
Set<String> users,
Set<String> queues,
Set<String> applicationTypes,
Set<String> applicationTags,
EnumSet<YarnApplicationState> applicationStates,
org.apache.commons.lang3.Range<Long> startRange,
org.apache.commons.lang3.Range<Long> finishRange,
Long limit)
The request from clients to get a report of Applications matching the
giving application types in the cluster from the
ResourceManager. |
static GetApplicationsRequest |
newInstance(EnumSet<YarnApplicationState> applicationStates)
The request from clients to get a report of Applications matching the
giving application states in the cluster from the
ResourceManager. |
static GetApplicationsRequest |
newInstance(Set<String> applicationTypes)
The request from clients to get a report of Applications matching the
giving application types in the cluster from the
ResourceManager. |
static GetApplicationsRequest |
newInstance(Set<String> applicationTypes,
EnumSet<YarnApplicationState> applicationStates)
The request from clients to get a report of Applications matching the
giving and application types and application types in the cluster from the
ResourceManager. |
@InterfaceAudience.Public @InterfaceStability.Stable public static GetApplicationsRequest newInstance()
@InterfaceAudience.Public @InterfaceStability.Stable public static GetApplicationsRequest newInstance(ApplicationsRequestScope scope, Set<String> users, Set<String> queues, Set<String> applicationTypes, Set<String> applicationTags, EnumSet<YarnApplicationState> applicationStates, org.apache.commons.lang3.Range<Long> startRange, org.apache.commons.lang3.Range<Long> finishRange, Long limit)
The request from clients to get a report of Applications matching the
giving application types in the cluster from the
ResourceManager.
scope - ApplicationsRequestScope to filter byusers - list of users to filter byqueues - list of scheduler queues to filter byapplicationTypes - types of applicationsapplicationTags - application tags to filter byapplicationStates - application states to filter bystartRange - range of application start times to filter byfinishRange - range of application finish times to filter bylimit - number of applications to limit toGetApplicationsRequest to be used with
ApplicationBaseProtocol.getApplications(GetApplicationsRequest)Setting any of the parameters to null, would just disable that
filter
@InterfaceAudience.Public @InterfaceStability.Stable public static GetApplicationsRequest newInstance(ApplicationsRequestScope scope)
The request from clients to get a report of Applications matching the
giving application types in the cluster from the
ResourceManager.
scope - ApplicationsRequestScope to filter byGetApplicationsRequestApplicationBaseProtocol.getApplications(GetApplicationsRequest)@InterfaceAudience.Public @InterfaceStability.Stable public static GetApplicationsRequest newInstance(Set<String> applicationTypes)
The request from clients to get a report of Applications matching the
giving application types in the cluster from the
ResourceManager.
GetApplicationsRequestApplicationBaseProtocol.getApplications(GetApplicationsRequest)@InterfaceAudience.Public @InterfaceStability.Stable public static GetApplicationsRequest newInstance(EnumSet<YarnApplicationState> applicationStates)
The request from clients to get a report of Applications matching the
giving application states in the cluster from the
ResourceManager.
GetApplicationsRequestApplicationBaseProtocol.getApplications(GetApplicationsRequest)@InterfaceAudience.Public @InterfaceStability.Stable public static GetApplicationsRequest newInstance(Set<String> applicationTypes, EnumSet<YarnApplicationState> applicationStates)
The request from clients to get a report of Applications matching the
giving and application types and application types in the cluster from the
ResourceManager.
GetApplicationsRequestApplicationBaseProtocol.getApplications(GetApplicationsRequest)@InterfaceAudience.Public @InterfaceStability.Stable public abstract Set<String> getApplicationTypes()
@InterfaceAudience.Public @InterfaceStability.Stable public abstract EnumSet<YarnApplicationState> getApplicationStates()
Copyright © 2023 Apache Software Foundation. All rights reserved.