Package org.jenkinsci.plugins.workflow.flow

Enum FlowDurabilityHint

java.lang.Object

java.lang.Enum<FlowDurabilityHint>

org.jenkinsci.plugins.workflow.flow.FlowDurabilityHint

All Implemented Interfaces:

Serializable, Comparable<FlowDurabilityHint>

public enum FlowDurabilityHint
extends Enum<FlowDurabilityHint>

Provides hints about just how hard we should try to protect our workflow from failures of the controller. There is a trade-off between durability and performance, with higher levels carrying much higher overheads to execution. Storage and persistence of data should try to provide at least the specified level (may offer more).

Author:

Sam Van Oort

Enum Constant Summary

Enum Constants

Enum Constant	Description
MAX_SURVIVABILITY
PERFORMANCE_OPTIMIZED
SURVIVABLE_NONATOMIC

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getName()	For compatibility with Jelly, etc.
String	getTooltip()
boolean	isAtomicWrite()	Should we try to use an atomic write to protect from corrupting data with failures and errors during writes?
boolean	isPersistWithEveryStep()	If false, the flow has to complete one way or the other in order to be persisted.
static FlowDurabilityHint	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FlowDurabilityHint[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PERFORMANCE_OPTIMIZED

public static final FlowDurabilityHint PERFORMANCE_OPTIMIZED

SURVIVABLE_NONATOMIC

public static final FlowDurabilityHint SURVIVABLE_NONATOMIC

MAX_SURVIVABILITY

public static final FlowDurabilityHint MAX_SURVIVABILITY

Method Detail

values

public static FlowDurabilityHint[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FlowDurabilityHint c : FlowDurabilityHint.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FlowDurabilityHint valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isAtomicWrite

public boolean isAtomicWrite()

Should we try to use an atomic write to protect from corrupting data with failures and errors during writes?

isPersistWithEveryStep

public boolean isPersistWithEveryStep()

If false, the flow has to complete one way or the other in order to be persisted.

getName

public String getName()

For compatibility with Jelly, etc.

getDescription

public String getDescription()

getTooltip

public String getTooltip()