Package io.deephaven.configuration

Class CheckpointRepairResult

java.lang.Object

io.deephaven.configuration.CheckpointRepairResult

@ScriptApi
public final class CheckpointRepairResult
extends Object

Immutable results of a checkpoint repair operation. Contains one entry for every table location that had a problem, along with counts describing the scope of the run.

This result is intended to be portable across legacy and Core+ workers. It uses standard Java values and containers (for example strings, enums, lists, and nested result records) rather than Deephaven-specific types.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CheckpointRepairResult.Builder	Mutable builder for CheckpointRepairResult, accumulating location results and counts as the repair walks the selected tables.
static enum	CheckpointRepairResult.Issue	The kind of problem found at a table location.
static final record	CheckpointRepairResult.LocationResult	The problem found at a single table location, and what was done about it.
static enum	CheckpointRepairResult.Status	Outcome for a single table location, used both per-location and (as the maximum by ordinal) as the summary for the whole operation.

Method Summary

Modifier and Type	Method	Description
static @NotNull CheckpointRepairResult.Builder	builder(boolean force)	Create a new builder.
@NotNull List<CheckpointRepairResult.LocationResult>	getLocationResults()	Get the results for every location that had a problem.
int	getLocationsInspected()	Get the number of table locations that were inspected, including those without problems.
@NotNull CheckpointRepairResult.Status	getSummaryStatus()	Summary outcome for the whole operation: the worst per-location status by ordinal, or CheckpointRepairResult.Status.OK when no problems were found.
int	getTablesInspected()	Get the number of tables that were selected and inspected.
boolean	isForced()	Whether the operation was allowed to make changes.
boolean	isMetadataIndexAffected()	Whether any reported location belongs to a historical (System permanent) table, whose locations may be tracked by a metadata index.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getSummaryStatus

@ScriptApi
@NotNull
public @NotNull CheckpointRepairResult.Status getSummaryStatus()

Summary outcome for the whole operation: the worst per-location status by ordinal, or CheckpointRepairResult.Status.OK when no problems were found.

Returns:

the summary status

getLocationResults

@ScriptApi
@NotNull
public @NotNull List<CheckpointRepairResult.LocationResult> getLocationResults()

Get the results for every location that had a problem. Locations without problems are not reported.

Returns:

an unmodifiable list of location results, in the order they were encountered

getTablesInspected

@ScriptApi
public int getTablesInspected()

Get the number of tables that were selected and inspected.

Returns:

the number of tables inspected

getLocationsInspected

@ScriptApi
public int getLocationsInspected()

Get the number of table locations that were inspected, including those without problems.

Returns:

the number of locations inspected

isMetadataIndexAffected

@ScriptApi
public boolean isMetadataIndexAffected()

Whether any reported location belongs to a historical (System permanent) table, whose locations may be tracked by a metadata index. When true, the metadata index for the affected tables should be rebuilt with dhctl metadata update after the locations are repaired.

Returns:

true if any reported location belongs to a System historical table

isForced

@ScriptApi
public boolean isForced()

Whether the operation was allowed to make changes. When false, problems were reported but nothing was modified.

Returns:

true if repairs were performed

toString

public String toString()

Overrides:

toString in class Object

builder

@NotNull
public static @NotNull CheckpointRepairResult.Builder builder(boolean force)

Create a new builder.

Parameters:

force - whether the operation is allowed to make changes

Returns:

a new Builder