Package org.gradle.tooling.events

Interface ProgressEvent

All Known Subinterfaces:

FinishEvent, ProjectConfigurationFinishEvent, ProjectConfigurationProgressEvent, ProjectConfigurationStartEvent, StartEvent, StatusEvent, TaskFinishEvent, TaskProgressEvent, TaskStartEvent, TestFinishEvent, TestProgressEvent, TestStartEvent, TransformFinishEvent, TransformProgressEvent, TransformStartEvent, WorkItemFinishEvent, WorkItemProgressEvent, WorkItemStartEvent

public 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

Method Summary

Modifier and Type	Method	Description
OperationDescriptor	getDescriptor()	Returns the description of the operation for which progress is reported.
String	getDisplayName()	Returns a human consumable short description of the event.
long	getEventTime()	Returns the time this event was triggered.

Method Detail

getEventTime

long getEventTime()

Returns the time this event was triggered.

Returns:

The event time, in milliseconds since the epoch.

getDisplayName

String getDisplayName()

Returns a human consumable short description of the event.

Returns:

The short description of the event.

getDescriptor

OperationDescriptor getDescriptor()

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

Returns:

The description of the operation.