com.mesosphere.sdk.scheduler.plan

Interface ParentElement<C extends Element>

Type Parameters:

C - the type of the child elements

All Superinterfaces:

Element, Interruptible

All Known Subinterfaces:

Phase, Plan

All Known Implementing Classes:

DefaultPhase, DefaultPlan

public interface ParentElement<C extends Element>
extends Element, Interruptible

A type of Element which itself is a collection of child Elements.

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	LOGGER

Method Summary

Modifier and Type	Method and Description
default void	forceComplete() Force completes children.
java.util.List<C>	getChildren() Gets the children of this Element.
default java.util.List<java.lang.String>	getErrors(java.util.List<java.lang.String> parentErrors) Returns all errors from this and all its children.
default Status	getStatus() Returns the Status of this Element, used to determine if the element still has work to be completed.
Strategy<C>	getStrategy() Gets the Strategy applied to the deployment of this Element's children.
default void	interrupt() A call to interrupt indicates to an Interruptible that it should not continue work beyond the current point, until Interruptible.proceed() is called.
default boolean	isEligible(java.util.Collection<PodInstanceRequirement> dirtyAssets) Indicates whether this Element is capable of being started.
default boolean	isInterrupted() Indicates whether the object is interrupted or not.
default void	proceed() A call to proceed indicates to an Interruptible that it should may cancel a previous Interruptible.interrupt() call and resume with any in-progress work.
default void	restart() Restarts children.
default void	update(Protos.TaskStatus taskStatus) Updates children.
default 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 interface com.mesosphere.sdk.scheduler.plan.Element

getErrors, getId, getMessage, getName, hasErrors, isComplete, isPending, isPrepared, isRunning, isStarted, isStarting

Field Detail

LOGGER

static final Logger LOGGER

Method Detail

getChildren

java.util.List<C> getChildren()

Gets the children of this Element.

getStrategy

Strategy<C> getStrategy()

Gets the Strategy applied to the deployment of this Element's children.

interrupt

default void interrupt()

Description copied from interface: Interruptible

A call to interrupt indicates to an Interruptible that it should not continue work beyond the current point, until Interruptible.proceed() is called. This call has no effect if the object is already interrupted.

Specified by:

interrupt in interface Interruptible

proceed

default void proceed()

Description copied from interface: Interruptible

A call to proceed indicates to an Interruptible that it should may cancel a previous Interruptible.interrupt() call and resume with any in-progress work. This call has no effect if the object is already proceeding.

Specified by:

proceed in interface Interruptible

isInterrupted

default boolean isInterrupted()

Description copied from interface: Interruptible

Indicates whether the object is interrupted or not.

Specified by:

isInterrupted in interface Interruptible

Returns:

true if the object is interrupted, false otherwise.

updateParameters

default 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.

Specified by:

updateParameters in interface Element

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

update

default void update(Protos.TaskStatus taskStatus)

Updates children.

Specified by:

update in interface Element

restart

default void restart()

Restarts children.

Specified by:

restart in interface Element

forceComplete

default void forceComplete()

Force completes children.

Specified by:

forceComplete in interface Element

getErrors

default java.util.List<java.lang.String> getErrors(java.util.List<java.lang.String> parentErrors)

Returns all errors from this and all its children.

Parameters:

parentErrors - Errors from this itself.

Returns:

a combined list of all errors from the parent and all its children.

getStatus

default Status getStatus()

Description copied from interface: Element

Returns the Status of this Element, used to determine if the element still has work to be completed.

Specified by:

getStatus in interface Element