api / org.gradle.tooling.events / ProgressEvent

ProgressEvent

interface ProgressEvent

Root interface for all events that signal progress while executing an operation. For example, an operation can be the execution of a build, of a task, of a test, etc. A progress event can, for example, signal that a test has started, a task has finished, etc.

Since
2.4

Functions

getDescriptor

abstract fun getDescriptor(): OperationDescriptor

Returns the description of the operation for which progress is reported.

getDisplayName

abstract fun getDisplayName(): String

Returns a human consumable short description of the event.

getEventTime

abstract fun getEventTime(): Long

Returns the time this event was triggered.

Inheritors

FinishEvent

interface FinishEvent : ProgressEvent

An event that informs about an operation having finished its execution.

StartEvent

interface StartEvent : ProgressEvent

An event that informs about an operation having started its execution.

StatusEvent

interface StatusEvent : ProgressEvent

An event that informs about an interim results of the operation.

TaskProgressEvent

interface TaskProgressEvent : ProgressEvent

Root interface for all events that signal progress while executing a task.

TestProgressEvent

interface TestProgressEvent : ProgressEvent

Root interface for all events that signal progress while executing a test or test suite.