org.springframework.yarn.client
Interface YarnClient

All Known Subinterfaces:

ApplicationYarnClient

All Known Implementing Classes:

AbstractYarnClient, CommandYarnClient, DefaultApplicationYarnClient

public interface YarnClient

Interface for Spring Yarn facing client methods.

Author:

Janne Valkealahti

Method Summary

org.apache.hadoop.yarn.api.records.ApplicationReport	getApplicationReport(org.apache.hadoop.yarn.api.records.ApplicationId applicationId) Gets a report of the application.
void	installApplication() Installs the application known to YarnClient instance into hdfs.
void	killApplication(org.apache.hadoop.yarn.api.records.ApplicationId applicationId) Requests a resource manager to kill the application.
java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport>	listApplications() Gets a list of known applications.
java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport>	listApplications(java.lang.String type) Gets a list of known applications filtered by an application type.
java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport>	listRunningApplications(java.lang.String type) Gets a list of running applications filtered by an application type.
org.apache.hadoop.yarn.api.records.ApplicationId	submitApplication() Submits the application known to YarnClient instance.
org.apache.hadoop.yarn.api.records.ApplicationId	submitApplication(boolean distribute) Submits the application known to YarnClient instance.

Method Detail

submitApplication

org.apache.hadoop.yarn.api.records.ApplicationId submitApplication()

Submits the application known to YarnClient instance.

Returns:

the ApplicationId for submitted application

submitApplication

org.apache.hadoop.yarn.api.records.ApplicationId submitApplication(boolean distribute)

Submits the application known to YarnClient instance.

Parameters:

distribute - if set to true files will also be copied

Returns:

the ApplicationId for submitted application

installApplication

void installApplication()

Installs the application known to YarnClient instance into hdfs.

listApplications

java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport> listApplications()

Gets a list of known applications.

Returns:

List of ApplicationReports

listApplications

java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport> listApplications(java.lang.String type)

Gets a list of known applications filtered by an application type.

Parameters:

type - the yarn application type

Returns:

List of ApplicationReports

listRunningApplications

java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport> listRunningApplications(java.lang.String type)

Gets a list of running applications filtered by an application type.

Parameters:

type - the yarn application type

Returns:

List of ApplicationReports

killApplication

void killApplication(org.apache.hadoop.yarn.api.records.ApplicationId applicationId)

Requests a resource manager to kill the application.

Parameters:

applicationId - the ApplicationId

getApplicationReport

org.apache.hadoop.yarn.api.records.ApplicationReport getApplicationReport(org.apache.hadoop.yarn.api.records.ApplicationId applicationId)

Gets a report of the application.

Parameters:

applicationId - the application id

Returns:

the ApplicationReport