org.apache.hadoop.resourceestimator.skylinestore.impl

Class InMemoryStore

java.lang.Object

org.apache.hadoop.resourceestimator.skylinestore.impl.InMemoryStore

All Implemented Interfaces:

HistorySkylineStore, PredictionSkylineStore, SkylineStore

public class InMemoryStore
extends Object
implements SkylineStore

An in-memory implementation of SkylineStore.

Constructor Summary

Constructors

Constructor and Description
InMemoryStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	addEstimation(String pipelineId, org.apache.hadoop.yarn.server.resourcemanager.reservation.RLESparseResourceAllocation resourceSkyline) Add job's predicted Resource allocation to the store indexed by the pipelineId.
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.
org.apache.hadoop.yarn.server.resourcemanager.reservation.RLESparseResourceAllocation	getEstimation(String pipelineId) Return the predicted Resource allocation for the pipeline.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InMemoryStore

public InMemoryStore()

Method Detail

addHistory

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

Description copied from interface: HistorySkylineStore

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.

Specified by:

addHistory in interface HistorySkylineStore

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.

addEstimation

public void addEstimation(String pipelineId,
                 org.apache.hadoop.yarn.server.resourcemanager.reservation.RLESparseResourceAllocation resourceSkyline)
                   throws SkylineStoreException

Description copied from interface: PredictionSkylineStore

Add job's predicted Resource allocation to the store indexed by the pipelineId.

Note that right now we only keep the latest copy of predicted Resource allocation for the recurring pipeline.

Specified by:

addEstimation in interface PredictionSkylineStore

Parameters:

pipelineId - the id of the recurring pipeline.

resourceSkyline - the predicted Resource allocation for the pipeline.

Throws:

SkylineStoreException - if input parameters are invalid.

deleteHistory

public final void deleteHistory(RecurrenceId recurrenceId)
                         throws SkylineStoreException

Description copied from interface: HistorySkylineStore

Delete all ResourceSkylines belonging to given RecurrenceId.

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

Specified by:

deleteHistory in interface HistorySkylineStore

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

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

Description copied from interface: HistorySkylineStore

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.

Specified by:

updateHistory in interface HistorySkylineStore

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

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

Description copied from interface: HistorySkylineStore

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.

Specified by:

getHistory in interface HistorySkylineStore

Parameters:

recurrenceId - the unique id of the pipeline job.

Returns:

all ResourceSkylines belonging to the recurrenceId.

Throws:

SkylineStoreException - if recurrenceId is null.

getEstimation

public final org.apache.hadoop.yarn.server.resourcemanager.reservation.RLESparseResourceAllocation getEstimation(String pipelineId)
                                                                                                          throws SkylineStoreException

Description copied from interface: PredictionSkylineStore

Return the predicted Resource allocation for the pipeline.

If the pipelineId does not exist, it will return null.

Specified by:

getEstimation in interface PredictionSkylineStore

Parameters:

pipelineId - the unique id of the pipeline.

Returns:

the predicted Resource allocation for the pipeline.

Throws:

SkylineStoreException - if pipelineId is null.