com.mesosphere.sdk.scheduler.plan

Class DeploymentStep

java.lang.Object

com.mesosphere.sdk.scheduler.plan.AbstractStep

com.mesosphere.sdk.scheduler.plan.DeploymentStep

All Implemented Interfaces:

Element, Interruptible, Step

Direct Known Subclasses:

DefaultRecoveryStep

public class DeploymentStep
extends AbstractStep

Step which implements the deployment of a pod.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	DeploymentStep.TaskStatusPair

Field Summary

Fields

Modifier and Type	Field and Description
protected PodInstanceRequirement	podInstanceRequirement
protected StateStore	stateStore

Fields inherited from class com.mesosphere.sdk.scheduler.plan.AbstractStep

id, logger

Constructor Summary

Constructors

Constructor and Description
DeploymentStep(java.lang.String name, PodInstanceRequirement podInstanceRequirement, StateStore stateStore) Creates a new instance with the provided name, initial status, associated pod instance required by the step, and any errors to be displayed to the user.

Method Summary

Modifier and Type	Method and Description
DeploymentStep	addError(java.lang.String error) Sets the step to an ERROR state with the provided error message.
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().
(package private) static java.lang.String	getDisplayStatus(StateStore stateStore, Status stepStatus, java.util.Collection<java.lang.String> tasksToLaunch)
java.util.List<java.lang.String>	getErrors() Returns a list of user-visible descriptive error messages associated with this Element.
java.util.Optional<PodInstanceRequirement>	getPodInstanceRequirement() Return the pod instance that this Step intends to work on.
(package private) static java.util.Optional<Status>	getStatus(java.util.Set<Status> statuses, boolean hasErrors, boolean isPrepared)
java.util.Optional<PodInstanceRequirement>	start() Starts the Step, whose Status should be Status.PENDING.
void	update(Protos.TaskStatus status) Synchronized to ensure consistency between this and updateOfferStatus(Collection).
DeploymentStep	updateInitialStatus(Status status) Sets an initial status (other than PENDING) for the step.
void	updateOfferStatus(java.util.Collection<OfferRecommendation> recommendations) Synchronized to ensure consistency between this and update(Protos.TaskStatus).
void	updateParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Provides the Element with a set of named string parameters that it can either use on start or provide to children, if it has any.

Methods inherited from class com.mesosphere.sdk.scheduler.plan.AbstractStep

equals, forceComplete, getId, getName, getStatus, hashCode, interrupt, isInterrupted, proceed, restart, setStatus, toString

Methods inherited from class java.lang.Object

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

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

getMessage, isAssetDirty, isEligible

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

hasErrors, isComplete, isPending, isPrepared, isRunning, isStarted, isStarting

Field Detail

stateStore

protected final StateStore stateStore

podInstanceRequirement

protected final PodInstanceRequirement podInstanceRequirement

Constructor Detail

DeploymentStep

public DeploymentStep(java.lang.String name,
                      PodInstanceRequirement podInstanceRequirement,
                      StateStore stateStore)

Creates a new instance with the provided name, initial status, associated pod instance required by the step, and any errors to be displayed to the user.

Method Detail

addError

public DeploymentStep addError(java.lang.String error)

Sets the step to an ERROR state with the provided error message.

Returns:

this

updateInitialStatus

public DeploymentStep updateInitialStatus(Status status)

Sets an initial status (other than PENDING) for the step. This status may later be updated as Offers/TaskStatuses are received.

Returns:

this

updateParameters

public void updateParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: Element

Provides the Element with a set of named string parameters that it can either use on start or provide to children, if it has any.

start

public java.util.Optional<PodInstanceRequirement> start()

Description copied from interface: Step

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

public java.util.Optional<PodInstanceRequirement> getPodInstanceRequirement()

Description copied from interface: Step

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

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

Synchronized to ensure consistency between this and update(Protos.TaskStatus).

getErrors

public java.util.List<java.lang.String> getErrors()

Description copied from interface: Element

Returns a list of user-visible descriptive error messages associated with this Element.

getDisplayStatus

public java.lang.String getDisplayStatus()

Description copied from interface: Step

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().

update

public void update(Protos.TaskStatus status)

Synchronized to ensure consistency between this and updateOfferStatus(Collection).

getDisplayStatus

static java.lang.String getDisplayStatus(StateStore stateStore,
                                         Status stepStatus,
                                         java.util.Collection<java.lang.String> tasksToLaunch)

getStatus

static java.util.Optional<Status> getStatus(java.util.Set<Status> statuses,
                                            boolean hasErrors,
                                            boolean isPrepared)