@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
.
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> |
getApplicationTags()
Get the tags to filter applications.
|
abstract Set<String> |
getApplicationTypes()
Get the application types to filter applications on
|
abstract org.apache.commons.lang3.Range<Long> |
getFinishRange()
Get the range of finish times to filter applications.
|
abstract long |
getLimit()
Get the limit on the number applications to return
|
abstract String |
getName()
Get the name to filter applications.
|
abstract Set<String> |
getQueues()
Get the queues to filter applications on
|
abstract ApplicationsRequestScope |
getScope()
Get the
ApplicationsRequestScope of applications to be filtered. |
abstract org.apache.commons.lang3.Range<Long> |
getStartRange()
Get the range of start times to filter applications on
|
abstract Set<String> |
getUsers()
Get the users 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 states in the cluster from the
ResourceManager . |
abstract void |
setApplicationStates(EnumSet<YarnApplicationState> applicationStates)
Set the application states to filter applications on
|
abstract void |
setApplicationStates(Set<String> applicationStates)
Set the application states to filter applications on
|
abstract void |
setApplicationTags(Set<String> tags)
Set the list of tags to filter applications.
|
abstract void |
setApplicationTypes(Set<String> applicationTypes)
Set the application types to filter applications on
|
abstract void |
setFinishRange(long begin,
long end)
Set the range of finish times to filter applications.
|
abstract void |
setFinishRange(org.apache.commons.lang3.Range<Long> range)
Set the range of finish times to filter applications.
|
abstract void |
setLimit(long limit)
Limit the number applications to return
|
abstract void |
setName(String name)
Set the name to filter applications.
|
abstract void |
setQueues(Set<String> queue)
Set the queue to filter applications on
|
abstract void |
setScope(ApplicationsRequestScope scope)
Set the
ApplicationsRequestScope of applications to filter. |
abstract void |
setStartRange(long begin,
long end)
Set the range of start times to filter applications.
|
abstract void |
setStartRange(org.apache.commons.lang3.Range<Long> range)
Set the range of start times to filter applications.
|
abstract void |
setUsers(Set<String> users)
Set the users to filter applications on
|
@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 byGetApplicationsRequest
ApplicationBaseProtocol.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
.
applicationTypes
- application types.GetApplicationsRequest
ApplicationBaseProtocol.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
.
applicationStates
- application states.GetApplicationsRequest
ApplicationBaseProtocol.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 states in the cluster from the
ResourceManager
.
applicationStates
- application states.applicationTypes
- application types.GetApplicationsRequest
ApplicationBaseProtocol.getApplications(GetApplicationsRequest)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract Set<String> getApplicationTypes()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setApplicationTypes(Set<String> applicationTypes)
applicationTypes
- A Set of Application Types to filter on.
If not defined, match all applications@InterfaceAudience.Public @InterfaceStability.Stable public abstract EnumSet<YarnApplicationState> getApplicationStates()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setApplicationStates(EnumSet<YarnApplicationState> applicationStates)
applicationStates
- A Set of Application states to filter on.
If not defined, match all running applications@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setApplicationStates(Set<String> applicationStates)
applicationStates
- all lower-case string representation of the
application states to filter on@InterfaceAudience.Private @InterfaceStability.Unstable public abstract Set<String> getUsers()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setUsers(Set<String> users)
users
- set of users to filter applications on@InterfaceAudience.Private @InterfaceStability.Unstable public abstract Set<String> getQueues()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setQueues(Set<String> queue)
queue
- user to filter applications on@InterfaceAudience.Private @InterfaceStability.Unstable public abstract long getLimit()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setLimit(long limit)
limit
- number of applications to limit to@InterfaceAudience.Private @InterfaceStability.Unstable public abstract org.apache.commons.lang3.Range<Long> getStartRange()
Range
of start times to filter applications on@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setStartRange(org.apache.commons.lang3.Range<Long> range)
range
- range of start times.@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setStartRange(long begin, long end) throws IllegalArgumentException
begin
- beginning of the rangeend
- end of the rangeIllegalArgumentException
- if an argument is invalid.@InterfaceAudience.Private @InterfaceStability.Unstable public abstract org.apache.commons.lang3.Range<Long> getFinishRange()
Range
of finish times to filter applications on@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setFinishRange(org.apache.commons.lang3.Range<Long> range)
range
- range of finish times.@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setFinishRange(long begin, long end)
begin
- beginning of the rangeend
- end of the rangeIllegalArgumentException
- if an argument is invalid.@InterfaceAudience.Private @InterfaceStability.Unstable public abstract Set<String> getApplicationTags()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setApplicationTags(Set<String> tags)
tags
- list of tags to filter.@InterfaceAudience.Private @InterfaceStability.Unstable public abstract ApplicationsRequestScope getScope()
ApplicationsRequestScope
of applications to be filtered.ApplicationsRequestScope
of applications to return.@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setScope(ApplicationsRequestScope scope)
ApplicationsRequestScope
of applications to filter.scope
- scope to use for filtering applications@InterfaceAudience.Private @InterfaceStability.Unstable public abstract String getName()
@InterfaceAudience.Private @InterfaceStability.Unstable public abstract void setName(String name)
name
- of the applicationCopyright © 2008–2024 Apache Software Foundation. All rights reserved.