Element

All Known Subinterfaces:

ParentElement<C>, Phase, Plan, Step

All Known Implementing Classes:

AbstractStep, DefaultPhase, DefaultPlan, DefaultRecoveryStep, DeploymentStep, DeregisterStep, EraseTaskStateStep, ResourceCleanupStep, TaskKillStep, TLSCleanupStep, TriggerDecommissionStep, UninstallStep
```
public interface Element
```
An Element is a generic component in a tree of elements. It is the basic unit for the description of Plans used to launch Mesos Tasks. Plans, @{link Phase}s and Steps are all implementations of Elements. Elements have Strategies (see: Strategy associated with them which describe when child elements should be presented as candidates for execution.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`forceComplete()` Forcefully marks the element as `Status.COMPLETE`, cancelling any work that hasn't started.
`java.util.List<java.lang.String>`	`getErrors()` Returns a list of user-visible descriptive error messages associated with this Element.
`java.util.UUID`	`getId()` Returns the unique identifier of this Element.
`default java.lang.String`	`getMessage()` Returns a reasonable user-visible status message.
`java.lang.String`	`getName()` Returns a user-visible name describing the purpose of this Element.
`Status`	`getStatus()` Returns the `Status` of this Element, used to determine if the element still has work to be completed.
`default boolean`	`hasErrors()` Indicates whether this Element has encountered errors.
`default boolean`	`isComplete()` Indicates whether this Element is complete.
`default boolean`	`isEligible(java.util.Collection<PodInstanceRequirement> dirtyAssets)` Indicates whether this Element is capable of being started.
`default boolean`	`isPending()` Indicates whether this Element has been started.
`default boolean`	`isPrepared()` Indicates whether this Element is prepared.
`default boolean`	`isRunning()` Indicates whether this Element is prepared, starting, or in progress.
`default boolean`	`isStarted()` Indicates whether the Element is starting.
`default boolean`	`isStarting()` Indicates whether the Element is starting.
`void`	`restart()` Forcefully restarts the element by putting it into a `Status.PENDING` state.
`void`	`update(TaskStatus status)` Provides the Element with a recent `TaskStatus` update which was received from Mesos.
`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.

- Method Detail
  - getId
```
java.util.UUID getId()
```
    Returns the unique identifier of this Element.
  - getName
```
java.lang.String getName()
```
    Returns a user-visible name describing the purpose of this Element.
  - getStatus
```
Status getStatus()
```
    Returns the Status of this Element, used to determine if the element still has work to be completed.
  - update
```
void update(TaskStatus status)
```
    Provides the Element with a recent TaskStatus update which was received from Mesos.
  - restart
```
void restart()
```
    Forcefully restarts the element by putting it into a Status.PENDING state.
  - forceComplete
```
void forceComplete()
```
    Forcefully marks the element as Status.COMPLETE, cancelling any work that hasn't started.
  - getErrors
```
java.util.List<java.lang.String> getErrors()
```
    Returns a list of user-visible descriptive error messages associated with this Element.
  - hasErrors
```
default boolean hasErrors()
```
    Indicates whether this Element has encountered errors.
  - isPending
```
default boolean isPending()
```
    Indicates whether this Element has been started.
  - isPrepared
```
default boolean isPrepared()
```
    Indicates whether this Element is prepared.
  - isStarting
```
default boolean isStarting()
```
    Indicates whether the Element is starting.
  - isStarted
```
default boolean isStarted()
```
    Indicates whether the Element is starting.
  - isComplete
```
default boolean isComplete()
```
    Indicates whether this Element is complete.
  - isRunning
```
default boolean isRunning()
```
    Indicates whether this Element is prepared, starting, or in progress.
  - isEligible
```
default boolean isEligible(java.util.Collection<PodInstanceRequirement> dirtyAssets)
```
    Indicates whether this Element is capable of being started.
  - updateParameters
```
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.
  - getMessage
```
default java.lang.String getMessage()
```
    Returns a reasonable user-visible status message.

Interface Element

Method Summary

Method Detail

getId

getName

getStatus

update

restart

forceComplete

getErrors

hasErrors

isPending

isPrepared

isStarting

isStarted

isComplete

isRunning

isEligible

updateParameters

getMessage