Package io.deephaven.api.snapshot

Class SnapshotWhenOptions

java.lang.Object

io.deephaven.api.snapshot.SnapshotWhenOptions

@Immutable
public abstract class SnapshotWhenOptions
extends Object

The options for creating a snapshotting table with respect to the base and trigger tables of TableOperations.snapshotWhen(Object, SnapshotWhenOptions).

When trigger updates, a snapshot of base and the "stamp key" from trigger form the resulting table. The "stamp key" is the last row of the trigger table, limited by the stamp columns. If trigger is empty, the "stamp key" will be represented by null values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SnapshotWhenOptions.Builder
static enum	SnapshotWhenOptions.Flag

Constructor Summary

Constructors

Constructor	Description
SnapshotWhenOptions()

Method Summary

Modifier and Type	Method	Description
static SnapshotWhenOptions.Builder	builder()
final String	description()	Creates a description of the options.
abstract Set<SnapshotWhenOptions.Flag>	flags()	The feature flags.
final boolean	has(SnapshotWhenOptions.Flag flag)	Check if the flag is set.
static SnapshotWhenOptions	of(boolean initial, boolean incremental, boolean history, String... stampColumns)	Creates an options with the flags and stampColumns..
static SnapshotWhenOptions	of(SnapshotWhenOptions.Flag... flags)	Creates an options with the flags.
static SnapshotWhenOptions	of(Iterable<SnapshotWhenOptions.Flag> flags, String... stampColumns)	Creates an options containing the flags and stampColumns.
abstract List<JoinAddition>	stampColumns()	The trigger table stamp columns.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SnapshotWhenOptions

public SnapshotWhenOptions()

Method Details

builder

public static SnapshotWhenOptions.Builder builder()

of

public static SnapshotWhenOptions of(SnapshotWhenOptions.Flag... flags)

Creates an options with the flags.

Equivalent to builder().addFlags(flags).build().

Parameters:

flags - the flags

Returns:

the snapshot control

of

public static SnapshotWhenOptions of(boolean initial,
 boolean incremental,
 boolean history,
 String... stampColumns)

Creates an options with the flags and stampColumns..

Parameters:

initial - for SnapshotWhenOptions.Flag.INITIAL

incremental - for SnapshotWhenOptions.Flag.INCREMENTAL

history - for SnapshotWhenOptions.Flag.HISTORY

stampColumns - the stamp columns

Returns:

the options

of

public static SnapshotWhenOptions of(Iterable<SnapshotWhenOptions.Flag> flags,
 String... stampColumns)

Creates an options containing the flags and stampColumns.

Parameters:

flags - the flags

stampColumns - the stamp columns

Returns:

the snapshot control

See Also:

• ColumnName.of(String)

flags

public abstract Set<SnapshotWhenOptions.Flag> flags()

The feature flags.

stampColumns

public abstract List<JoinAddition> stampColumns()

The trigger table stamp columns. If empty, it represents all columns from the trigger table.

has

public final boolean has(SnapshotWhenOptions.Flag flag)

Check if the flag is set.

Equivalent to flags().contains(flag).

Parameters:

flag - the flag

Returns:

true if this has flag

description

public final String description()

Creates a description of the options.

Returns:

the description