Package io.deephaven.configuration

Class IntradayControl.RescanOptions

java.lang.Object

io.deephaven.configuration.IntradayControl.RescanOptions

Enclosing class:

IntradayControl

@Immutable
public abstract static class IntradayControl.RescanOptions
extends Object

Configuration for a rescan request: an optional target table, DIS include/exclude lists, a logger, and the authentication context to use when contacting DISs.

A rescan targets either a single table or every intraday table. Set the target with IntradayControl.RescanOptions.Builder.table(String, String), IntradayControl.RescanOptions.Builder.table(String, String, String), (or IntradayControl.RescanOptions.Builder.table(TableIdentifier)); leaving it unset rescans all tables.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IntradayControl.RescanOptions.Builder	Builder for IntradayControl.RescanOptions.

Constructor Summary

Constructors

Constructor	Description
RescanOptions()

Method Summary

Modifier and Type	Method	Description
static @NotNull IntradayControl.RescanOptions.Builder	builder()	Create a new IntradayControl.RescanOptions.Builder for a IntradayControl.RescanOptions instance.
abstract @NotNull List<String>	disExcludes()	The DIS exclude-list.
abstract @NotNull List<String>	disIncludes()	The DIS include-list.
@NotNull com.fishlib.io.logger.Logger	logger()	The logger used for user-facing messages emitted during the operation.
abstract @NotNull Optional<TableIdentifier>	table()	The target table to rescan, or empty to rescan every intraday table.
@NotNull TokenFactoryFactory	tokenFactoryFactory()	The authenticated TokenFactoryFactory used when contacting DISs.

Methods inherited from class java.lang.Object

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

Constructor Details

RescanOptions

public RescanOptions()

Method Details

table

@NotNull
public abstract @NotNull Optional<TableIdentifier> table()

The target table to rescan, or empty to rescan every intraday table.

Returns:

the target table, or Optional.empty() to rescan all tables

disIncludes

@NotNull
public abstract @NotNull List<String> disIncludes()

The DIS include-list. When non-empty, only DISs with these names are contacted; all others are skipped.

Returns:

the include-list of DIS names

disExcludes

@NotNull
public abstract @NotNull List<String> disExcludes()

The DIS exclude-list. DISs with these names are skipped, even if they also appear in disIncludes().

Returns:

the exclude-list of DIS names

logger

@Default
@NotNull
public @NotNull com.fishlib.io.logger.Logger logger()

The logger used for user-facing messages emitted during the operation. Defaults to IntradayControl's process-wide logger.

Returns:

the logger

tokenFactoryFactory

@Default
@NotNull
public @NotNull TokenFactoryFactory tokenFactoryFactory()

The authenticated TokenFactoryFactory used when contacting DISs. Defaults to the value supplied by AuthenticationClientManager.getDefault() at construction time.

Returns:

the authenticated TokenFactoryFactory

Throws:

IllegalStateException - if no value was set and AuthenticationClientManager.getDefault() returns null

builder

@NotNull
public static @NotNull IntradayControl.RescanOptions.Builder builder()

Create a new IntradayControl.RescanOptions.Builder for a IntradayControl.RescanOptions instance.

Returns:

a new IntradayControl.RescanOptions.Builder