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:

ApplicationClientProtocol.getApplications(GetApplicationsRequest)

Constructor Summary

GetApplicationsRequest()

Method Summary

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(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.
abstract void	setApplicationStates(EnumSet<YarnApplicationState> applicationStates) Set the application states to filter applications on
abstract void	setApplicationTypes(Set<String> applicationTypes) Set the application types to filter applications on

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(Set<String> applicationTypes)

The request from clients to get a report of Applications matching the giving application types in the cluster from the ResourceManager.

See Also:

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

See Also:

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

See Also:

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

setApplicationTypes

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setApplicationTypes(Set<String> applicationTypes)

Set the application types to filter applications on

Parameters:

applicationTypes - A Set of Application Types to filter on. If not defined, match all applications

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

setApplicationStates

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setApplicationStates(EnumSet<YarnApplicationState> applicationStates)

Set the application states to filter applications on

Parameters:

applicationStates - A Set of Application states to filter on. If not defined, match all running applications