api / org.gradle.tooling.events / OperationDescriptor

OperationDescriptor

interface OperationDescriptor

Describes an operation for which an event has occurred.

You can use equals() to determine whether 2 different descriptors refer to the same operation.

The subtypes of this interface define specific types of operations, such as task execution.

Since
2.4

Functions

getDisplayName

abstract fun getDisplayName(): String

Returns a human consumable display name for the operation. This display name provides enough context for a human to uniquely identify the operation.

getName

abstract fun getName(): String

Returns the name of the operation. This name does not necessarily uniquely identify the operation. However, the name can be used by a human to disambiguate between the children of a given operation.

getParent

abstract fun getParent(): OperationDescriptor

Returns the parent operation, if any.

Inheritors

TaskOperationDescriptor

interface TaskOperationDescriptor : OperationDescriptor

Describes a task operation for which an event has occurred.

TestOperationDescriptor

interface TestOperationDescriptor : OperationDescriptor

Describes a test operation for which an event has occurred.