com.mesosphere.sdk.scheduler.plan

Interface Step

All Superinterfaces:

Element, Interruptible

All Known Implementing Classes:

AbstractStep, DefaultRecoveryStep, DeploymentStep, DeregisterStep, EraseTaskStateStep, ResourceCleanupStep, TaskKillStep, TLSCleanupStep, TriggerDecommissionStep, UninstallStep

public interface Step
extends Element, Interruptible

Defines the interface for a Step of a Phase. The Step is the base unit of a set of tasks to perform, such as launching a Task, updating a Task, or reconciling Mesos state with Framework state. A Step may be in one of five states: PENDING, PREPARED, STARTING, COMPLETE, or ERROR. See Plan docs for more background.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getDisplayStatus() Returns a user-facing display status of this step, which may provide additional context on the work being performed beyond the underlying progress Status returned by Element.getStatus().
default java.lang.String	getMessage() Returns a reasonable user-visible status message.
java.util.Optional<PodInstanceRequirement>	getPodInstanceRequirement() Return the pod instance that this Step intends to work on.
default boolean	isAssetDirty() Reports whether the Asset associated with this Step is dirty.
default boolean	isEligible(java.util.Collection<PodInstanceRequirement> dirtyAssets) Indicates whether this Element is capable of being started.
java.util.Optional<PodInstanceRequirement>	start() Starts the Step, whose Status should be Status.PENDING.
void	updateOfferStatus(java.util.Collection<OfferRecommendation> recommendations) Notifies the Step whether the PodInstanceRequirement previously returned by start() has been successfully accepted/fulfilled.

Methods inherited from interface com.mesosphere.sdk.scheduler.plan.Element

forceComplete, getErrors, getId, getName, getStatus, hasErrors, isComplete, isPending, isPrepared, isRunning, isStarted, isStarting, restart, update, updateParameters

Methods inherited from interface com.mesosphere.sdk.scheduler.plan.Interruptible

interrupt, isInterrupted, proceed

Method Detail

start

java.util.Optional<PodInstanceRequirement> start()

Starts the Step, whose Status should be Status.PENDING. Returns an PodInstanceRequirement, or an empty Optional if obtaining/updating resource requirements are not applicable to the Step. This will continue to be called for as long as Element.isPending() returns true.

See Also:

#updateOfferStatus(Collection)} which returns the outcome of the {@link PodInstanceRequirement}

getPodInstanceRequirement

java.util.Optional<PodInstanceRequirement> getPodInstanceRequirement()

Return the pod instance that this Step intends to work on.

Returns:

The information about the pod that this Step intends to work on, Optional.empty() otherwise.

updateOfferStatus

void updateOfferStatus(java.util.Collection<OfferRecommendation> recommendations)

Notifies the Step whether the PodInstanceRequirement previously returned by start() has been successfully accepted/fulfilled. The recommendations param is empty when no offers matching the requirement previously returned by start() could be found. This is only called if start() returned a non-empty PodInstanceRequirement.

getDisplayStatus

default java.lang.String getDisplayStatus()

Returns a user-facing display status of this step, which may provide additional context on the work being performed beyond the underlying progress Status returned by Element.getStatus().

isAssetDirty

default boolean isAssetDirty()

Reports whether the Asset associated with this Step is dirty.

isEligible

default boolean isEligible(java.util.Collection<PodInstanceRequirement> dirtyAssets)

Description copied from interface: Element

Indicates whether this Element is capable of being started.

Specified by:

isEligible in interface Element

getMessage

default java.lang.String getMessage()

Description copied from interface: Element

Returns a reasonable user-visible status message.

Specified by:

getMessage in interface Element