Package io.deephaven.configuration

Class DisCommandResult

java.lang.Object

io.deephaven.configuration.DisCommandResult

@ScriptApi
public final class DisCommandResult
extends Object

Immutable results of a DIS command (truncate, delete, or rescan). Contains detailed results for all data import servers and all locations that could have been affected.

This result is intended to be portable across legacy and Core+ workers. It uses standard Java values and containers (for example strings, enums, maps, lists, and nested result records) rather than Deephaven-specific location-key types such as FullTableLocationKey. In particular, location identity is represented with string fields, although nested results may still include exceptions when reporting failures.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DisCommandResult.Builder	Mutable builder for DisCommandResult.
static final class	DisCommandResult.DisResult	Immutable result for a single Data Import Server (overall status, optional key, and location results).
static final record	DisCommandResult.LocationResult	Result of a truncate or delete operation on a single location.
static enum	DisCommandResult.LocationStatus	Status of a truncate or delete operation on a single location.
static enum	DisCommandResult.Status	Outcome of a DIS command, used both as the overall summary across all DIS results and as the per-DIS status within an individual DisCommandResult.DisResult.

Method Summary

Modifier and Type	Method	Description
static DisCommandResult.Builder	builder()	Create a new builder.
@NotNull Map<String,DisCommandResult.DisResult>	getDisResultsMap()	Get the detailed results for all DISes.
@NotNull DisCommandResult.Status	getSummaryResult()	Overall result for all DIS results.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getSummaryResult

@ScriptApi
@NotNull
public @NotNull DisCommandResult.Status getSummaryResult()

Overall result for all DIS results. Returns the max status by ordinal, assuming the Status enum is ordered such that the max result present is an appropriate overall result. If there are no DIS results, returns the overall result.

Returns:

the summary status for all DIS results

getDisResultsMap

@ScriptApi
@NotNull
public @NotNull Map<String,DisCommandResult.DisResult> getDisResultsMap()

Get the detailed results for all DISes.

Returns:

an unmodifiable map of all DIS names and the detailed results of each

toString

public String toString()

Overrides:

toString in class Object

builder

public static DisCommandResult.Builder builder()

Create a new builder.

Returns:

a new Builder