com.mesosphere.sdk.offer.evaluate.placement

Interface PlacementRule

All Known Implementing Classes:

AbstractRoundRobinRule, AgentRule, AndRule, AttributeRule, HostnameRule, IsLocalRegionRule, MaxPerAttributeRule, MaxPerHostnameRule, MaxPerRegionRule, MaxPerRule, MaxPerZoneRule, NotRule, OrRule, PassthroughRule, RegionRule, RoundRobinByAttributeRule, RoundRobinByHostnameRule, RoundRobinByRegionRule, RoundRobinByZoneRule, StringMatcherRule, TaskTypeRule, ZoneRule

public interface PlacementRule

Implements placement constraint logic on an offer, filtering out the Resources which are not to be used according to the filter logic. Accepts an Offer and returns a copy of that Offer with any disallowed Resources filtered out, or may return the original Offer without copying if everything passes the filter. If the entire Offer is rejected, the return value will be a non-null Offer with zero Resources. PlacementRules may contain multiple internal checks, and may even be a composition of other PlacementRules.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Must be explicitly implemented by all PlacementRules.
EvaluationOutcome	filter(Offer offer, PodInstance podInstance, java.util.Collection<TaskInfo> tasks) Returns whether the provided Offer, combined with the accompanying TaskInfos, passes or fails this placement constraint.
java.util.Collection<PlacementField>	getPlacementFields() Returns the PlacementFields to which this rule applies.

Method Detail

filter

EvaluationOutcome filter(Offer offer,
                         PodInstance podInstance,
                         java.util.Collection<TaskInfo> tasks)

Returns whether the provided Offer, combined with the accompanying TaskInfos, passes or fails this placement constraint.

Parameters:

offer - the offer to be examined

tasks - the currently deployed tasks in the system, possibly including a duplicate of the task being launched as represented in the offerRequirement. Use PlacementUtils.areEquivalent(TaskInfo, PodInstance) to detect duplicates

Returns:

an EvaluationOutcome object describing whether the placement succeeded or failed and why

getPlacementFields

java.util.Collection<PlacementField> getPlacementFields()

Returns the PlacementFields to which this rule applies.

equals

boolean equals(java.lang.Object o)

Must be explicitly implemented by all PlacementRules.

Overrides:

equals in class java.lang.Object

See Also:

TaskUtils.areDifferent( com.mesosphere.sdk.specification.TaskSpec, com.mesosphere.sdk.specification.TaskSpec)