com.mesosphere.sdk.offer.evaluate.placement

Class AgentRule

java.lang.Object

com.mesosphere.sdk.offer.evaluate.placement.AgentRule

All Implemented Interfaces:

PlacementRule

public class AgentRule
extends java.lang.Object
implements PlacementRule

This rule enforces that a task be placed on a provided agent ID, or enforces that the task avoid that agent ID, depending on the factory method used.

Method Summary

Modifier and Type	Method and Description
static PlacementRule	avoid(java.util.Collection<java.lang.String> agentIds) Requires that a task NOT be placed on any of the provided agents.
static PlacementRule	avoid(java.lang.String... agentIds) Requires that a task NOT be placed on any of the provided agents.
static PlacementRule	avoid(java.lang.String agentId) Requires that a task NOT be placed on the provided agent.
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.
int	hashCode()
static PlacementRule	require(java.util.Collection<java.lang.String> agentIds) Requires that a task be placed on one of the provided agents.
static PlacementRule	require(java.lang.String... agentIds) Requires that a task be placed on one of the provided agents.
static PlacementRule	require(java.lang.String agentId) Requires that a task be placed on the provided agent.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

require

public static PlacementRule require(java.lang.String agentId)

Requires that a task be placed on the provided agent.

Parameters:

agentId - mesos ID of the agent to require

require

public static PlacementRule require(java.util.Collection<java.lang.String> agentIds)

Requires that a task be placed on one of the provided agents.

Parameters:

agentIds - mesos ID of the agents to require

require

public static PlacementRule require(java.lang.String... agentIds)

Requires that a task be placed on one of the provided agents.

Parameters:

agentIds - mesos ID of the agents to require

avoid

public static PlacementRule avoid(java.lang.String agentId)

Requires that a task NOT be placed on the provided agent.

Parameters:

agentId - mesos ID of the agent to avoid

avoid

public static PlacementRule avoid(java.util.Collection<java.lang.String> agentIds)

Requires that a task NOT be placed on any of the provided agents.

Parameters:

agentIds - mesos ID of the agents to avoid

avoid

public static PlacementRule avoid(java.lang.String... agentIds)

Requires that a task NOT be placed on any of the provided agents.

Parameters:

agentIds - mesos ID of the agents to avoid

filter

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

Description copied from interface: PlacementRule

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

Specified by:

filter in interface PlacementRule

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

public java.util.Collection<PlacementField> getPlacementFields()

Description copied from interface: PlacementRule

Returns the PlacementFields to which this rule applies.

Specified by:

getPlacementFields in interface PlacementRule

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Description copied from interface: PlacementRule

Must be explicitly implemented by all PlacementRules.

Specified by:

equals in interface PlacementRule

Overrides:

equals in class java.lang.Object

See Also:

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object