com.mesosphere.sdk.scheduler.uninstall

Class ResourceCleanupStep

java.lang.Object

com.mesosphere.sdk.scheduler.plan.AbstractStep

com.mesosphere.sdk.scheduler.uninstall.UninstallStep

com.mesosphere.sdk.scheduler.uninstall.ResourceCleanupStep

All Implemented Interfaces:

Element, Interruptible, Step

public class ResourceCleanupStep
extends UninstallStep

Step which implements the uninstalling of a particular reserved resource. For instance, persistent volumes and cpu.

Field Summary

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

id, logger

Constructor Summary

Constructors

Constructor and Description
ResourceCleanupStep(java.lang.String resourceId, Status status) Creates a new instance with the provided resourceId and initial status.

Method Summary

Modifier and Type	Method and Description
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 Step.start() has been successfully accepted/fulfilled.

Methods inherited from class com.mesosphere.sdk.scheduler.uninstall.UninstallStep

getErrors, getPodInstanceRequirement, update

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

getDisplayStatus, getMessage, isAssetDirty, isEligible

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

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

Constructor Detail

ResourceCleanupStep

public ResourceCleanupStep(java.lang.String resourceId,
                           Status status)

Creates a new instance with the provided resourceId and initial status.

Method Detail

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}

updateOfferStatus

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

Description copied from interface: Step

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

Specified by:

updateOfferStatus in interface Step

Overrides:

updateOfferStatus in class UninstallStep