Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.api

Interface ConstraintPlacementAlgorithm

All Known Implementing Classes:

DefaultPlacementAlgorithm

public interface ConstraintPlacementAlgorithm

Marker interface for a Constraint Placement. The only contract is that it should be initialized with the RMContext.

Method Summary

Modifier and Type	Method	Description
void	init(RMContext rmContext)	Initialize the Algorithm.
void	place(ConstraintPlacementAlgorithmInput algorithmInput, ConstraintPlacementAlgorithmOutputCollector collector)	The Algorithm is expected to compute the placement of the provided ConstraintPlacementAlgorithmInput and use the collector to aggregate any output.

Method Detail

init

void init(RMContext rmContext)

Initialize the Algorithm.

Parameters:

rmContext - RMContext.

place

void place(ConstraintPlacementAlgorithmInput algorithmInput,
           ConstraintPlacementAlgorithmOutputCollector collector)

The Algorithm is expected to compute the placement of the provided ConstraintPlacementAlgorithmInput and use the collector to aggregate any output.

Parameters:

algorithmInput - Input to the Algorithm.

collector - Collector for output of algorithm.