org.apache.hadoop.resourceestimator.skylinestore.api

Interface HistorySkylineStore

All Known Subinterfaces:

SkylineStore

All Known Implementing Classes:

InMemoryStore

public interface HistorySkylineStore

HistorySkylineStore stores pipeline job's ResourceSkylines in all runs. Estimator will query the ResourceSkylines for pipeline jobs. Parser will parse various types of job logs, construct ResourceSkylines out of the logs and store them in the SkylineStore.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHistory(RecurrenceId recurrenceId, List<ResourceSkyline> resourceSkylines) Add job's resource skyline to the store indexed by the job's RecurrenceId.
void	deleteHistory(RecurrenceId recurrenceId) Delete all ResourceSkylines belonging to given RecurrenceId.
Map<RecurrenceId,List<ResourceSkyline>>	getHistory(RecurrenceId recurrenceId) Return all ResourceSkylines belonging to RecurrenceId.
void	updateHistory(RecurrenceId recurrenceId, List<ResourceSkyline> resourceSkylines) Update RecurrenceId with given ResourceSkylines.

Method Detail

addHistory

void addHistory(RecurrenceId recurrenceId,
              List<ResourceSkyline> resourceSkylines)
                throws SkylineStoreException

Add job's resource skyline to the store indexed by the job's RecurrenceId. RecurrenceId is used to identify recurring pipeline jobs, and we assume that ResourceEstimatorServer users will provide the correct RecurrenceId.

If ResourceSkylines to be added contain null elements, the function will skip them.

Parameters:

recurrenceId - the unique id of user's recurring pipeline jobs.

resourceSkylines - the list of ResourceSkylines in one run.

Throws:

SkylineStoreException - if: (1) input parameters are invalid; (2) ResourceSkylines to be added contain some duplicate RecurrenceIds which already exist in the HistorySkylineStore.

deleteHistory

void deleteHistory(RecurrenceId recurrenceId)
                   throws SkylineStoreException

Delete all ResourceSkylines belonging to given RecurrenceId.

Note that for safety considerations, we only allow users to deleteHistory ResourceSkylines of one job run.

Parameters:

recurrenceId - the unique id of user's recurring pipeline jobs.

Throws:

SkylineStoreException - if: (1) input parameters are invalid; (2) recurrenceId does not exist in the HistorySkylineStore.

updateHistory

void updateHistory(RecurrenceId recurrenceId,
                 List<ResourceSkyline> resourceSkylines)
                   throws SkylineStoreException

Update RecurrenceId with given ResourceSkylines. This function will deleteHistory all the ResourceSkylines belonging to the RecurrenceId, and re-insert the given ResourceSkylines to the SkylineStore.

If ResourceSkylines contain null elements, the function will skip them.

Parameters:

recurrenceId - the unique id of the pipeline job.

resourceSkylines - the list of ResourceSkylines in one run.

Throws:

SkylineStoreException - if: (1) input parameters are invalid; (2) recurrenceId does not exist in the SkylineStore.

getHistory

Map<RecurrenceId,List<ResourceSkyline>> getHistory(RecurrenceId recurrenceId)
                                                   throws SkylineStoreException

Return all ResourceSkylines belonging to RecurrenceId.

This function supports the following special wildcard operations regarding RecurrenceId: If the pipelineId is "*", it will return all entries in the store; else, if the runId is "*", it will return all ResourceSkylines belonging to the pipelineId; else, it will return all ResourceSkylines belonging to the {pipelineId, runId}. If the RecurrenceId does not exist, it will return null.

Parameters:

recurrenceId - the unique id of the pipeline job.

Returns:

all ResourceSkylines belonging to the recurrenceId.

Throws:

SkylineStoreException - if recurrenceId is null.