org.springframework.yarn.client
Interface YarnClient

All Known Implementing Classes:
AbstractYarnClient, CommandYarnClient

public interface YarnClient

Interface for Spring Yarn facing client methods.

Author:
Janne Valkealahti

Method Summary
 ApplicationReport getApplicationReport(ApplicationId applicationId)
          Gets a report of the application.
 void killApplication(ApplicationId applicationId)
          Requests a resource manager to kill the application.
 List<ApplicationReport> listApplications()
          Gets a list of known applications.
 ApplicationId submitApplication()
          Submits the application known to YarnClient instance.
 

Method Detail

submitApplication

ApplicationId submitApplication()
Submits the application known to YarnClient instance.

Returns:
the ApplicationId for submitted application

listApplications

List<ApplicationReport> listApplications()
Gets a list of known applications.

Returns:
List of ApplicationReports

killApplication

void killApplication(ApplicationId applicationId)
Requests a resource manager to kill the application.

Parameters:
applicationId - the ApplicationId

getApplicationReport

ApplicationReport getApplicationReport(ApplicationId applicationId)
Gets a report of the application.

Parameters:
applicationId - the application id
Returns:
the ApplicationReport