org.apache.hadoop.yarn.api

Interface ApplicationHistoryProtocol

@InterfaceAudience.Public
@InterfaceStability.Unstable
public interface ApplicationHistoryProtocol

The protocol between clients and the ApplicationHistoryServer to get the information of completed applications etc.

Method Summary

Methods

Modifier and Type	Method and Description
CancelDelegationTokenResponse	cancelDelegationToken(CancelDelegationTokenRequest request) Cancel an existing delegation token.
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.
RenewDelegationTokenResponse	renewDelegationToken(RenewDelegationTokenRequest request) Renew an existing delegation token.

Method Detail

getApplicationReport

@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:

• host - set to "N/A"
• RPC port - set to -1
• client token - set to "N/A"
• diagnostics - set to "N/A"
• tracking URL - set to "N/A"
• original tracking URL - set to "N/A"
• resource usage report - all values are -1

Parameters:

request - request for an application report

Returns:

application report

Throws:

YarnException

IOException

getApplications

@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).

Parameters:

request - request for reports on all the applications

Returns:

report on applications matching the given application types defined in the request

Throws:

YarnException

IOException

getApplicationAttemptReport

@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:

• host
• RPC port
• client token
• diagnostics - set to "N/A"
• tracking URL

Parameters:

request - request for an application attempt report

Returns:

application attempt report

Throws:

YarnException

IOException

getApplicationAttempts

@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).

Parameters:

request - request for reports on all application attempts of an application

Returns:

reports on all application attempts of an application

Throws:

YarnException

IOException

getContainerReport

@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.

Parameters:

request - request for a container report

Returns:

container report

Throws:

YarnException

IOException

getContainers

@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.

Parameters:

request - request for a list of container reports of an application attempt.

Returns:

reports on all containers of an application attempt

Throws:

YarnException

IOException

getDelegationToken

@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.

Parameters:

request - request to get a delegation token for the client.

Returns:

delegation token that can be used to talk to this service

Throws:

YarnException

IOException

renewDelegationToken

@InterfaceAudience.Private
@InterfaceStability.Unstable
RenewDelegationTokenResponse renewDelegationToken(RenewDelegationTokenRequest request)
                                                  throws YarnException,
                                                         IOException

Renew an existing delegation token.

Parameters:

request - the delegation token to be renewed.

Returns:

the new expiry time for the delegation token.

Throws:

YarnException

IOException

cancelDelegationToken

@InterfaceAudience.Private
@InterfaceStability.Unstable
CancelDelegationTokenResponse cancelDelegationToken(CancelDelegationTokenRequest request)
                                                    throws YarnException,
                                                           IOException

Cancel an existing delegation token.

Parameters:

request - the delegation token to be cancelled.

Returns:

an empty response.

Throws:

YarnException

IOException