|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@InterfaceAudience.Public @InterfaceStability.Stable public interface ClientRMProtocol
The protocol between clients and the ResourceManager
to submit/abort jobs and to get information on applications, cluster metrics,
nodes, queues and ACLs.
| Method Summary | |
|---|---|
KillApplicationResponse |
forceKillApplication(KillApplicationRequest request)
The interface used by clients to request the ResourceManager to abort submitted application. |
GetAllApplicationsResponse |
getAllApplications(GetAllApplicationsRequest request)
The interface used by clients to get a report of all Applications in the cluster from the ResourceManager. |
GetApplicationReportResponse |
getApplicationReport(GetApplicationReportRequest request)
The interface used by clients to get a report of an Application from the ResourceManager. |
GetClusterMetricsResponse |
getClusterMetrics(GetClusterMetricsRequest request)
The interface used by clients to get metrics about the cluster from the ResourceManager. |
GetClusterNodesResponse |
getClusterNodes(GetClusterNodesRequest request)
The interface used by clients to get a report of all nodes in the cluster from the ResourceManager. |
GetDelegationTokenResponse |
getDelegationToken(GetDelegationTokenRequest request)
The interface used by clients to get delegation token, enabling the containers to be able to talk to the service using those tokens. |
GetNewApplicationResponse |
getNewApplication(GetNewApplicationRequest request)
The interface used by clients to obtain a new ApplicationId for
submitting new applications. |
GetQueueInfoResponse |
getQueueInfo(GetQueueInfoRequest request)
The interface used by clients to get information about queues from the ResourceManager. |
GetQueueUserAclsInfoResponse |
getQueueUserAcls(GetQueueUserAclsInfoRequest request)
The interface used by clients to get information about queue acls for current user from the ResourceManager. |
SubmitApplicationResponse |
submitApplication(SubmitApplicationRequest request)
The interface used by clients to submit a new application to the ResourceManager. |
| Method Detail |
|---|
GetNewApplicationResponse getNewApplication(GetNewApplicationRequest request)
throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
The interface used by clients to obtain a new ApplicationId for
submitting new applications.
The ResourceManager responds with a new, monotonically
increasing, ApplicationId which is used by the client to submit
a new application.
The ResourceManager also responds with details such
as minimum and maximum resource capabilities in the cluster as specified in
GetNewApplicationResponse.
request - request to get a new ApplicationId
ApplicationId to be used
to submit an application
org.apache.hadoop.yarn.exceptions.YarnRemoteExceptionsubmitApplication(SubmitApplicationRequest)
SubmitApplicationResponse submitApplication(SubmitApplicationRequest request)
throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
The interface used by clients to submit a new application to the
ResourceManager.
The client is required to provide details such as queue,
Resource required to run the ApplicationMaster,
the equivalent of ContainerLaunchContext for launching
the ApplicationMaster etc. via the
SubmitApplicationRequest.
Currently the ResourceManager sends an immediate (empty)
SubmitApplicationResponse on accepting the submission and throws
an exception if it rejects the submission.
In secure mode,the ResourceManager verifies access to
queues etc. before accepting the application submission.
request - request to submit a new application
org.apache.hadoop.yarn.exceptions.YarnRemoteExceptiongetNewApplication(GetNewApplicationRequest)
KillApplicationResponse forceKillApplication(KillApplicationRequest request)
throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
The interface used by clients to request the
ResourceManager to abort submitted application.
The client, via KillApplicationRequest provides the
ApplicationId of the application to be aborted.
In secure mode,the ResourceManager verifies access to the
application, queue etc. before terminating the application.
Currently, the ResourceManager returns an empty response
on success and throws an exception on rejecting the request.
request - request to abort a submited application
ResourceManager returns an empty response
on success and throws an exception on rejecting the request
org.apache.hadoop.yarn.exceptions.YarnRemoteExceptiongetQueueUserAcls(GetQueueUserAclsInfoRequest)
GetApplicationReportResponse getApplicationReport(GetApplicationReportRequest request)
throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
The interface used by clients to get a report of an Application from
the ResourceManager.
The client, via GetApplicationReportRequest provides the
ApplicationId of the application.
In secure mode,the ResourceManager verifies access to the
application, queue etc. before accepting the request.
The ResourceManager responds with a
GetApplicationReportResponse which includes the
ApplicationReport for the application.
If the user does not have VIEW_APP access then the
following fields in the report will be set to stubbed values:
request - request for an application report
org.apache.hadoop.yarn.exceptions.YarnRemoteException
GetClusterMetricsResponse getClusterMetrics(GetClusterMetricsRequest request)
throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
The interface used by clients to get metrics about the cluster from
the ResourceManager.
The ResourceManager responds with a
GetClusterMetricsResponse which includes the
YarnClusterMetrics with details such as number of current
nodes in the cluster.
request - request for cluster metrics
org.apache.hadoop.yarn.exceptions.YarnRemoteException
GetAllApplicationsResponse getAllApplications(GetAllApplicationsRequest request)
throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
The interface used by clients to get a report of all Applications
in the cluster from the ResourceManager.
The ResourceManager responds with a
GetAllApplicationsResponse which includes the
ApplicationReport for all the applications.
If the user does not have VIEW_APP access for an
application then the corresponding report will be filtered as
described in getApplicationReport(GetApplicationReportRequest).
request - request for report on all running applications
org.apache.hadoop.yarn.exceptions.YarnRemoteException
GetClusterNodesResponse getClusterNodes(GetClusterNodesRequest request)
throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
The interface used by clients to get a report of all nodes
in the cluster from the ResourceManager.
The ResourceManager responds with a
GetClusterNodesResponse which includes the
NodeReport for all the nodes in the cluster.
request - request for report on all nodes
org.apache.hadoop.yarn.exceptions.YarnRemoteException
GetQueueInfoResponse getQueueInfo(GetQueueInfoRequest request)
throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
The interface used by clients to get information about queues
from the ResourceManager.
The client, via GetQueueInfoRequest, can ask for details such
as used/total resources, child queues, running applications etc.
In secure mode,the ResourceManager verifies access before
providing the information.
request - request to get queue information
org.apache.hadoop.yarn.exceptions.YarnRemoteException
GetQueueUserAclsInfoResponse getQueueUserAcls(GetQueueUserAclsInfoRequest request)
throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
The interface used by clients to get information about queue
acls for current user from the ResourceManager.
The ResourceManager responds with queue acls for all
existing queues.
request - request to get queue acls for current user
org.apache.hadoop.yarn.exceptions.YarnRemoteException
GetDelegationTokenResponse getDelegationToken(GetDelegationTokenRequest request)
throws org.apache.hadoop.yarn.exceptions.YarnRemoteException
The interface used by clients to get delegation token, enabling the containers to be able to talk to the service using those tokens.
The ResourceManager responds with the delegation token
DelegationToken that can be used by the client to speak to this
service.
request - request to get a delegation token for the client.
org.apache.hadoop.yarn.exceptions.YarnRemoteException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||