@InterfaceAudience.Private
@InterfaceStability.Unstable
public interface ApplicationBaseProtocol
The protocol between clients and the ResourceManager or
ApplicationHistoryServer to get information on applications,
application attempts and containers.
| 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
ResourceManager or
ApplicationHistoryServer |
GetApplicationAttemptsResponse |
getApplicationAttempts(GetApplicationAttemptsRequest request)
The interface used by clients to get a report of all Application attempts
in the cluster from the
ResourceManager or
ApplicationHistoryServer |
GetApplicationReportResponse |
getApplicationReport(GetApplicationReportRequest request)
The interface used by clients to get a report of an Application from the
ResourceManager or ApplicationHistoryServer. |
GetApplicationsResponse |
getApplications(GetApplicationsRequest request)
The interface used by clients to get a report of Applications matching the
filters defined by
GetApplicationsRequest in the cluster from the
ResourceManager or ApplicationHistoryServer. |
GetContainerReportResponse |
getContainerReport(GetContainerReportRequest request)
The interface used by clients to get a report of an Container from the
ResourceManager or ApplicationHistoryServer |
GetContainersResponse |
getContainers(GetContainersRequest request)
The interface used by clients to get a report of Containers for an
application attempt from the
ResourceManager or
ApplicationHistoryServer |
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. |
@InterfaceAudience.Public @InterfaceStability.Stable GetApplicationReportResponse getApplicationReport(GetApplicationReportRequest request) throws YarnException, IOException
ResourceManager or ApplicationHistoryServer.
The client, via GetApplicationReportRequest provides the
ApplicationId of the application.
In secure mode,the ResourceManager or
ApplicationHistoryServer verifies access to the application,
queue etc. before accepting the request.
The ResourceManager or 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 reportYarnExceptionIOException@InterfaceAudience.Public @InterfaceStability.Stable GetApplicationsResponse getApplications(GetApplicationsRequest request) throws YarnException, IOException
The interface used by clients to get a report of Applications matching the
filters defined by GetApplicationsRequest in the cluster from the
ResourceManager or ApplicationHistoryServer.
The ResourceManager or ApplicationHistoryServer
responds with a GetApplicationsResponse which includes the
ApplicationReport for 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 applicationsYarnExceptionIOExceptionGetApplicationsRequest@InterfaceAudience.Public @InterfaceStability.Unstable GetApplicationAttemptReportResponse getApplicationAttemptReport(GetApplicationAttemptReportRequest request) throws YarnException, IOException
ResourceManager or
ApplicationHistoryServer
The client, via GetApplicationAttemptReportRequest provides the
ApplicationAttemptId of the application attempt.
In secure mode,the ResourceManager or
ApplicationHistoryServer verifies access to the method before
accepting the request.
The ResourceManager or 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 reportYarnExceptionIOException@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 ResourceManager or
ApplicationHistoryServer
The ResourceManager or 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 applicationYarnExceptionIOException@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
ResourceManager or ApplicationHistoryServer
The client, via GetContainerReportRequest provides the
ContainerId of the container.
In secure mode,the ResourceManager or
ApplicationHistoryServer verifies access to the method before
accepting the request.
The ResourceManager or ApplicationHistoryServer
responds with a GetContainerReportResponse which includes the
ContainerReport for the container.
request - request for a container reportYarnExceptionIOException@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 ResourceManager or
ApplicationHistoryServer
The client, via GetContainersRequest provides the
ApplicationAttemptId of the application attempt.
In secure mode,the ResourceManager or
ApplicationHistoryServer verifies access to the method before
accepting the request.
The ResourceManager or 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.YarnExceptionIOException@InterfaceAudience.Public @InterfaceStability.Stable 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 ResourceManager or ApplicationHistoryServer
responds with the delegation Token that can be used by the client
to speak to this service.
request - request to get a delegation token for the client.YarnExceptionIOException@InterfaceAudience.Private @InterfaceStability.Unstable RenewDelegationTokenResponse renewDelegationToken(RenewDelegationTokenRequest request) throws YarnException, IOException
Token.request - the delegation token to be renewed.YarnExceptionIOException@InterfaceAudience.Private @InterfaceStability.Unstable CancelDelegationTokenResponse cancelDelegationToken(CancelDelegationTokenRequest request) throws YarnException, IOException
Token.request - the delegation token to be cancelled.YarnExceptionIOExceptionCopyright © 2008–2022 Apache Software Foundation. All rights reserved.