com.mesosphere.sdk.offer.evaluate

Class EvaluationOutcome

java.lang.Object

com.mesosphere.sdk.offer.evaluate.EvaluationOutcome

public class EvaluationOutcome
extends java.lang.Object

The outcome of invoking an OfferEvaluationStage. Describes whether the evaluation passed or failed, and the reason(s) why. Supports a nested tree of outcomes which describe any sub-evaluations which may have been performed within the OfferEvaluationStage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EvaluationOutcome.Builder Builder for constructor EvaluationOutcome instances.

Method Summary

Modifier and Type	Method and Description
static EvaluationOutcome.Builder	fail(java.lang.Object source, java.lang.String reasonFormat, java.lang.Object... reasonArgs) Returns a new failing outcome object with the provided descriptive reason.
java.util.Collection<EvaluationOutcome>	getChildren() Returns any nested outcomes which resulted in this decision.
java.util.Optional<MesosResource>	getMesosResource()
java.util.List<OfferRecommendation>	getOfferRecommendations()
java.lang.String	getReason() Returns the reason that this response is passing or failing.
java.lang.String	getSource() Returns the name of the object which produced this response.
boolean	isPassing() Returns whether this outcome was passing (true) or failing (false).
static EvaluationOutcome.Builder	pass(java.lang.Object source, java.util.Collection<OfferRecommendation> offerRecommendations, java.lang.String reasonFormat, java.lang.Object... reasonArgs) Returns a new passing outcome object with the provided descriptive reason.
static EvaluationOutcome.Builder	pass(java.lang.Object source, java.lang.String reasonFormat, java.lang.Object... reasonArgs) Returns a new passing outcome object with the provided descriptive reason.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

pass

public static EvaluationOutcome.Builder pass(java.lang.Object source,
                                             java.lang.String reasonFormat,
                                             java.lang.Object... reasonArgs)

Returns a new passing outcome object with the provided descriptive reason.

Parameters:

source - the object which produced this outcome, whose class name will be labeled as the origin

reasonFormat - String.format(String, Object...) compatible format string describing the pass reason

reasonArgs - format arguments, if any, to apply against reasonFormat

pass

public static EvaluationOutcome.Builder pass(java.lang.Object source,
                                             java.util.Collection<OfferRecommendation> offerRecommendations,
                                             java.lang.String reasonFormat,
                                             java.lang.Object... reasonArgs)

Returns a new passing outcome object with the provided descriptive reason.

Parameters:

source - the object which produced this outcome, whose class name will be labeled as the origin

offerRecommendations - the offer recommendations generated by the source, if any

reasonFormat - String.format(String, Object...) compatible format string describing the pass reason

reasonArgs - format arguments, if any, to apply against reasonFormat

fail

public static EvaluationOutcome.Builder fail(java.lang.Object source,
                                             java.lang.String reasonFormat,
                                             java.lang.Object... reasonArgs)

Returns a new failing outcome object with the provided descriptive reason.

Parameters:

source - the object which produced this outcome, whose class name will be labeled as the origin

reasonFormat - String.format(String, Object...) compatible format string describing the fail reason

reasonArgs - format arguments, if any, to apply against reasonFormat

isPassing

public boolean isPassing()

Returns whether this outcome was passing (true) or failing (false).

getSource

public java.lang.String getSource()

Returns the name of the object which produced this response.

getReason

public java.lang.String getReason()

Returns the reason that this response is passing or failing.

getChildren

public java.util.Collection<EvaluationOutcome> getChildren()

Returns any nested outcomes which resulted in this decision.

getMesosResource

public java.util.Optional<MesosResource> getMesosResource()

getOfferRecommendations

public java.util.List<OfferRecommendation> getOfferRecommendations()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object