org.apache.slider.core.registry

Class YarnAppListClient

java.lang.Object

org.apache.slider.core.registry.YarnAppListClient

public class YarnAppListClient
extends Object

Client code for interacting with a list of service instances. The initial logic just enumerates service instances in the YARN RM

Constructor Summary

Constructors

Constructor and Description
YarnAppListClient(SliderYarnClientImpl yarnClient, String username, org.apache.hadoop.conf.Configuration conf)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,SliderInstanceDescription>	enumSliderInstances(boolean listOnlyInState, org.apache.hadoop.yarn.api.records.YarnApplicationState minAppState, org.apache.hadoop.yarn.api.records.YarnApplicationState maxAppState) Enumerate slider instances for the current user, and the most recent app report, where available.
List<org.apache.hadoop.yarn.api.records.ApplicationReport>	findAllLiveInstances(String appname) find all live instances of a specific app -if there is more than one in the cluster, this returns them all.
org.apache.hadoop.yarn.api.records.ApplicationReport	findInstance(String appname) Find an instance of a application belong to the current user
List<org.apache.hadoop.yarn.api.records.ApplicationReport>	listInstances() List instances belonging to the specific user
List<org.apache.hadoop.yarn.api.records.ApplicationReport>	listInstances(String user) List instances belonging to a specific user

Methods inherited from class java.lang.Object

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

Constructor Detail

YarnAppListClient

public YarnAppListClient(SliderYarnClientImpl yarnClient,
                 String username,
                 org.apache.hadoop.conf.Configuration conf)

Method Detail

findAllLiveInstances

public List<org.apache.hadoop.yarn.api.records.ApplicationReport> findAllLiveInstances(String appname)
                                                                                throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                       IOException

find all live instances of a specific app -if there is more than one in the cluster, this returns them all. State should be running or earlier in the lifecycle

Parameters:

appname - application name

Returns:

the list of all matching application instances

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

findInstance

public org.apache.hadoop.yarn.api.records.ApplicationReport findInstance(String appname)
                                                                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                         IOException

Find an instance of a application belong to the current user

Parameters:

appname - application name

Returns:

the app report or null if none is found

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - YARN issues

IOException - IO problems

listInstances

public List<org.apache.hadoop.yarn.api.records.ApplicationReport> listInstances()
                                                                         throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                IOException

List instances belonging to the specific user

Returns:

a possibly empty list of AMs

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

listInstances

public List<org.apache.hadoop.yarn.api.records.ApplicationReport> listInstances(String user)
                                                                         throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                                                IOException

List instances belonging to a specific user

Parameters:

user - user if not the default. null means default, "" means all users, otherwise it is the name of a user

Returns:

a possibly empty list of AMs

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

enumSliderInstances

public Map<String,SliderInstanceDescription> enumSliderInstances(boolean listOnlyInState,
                                                        org.apache.hadoop.yarn.api.records.YarnApplicationState minAppState,
                                                        org.apache.hadoop.yarn.api.records.YarnApplicationState maxAppState)
                                                          throws IOException,
                                                                 org.apache.hadoop.yarn.exceptions.YarnException

Enumerate slider instances for the current user, and the most recent app report, where available.

Parameters:

listOnlyInState - boolean to indicate that the instances should only include those in a YARN state minAppState <= currentState <= maxAppState

minAppState - minimum application state to include in enumeration.

maxAppState - maximum application state to include

Returns:

a map of application instance name to description

Throws:

IOException - Any IO problem

org.apache.hadoop.yarn.exceptions.YarnException - YARN problems