Package org.apache.hadoop.yarn.server.applicationhistoryservice

Interface ApplicationHistoryReader

All Known Subinterfaces:

ApplicationHistoryStore

All Known Implementing Classes:

FileSystemApplicationHistoryStore, MemoryApplicationHistoryStore, NullApplicationHistoryStore

@Public
@Unstable
public interface ApplicationHistoryReader

Method Summary

Modifier and Type	Method	Description
Map<org.apache.hadoop.yarn.api.records.ApplicationId,ApplicationHistoryData>	getAllApplications()	This method returns all Application ApplicationHistoryDatas
ContainerHistoryData	getAMContainer(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)	This method returns ContainerHistoryData for specified ApplicationAttemptId.
ApplicationHistoryData	getApplication(org.apache.hadoop.yarn.api.records.ApplicationId appId)	This method returns Application ApplicationHistoryData for the specified ApplicationId.
ApplicationAttemptHistoryData	getApplicationAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)	This method returns ApplicationAttemptHistoryData for specified ApplicationId.
Map<org.apache.hadoop.yarn.api.records.ApplicationAttemptId,ApplicationAttemptHistoryData>	getApplicationAttempts(org.apache.hadoop.yarn.api.records.ApplicationId appId)	Application can have multiple application attempts ApplicationAttemptHistoryData.
ContainerHistoryData	getContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)	This method returns ContainerHistoryData for specified ContainerId.
Map<org.apache.hadoop.yarn.api.records.ContainerId,ContainerHistoryData>	getContainers(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)	This method returns MapContainerId to ContainerHistoryData for specified ApplicationAttemptId.

Method Details

getApplication

ApplicationHistoryData getApplication(org.apache.hadoop.yarn.api.records.ApplicationId appId)
                               throws IOException

This method returns Application ApplicationHistoryData for the specified ApplicationId.

Parameters:

appId -

Returns:

ApplicationHistoryData for the ApplicationId.

Throws:

IOException

getAllApplications

Map<org.apache.hadoop.yarn.api.records.ApplicationId,ApplicationHistoryData> getAllApplications()
                                                                                         throws IOException

This method returns all Application ApplicationHistoryDatas

Returns:

map of ApplicationId to ApplicationHistoryDatas.

Throws:

IOException

getApplicationAttempts

Map<org.apache.hadoop.yarn.api.records.ApplicationAttemptId,ApplicationAttemptHistoryData> getApplicationAttempts(org.apache.hadoop.yarn.api.records.ApplicationId appId)
                                                                                                           throws IOException

Application can have multiple application attempts ApplicationAttemptHistoryData. This method returns the all ApplicationAttemptHistoryDatas for the Application.

Parameters:

appId -

Returns:

all ApplicationAttemptHistoryDatas for the Application.

Throws:

IOException

getApplicationAttempt

ApplicationAttemptHistoryData getApplicationAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)
                                             throws IOException

This method returns ApplicationAttemptHistoryData for specified ApplicationId.

Parameters:

appAttemptId - ApplicationAttemptId

Returns:

ApplicationAttemptHistoryData for ApplicationAttemptId

Throws:

IOException

getContainer

ContainerHistoryData getContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)
                           throws IOException

This method returns ContainerHistoryData for specified ContainerId.

Parameters:

containerId - ContainerId

Returns:

ContainerHistoryData for ContainerId

Throws:

IOException

getAMContainer

ContainerHistoryData getAMContainer(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)
                             throws IOException

This method returns ContainerHistoryData for specified ApplicationAttemptId.

Parameters:

appAttemptId - ApplicationAttemptId

Returns:

ContainerHistoryData for ApplicationAttemptId

Throws:

IOException

getContainers

Map<org.apache.hadoop.yarn.api.records.ContainerId,ContainerHistoryData> getContainers(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)
                                                                                throws IOException

This method returns MapContainerId to ContainerHistoryData for specified ApplicationAttemptId.

Parameters:

appAttemptId - ApplicationAttemptId

Returns:

MapContainerId to ContainerHistoryData for ApplicationAttemptId

Throws:

IOException