Package io.deephaven.api.snapshot

Enum Class SnapshotWhenOptions.Flag

java.lang.Object

java.lang.Enum<SnapshotWhenOptions.Flag>

io.deephaven.api.snapshot.SnapshotWhenOptions.Flag

All Implemented Interfaces:

Serializable, Comparable<SnapshotWhenOptions.Flag>, java.lang.constant.Constable

Enclosing class:

SnapshotWhenOptions

public static enum SnapshotWhenOptions.Flag
extends Enum<SnapshotWhenOptions.Flag>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HISTORY	Whether the resulting table should keep history.
INCREMENTAL	Whether the resulting table should be incremental.
INITIAL	Whether to take an initial snapshot upon construction.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INITIAL

public static final SnapshotWhenOptions.Flag INITIAL

Whether to take an initial snapshot upon construction. When not specified, the resulting table will remain empty until trigger first updates.

INCREMENTAL

public static final SnapshotWhenOptions.Flag INCREMENTAL

Whether the resulting table should be incremental. When incremental, only the rows of base that have been added or updated will have the latest "stamp key".

HISTORY

public static final SnapshotWhenOptions.Flag HISTORY

Whether the resulting table should keep history. A history table appends a full snapshot of base and the "stamp key" as opposed to updating existing rows. When this flag is used, the trigger table must be append-only.

Note: this flag is currently incompatible with INITIAL and INCREMENTAL.

See Also:

• deephaven-core#3260

Method Details

values

public static SnapshotWhenOptions.Flag[] 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 SnapshotWhenOptions.Flag 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