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

Interface ApplicationHistoryManager

All Known Implementing Classes:

ApplicationHistoryManagerImpl, ApplicationHistoryManagerOnTimelineStore

@Private
@Unstable
public interface ApplicationHistoryManager

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.yarn.api.records.ContainerReport	getAMContainer(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)	This method returns ContainerReport for specified ApplicationAttemptId.
org.apache.hadoop.yarn.api.records.ApplicationReport	getApplication(org.apache.hadoop.yarn.api.records.ApplicationId appId)	This method returns Application ApplicationReport for the specified ApplicationId.
org.apache.hadoop.yarn.api.records.ApplicationAttemptReport	getApplicationAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)	This method returns ApplicationAttemptReport for specified ApplicationId.
Map<org.apache.hadoop.yarn.api.records.ApplicationAttemptId,org.apache.hadoop.yarn.api.records.ApplicationAttemptReport>	getApplicationAttempts(org.apache.hadoop.yarn.api.records.ApplicationId appId)	Application can have multiple application attempts ApplicationAttemptReport.
Map<org.apache.hadoop.yarn.api.records.ApplicationId,org.apache.hadoop.yarn.api.records.ApplicationReport>	getApplications(long appsNum, long appStartedTimeBegin, long appStartedTimeEnd)	This method returns the given number of Application in the given appStartedTime period.
org.apache.hadoop.yarn.api.records.ContainerReport	getContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)	This method returns ContainerReport for specified ContainerId.
Map<org.apache.hadoop.yarn.api.records.ContainerId,org.apache.hadoop.yarn.api.records.ContainerReport>	getContainers(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)	This method returns Map of ContainerId to ContainerReport for specified ApplicationAttemptId.

Method Details

getApplication

@Public
@Unstable
org.apache.hadoop.yarn.api.records.ApplicationReport getApplication(org.apache.hadoop.yarn.api.records.ApplicationId appId)
                                                             throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

This method returns Application ApplicationReport for the specified ApplicationId.

Parameters:

appId -

Returns:

ApplicationReport for the ApplicationId.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getApplications

@Public
@Unstable
Map<org.apache.hadoop.yarn.api.records.ApplicationId,org.apache.hadoop.yarn.api.records.ApplicationReport> getApplications(long appsNum,
 long appStartedTimeBegin,
 long appStartedTimeEnd)
                                                                                                                    throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

This method returns the given number of Application in the given appStartedTime period. ApplicationReports.

Parameters:

appsNum -

appStartedTimeBegin -

appStartedTimeEnd -

Returns:

map of ApplicationId to ApplicationReports.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getApplicationAttempts

@Public
@Unstable
Map<org.apache.hadoop.yarn.api.records.ApplicationAttemptId,org.apache.hadoop.yarn.api.records.ApplicationAttemptReport> getApplicationAttempts(org.apache.hadoop.yarn.api.records.ApplicationId appId)
                                                                                                                                         throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Application can have multiple application attempts ApplicationAttemptReport. This method returns the all ApplicationAttemptReports for the Application.

Parameters:

appId -

Returns:

all ApplicationAttemptReports for the Application.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getApplicationAttempt

@Public
@Unstable
org.apache.hadoop.yarn.api.records.ApplicationAttemptReport getApplicationAttempt(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)
                                                                           throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

This method returns ApplicationAttemptReport for specified ApplicationId.

Parameters:

appAttemptId - ApplicationAttemptId

Returns:

ApplicationAttemptReport for ApplicationAttemptId

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getContainer

@Public
@Unstable
org.apache.hadoop.yarn.api.records.ContainerReport getContainer(org.apache.hadoop.yarn.api.records.ContainerId containerId)
                                                         throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

This method returns ContainerReport for specified ContainerId.

Parameters:

containerId - ContainerId

Returns:

ContainerReport for ContainerId

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getAMContainer

@Public
@Unstable
org.apache.hadoop.yarn.api.records.ContainerReport getAMContainer(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)
                                                           throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

This method returns ContainerReport for specified ApplicationAttemptId.

Parameters:

appAttemptId - ApplicationAttemptId

Returns:

ContainerReport for ApplicationAttemptId

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

getContainers

@Public
@Unstable
Map<org.apache.hadoop.yarn.api.records.ContainerId,org.apache.hadoop.yarn.api.records.ContainerReport> getContainers(org.apache.hadoop.yarn.api.records.ApplicationAttemptId appAttemptId)
                                                                                                              throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

This method returns Map of ContainerId to ContainerReport for specified ApplicationAttemptId.

Parameters:

appAttemptId - ApplicationAttemptId

Returns:

Map of ContainerId to ContainerReport for ApplicationAttemptId

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException