com.mesosphere.sdk.scheduler.uninstall

Class TLSCleanupStep

java.lang.Object

com.mesosphere.sdk.scheduler.plan.AbstractStep

com.mesosphere.sdk.scheduler.uninstall.TLSCleanupStep

All Implemented Interfaces:

Element, Interruptible, Step

public class TLSCleanupStep
extends AbstractStep

A TLSCleanupStep removes all provisioned TLSArtifacts from secrets service in a given namespace.

Field Summary

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

id

Constructor Summary

Constructors

Constructor and Description
TLSCleanupStep(SecretsClient secretsClient, java.lang.String namespace) Creates a new instance with initial status.

Method Summary

Modifier and Type	Method and Description
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.
java.util.Optional<PodInstanceRequirement>	start() Starts the Step, whose Status should be Status.PENDING.
void	update(Protos.TaskStatus status) Provides the Element with a recent TaskStatus update which was received from Mesos.
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.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

TLSCleanupStep

TLSCleanupStep(SecretsClient secretsClient,
               java.lang.String namespace)

Creates a new instance with 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}

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)

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.

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.

update

public void update(Protos.TaskStatus status)

Description copied from interface: Element

Provides the Element with a recent TaskStatus update which was received from Mesos.