|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@InterfaceAudience.Public @InterfaceStability.Unstable public interface ApplicationHistoryProtocol
The protocol between clients and the ApplicationHistoryServer
to
get the information of completed applications etc.
Method Summary | |
---|---|
GetApplicationAttemptReportResponse |
getApplicationAttemptReport(GetApplicationAttemptReportRequest request)
The interface used by clients to get a report of an Application Attempt from the ApplicationHistoryServer . |
GetApplicationAttemptsResponse |
getApplicationAttempts(GetApplicationAttemptsRequest request)
The interface used by clients to get a report of all Application attempts in the cluster from the ApplicationHistoryServer . |
GetApplicationReportResponse |
getApplicationReport(GetApplicationReportRequest request)
The interface used by clients to get a report of an Application from the ResourceManager . |
GetApplicationsResponse |
getApplications(GetApplicationsRequest request)
The interface used by clients to get a report of all Applications in the cluster from the ApplicationHistoryServer . |
GetContainerReportResponse |
getContainerReport(GetContainerReportRequest request)
The interface used by clients to get a report of an Container from the ApplicationHistoryServer . |
GetContainersResponse |
getContainers(GetContainersRequest request)
The interface used by clients to get a report of Containers for an application attempt from the ApplciationHistoryServer . |
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. |
Method Detail |
---|
@InterfaceAudience.Public @InterfaceStability.Unstable GetApplicationReportResponse getApplicationReport(GetApplicationReportRequest request) throws YarnException, IOException
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 ApplicationHistoryServer
verifies access to
the application, queue etc. before accepting the request.
The ApplicationHistoryServer
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
YarnException
IOException
@InterfaceAudience.Public @InterfaceStability.Unstable GetApplicationsResponse getApplications(GetApplicationsRequest request) throws YarnException, IOException
The interface used by clients to get a report of all Applications in the
cluster from the ApplicationHistoryServer
.
The ApplicationHistoryServer
responds with a
GetApplicationsResponse
which includes a list of
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 reports on all the applications
YarnException
IOException
@InterfaceAudience.Public @InterfaceStability.Unstable GetApplicationAttemptReportResponse getApplicationAttemptReport(GetApplicationAttemptReportRequest request) throws YarnException, IOException
The interface used by clients to get a report of an Application Attempt
from the ApplicationHistoryServer
.
The client, via GetApplicationAttemptReportRequest
provides the
ApplicationAttemptId
of the application attempt.
In secure mode,the ApplicationHistoryServer
verifies access to
the method before accepting the request.
The ApplicationHistoryServer
responds with a
GetApplicationAttemptReportResponse
which includes the
ApplicationAttemptReport
for the application attempt.
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 attempt report
YarnException
IOException
@InterfaceAudience.Public @InterfaceStability.Unstable GetApplicationAttemptsResponse getApplicationAttempts(GetApplicationAttemptsRequest request) throws YarnException, IOException
The interface used by clients to get a report of all Application attempts
in the cluster from the ApplicationHistoryServer
.
The ApplicationHistoryServer
responds with a
GetApplicationAttemptsRequest
which includes the
ApplicationAttemptReport
for all the applications attempts of a
specified application attempt.
If the user does not have VIEW_APP
access for an application
then the corresponding report will be filtered as described in
getApplicationAttemptReport(GetApplicationAttemptReportRequest)
.
request
- request for reports on all application attempts of an application
YarnException
IOException
@InterfaceAudience.Public @InterfaceStability.Unstable GetContainerReportResponse getContainerReport(GetContainerReportRequest request) throws YarnException, IOException
The interface used by clients to get a report of an Container from the
ApplicationHistoryServer
.
The client, via GetContainerReportRequest
provides the
ContainerId
of the container.
In secure mode,the ApplicationHistoryServer
verifies access to
the method before accepting the request.
The ApplicationHistoryServer
responds with a
GetContainerReportResponse
which includes the
ContainerReport
for the container.
request
- request for a container report
YarnException
IOException
@InterfaceAudience.Public @InterfaceStability.Unstable GetContainersResponse getContainers(GetContainersRequest request) throws YarnException, IOException
The interface used by clients to get a report of Containers for an
application attempt from the ApplciationHistoryServer
.
The client, via GetContainersRequest
provides the
ApplicationAttemptId
of the application attempt.
In secure mode,the ApplicationHistoryServer
verifies access to
the method before accepting the request.
The ApplicationHistoryServer
responds with a
GetContainersResponse
which includes a list of
ContainerReport
for all the containers of a specific application
attempt.
request
- request for a list of container reports of an application attempt.
YarnException
IOException
@InterfaceAudience.Public @InterfaceStability.Unstable GetDelegationTokenResponse getDelegationToken(GetDelegationTokenRequest request) throws YarnException, IOException
The interface used by clients to get delegation token, enabling the containers to be able to talk to the service using those tokens.
The ApplicationHistoryServer
responds with the delegation
token Token
that can be used by the client to speak to this
service.
request
- request to get a delegation token for the client.
YarnException
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |