org.apache.hadoop.yarn.api.protocolrecords

Class GetApplicationsRequest

java.lang.Object

org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest

@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.

See Also:

ApplicationBaseProtocol.getApplications(GetApplicationsRequest)

Constructor Summary

Constructors

Constructor and Description
GetApplicationsRequest()

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetApplicationsRequest

public GetApplicationsRequest()

Method Detail

newInstance

@InterfaceAudience.Public
 @InterfaceStability.Stable
public static GetApplicationsRequest newInstance()

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.

Parameters:

scope - ApplicationsRequestScope to filter by

users - list of users to filter by

queues - list of scheduler queues to filter by

applicationTypes - types of applications

applicationTags - application tags to filter by

applicationStates - application states to filter by

startRange - range of application start times to filter by

finishRange - range of application finish times to filter by

limit - number of applications to limit to

Returns:

GetApplicationsRequest to be used with ApplicationBaseProtocol.getApplications(GetApplicationsRequest)

See Also:

Setting any of the parameters to null, would just disable that filter

newInstance

@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.

Parameters:

scope - ApplicationsRequestScope to filter by

Returns:

a report of Applications in GetApplicationsRequest

See Also:

ApplicationBaseProtocol.getApplications(GetApplicationsRequest)

newInstance

@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.

Returns:

a report of Applications in GetApplicationsRequest

See Also:

ApplicationBaseProtocol.getApplications(GetApplicationsRequest)

newInstance

@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.

Returns:

a report of Applications in GetApplicationsRequest

See Also:

ApplicationBaseProtocol.getApplications(GetApplicationsRequest)

newInstance

@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.

Returns:

a report of Applications in GetApplicationsRequest

See Also:

ApplicationBaseProtocol.getApplications(GetApplicationsRequest)

getApplicationTypes

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract Set<String> getApplicationTypes()

Get the application types to filter applications on

Returns:

Set of Application Types to filter on

getApplicationStates

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract EnumSet<YarnApplicationState> getApplicationStates()

Get the application states to filter applications on

Returns:

Set of Application states to filter on