Interface ProgressTracker
-
- All Known Implementing Classes:
ProgressTracker.EmptyProgressTracker
,TaskProgressTracker
public interface ProgressTracker
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ProgressTracker.EmptyProgressTracker
-
Field Summary
Fields Modifier and Type Field Description static ProgressTracker
NULL_TRACKER
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description void
beginSubTask()
void
beginSubTask(long taskVolume)
void
beginSubTask(java.lang.String expectedTaskDescription)
void
beginSubTask(java.lang.String expectedTaskDescription, long taskVolume)
long
currentVolume()
Returns the task volume of the currently running task orTask.UNKNOWN_VOLUME
if no task volume is set.void
endSubTask()
void
endSubTask(java.lang.String expectedTaskDescription)
void
endSubTaskWithFailure()
void
endSubTaskWithFailure(java.lang.String expectedTaskDescription)
default void
logDebug(java.lang.String message)
default void
logInfo(java.lang.String message)
void
logMessage(LogLevel level, java.lang.String message)
default void
logProgress()
void
logProgress(long value)
void
logProgress(long value, java.lang.String messageTemplate)
void
logSteps(long steps)
default void
logWarning(java.lang.String message)
void
release()
void
setEstimatedResourceFootprint(org.neo4j.gds.core.utils.mem.MemoryRange memoryEstimationInBytes, int concurrency)
void
setSteps(long steps)
void
setVolume(long volume)
Deprecated.
-
-
-
Field Detail
-
NULL_TRACKER
static final ProgressTracker NULL_TRACKER
-
-
Method Detail
-
setEstimatedResourceFootprint
void setEstimatedResourceFootprint(org.neo4j.gds.core.utils.mem.MemoryRange memoryEstimationInBytes, int concurrency)
-
beginSubTask
void beginSubTask()
-
beginSubTask
void beginSubTask(long taskVolume)
-
beginSubTask
void beginSubTask(java.lang.String expectedTaskDescription)
-
beginSubTask
void beginSubTask(java.lang.String expectedTaskDescription, long taskVolume)
-
endSubTask
void endSubTask()
-
endSubTask
void endSubTask(java.lang.String expectedTaskDescription)
-
endSubTaskWithFailure
void endSubTaskWithFailure()
-
endSubTaskWithFailure
void endSubTaskWithFailure(java.lang.String expectedTaskDescription)
-
logProgress
void logProgress(long value)
-
logProgress
default void logProgress()
-
logProgress
void logProgress(long value, java.lang.String messageTemplate)
-
setVolume
@Deprecated void setVolume(long volume)
Deprecated.
-
currentVolume
long currentVolume()
Returns the task volume of the currently running task orTask.UNKNOWN_VOLUME
if no task volume is set.
-
logDebug
default void logDebug(java.lang.String message)
-
logWarning
default void logWarning(java.lang.String message)
-
logInfo
default void logInfo(java.lang.String message)
-
logMessage
void logMessage(LogLevel level, java.lang.String message)
-
release
void release()
-
setSteps
void setSteps(long steps)
-
logSteps
void logSteps(long steps)
-
-