Enum Class ActiveStepSearchMode

java.lang.Object

java.lang.Enum<ActiveStepSearchMode>

io.superdurable.dex.ActiveStepSearchMode

All Implemented Interfaces:

Serializable, Comparable<ActiveStepSearchMode>, Constable

public enum ActiveStepSearchMode
extends Enum<ActiveStepSearchMode>

Controls which active Step types Dex records in the ActiveStepTypes search index.

Before renaming or removing a Step implementation, applications can search ActiveStepTypes to find running Flows that still use that Step type and preserve backward compatibility. Broader indexing provides more complete visibility but performs more search-index updates. Narrower indexing reduces those updates but may omit active Steps from search results.

FlowConfig config = FlowConfig.newBuilder()
        .activeStepSearchMode(ActiveStepSearchMode.ALL)
        .build();
client.updateFlowConfig("order-123", config);

SearchFlowsPage active = client.searchFlows(
        "ActiveStepTypes = 'ChargeOrder'",
        100);

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Indexes every active Step type, including Steps that execute without waitFor.
DEFAULT	Uses the server default, which indexes active Steps whose waitFor method is used.
DISABLED	Does not index active Step types, so active-Step searches cannot find this Flow.
WITH_WAIT_FOR	Indexes an active Step type only when its Step.waitFor(Context, Object) method runs.

Method Summary

Modifier and Type	Method	Description
static ActiveStepSearchMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ActiveStepSearchMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final ActiveStepSearchMode DEFAULT

Uses the server default, which indexes active Steps whose waitFor method is used.

ALL

public static final ActiveStepSearchMode ALL

Indexes every active Step type, including Steps that execute without waitFor.

WITH_WAIT_FOR

public static final ActiveStepSearchMode WITH_WAIT_FOR

Indexes an active Step type only when its Step.waitFor(Context, Object) method runs.

DISABLED

public static final ActiveStepSearchMode DISABLED

Does not index active Step types, so active-Step searches cannot find this Flow.

Method Details

values

public static ActiveStepSearchMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ActiveStepSearchMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null