org.springframework.yarn.client

Interface ClientRmOperations

All Known Implementing Classes:

ClientRmTemplate

public interface ClientRmOperations

Interface for client to resource manager communication.

Author:

Janne Valkealahti

See Also:

ClientRmTemplate

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.hadoop.yarn.api.records.ApplicationReport	getApplicationReport(org.apache.hadoop.yarn.api.records.ApplicationId applicationId) Gets a report of the application.
org.apache.hadoop.yarn.api.records.Token	getDelegationToken(java.lang.String renewer) Gets the resource manager delegation token.
org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse	getNewApplication() Requests a new application from a resource manager.
org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse	killApplication(org.apache.hadoop.yarn.api.records.ApplicationId applicationId) Requests ResourceManager to abort submitted application.
java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport>	listApplications() Gets a list of ApplicationReports from a resource manager.
java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport>	listApplications(java.util.EnumSet<org.apache.hadoop.yarn.api.records.YarnApplicationState> states, java.util.Set<java.lang.String> types) Gets a list of ApplicationReports from a resource manager.
org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse	submitApplication(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext appSubContext) Submits a new application into resource manager.

Method Detail

getNewApplication

org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse getNewApplication()

Requests a new application from a resource manager. Main purpose is to get a new ApplicationId but response also contains information about resource capabilities.

Returns:

the new GetNewApplicationResponse

submitApplication

org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse submitApplication(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext appSubContext)

Submits a new application into resource manager. Returned response is an empty placeholder, thus application submission is considered to be successful if no exceptions are thrown.

Parameters:

appSubContext - the Application Submission Context

Returns:

the new SubmitApplicationResponse

listApplications

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

Gets a list of ApplicationReports from a resource manager.

Returns:

a list of ApplicationReports

listApplications

java.util.List<org.apache.hadoop.yarn.api.records.ApplicationReport> listApplications(java.util.EnumSet<org.apache.hadoop.yarn.api.records.YarnApplicationState> states,
                                                                                    java.util.Set<java.lang.String> types)

Gets a list of ApplicationReports from a resource manager. Allows to filter results by using a set of YarnApplicationStates and registered application types.

Parameters:

states - the yarn application states

types - the yarn application types

Returns:

a list of ApplicationReports

killApplication

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

Requests ResourceManager to abort submitted application.

Parameters:

applicationId - the application id

Returns:

the KillApplicationResponse

getDelegationToken

org.apache.hadoop.yarn.api.records.Token getDelegationToken(java.lang.String renewer)

Gets the resource manager delegation token.

Parameters:

renewer - the renewer as kerberos principal

Returns:

the delegation token

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