api / org.gradle.tooling.model / Launchable

Launchable

interface Launchable : ProjectModel

Represents an object that can be used to launch a Gradle build, such as a task.

To launch a build, you pass one or more org.gradle.tooling.model.Launchable instances to either org.gradle.tooling.BuildLauncher#forTasks(Iterable) or org.gradle.tooling.BuildLauncher#forLaunchables(Iterable).

Since
1.12

Functions

getDescription	`abstract fun getDescription(): String` Returns the description of this launchable, or `null` if it has no description.
getDisplayName	`abstract fun getDisplayName(): String` Returns a human-consumable display name for this launchable.
getProjectIdentifier	`abstract fun getProjectIdentifier(): ProjectIdentifier` Returns the identifier for the Gradle project that this model originated from.
isPublic	`abstract fun isPublic(): Boolean` Returns whether launchable is public or not. A public launchable is one that is considered a public 'entry point' to the build, that is interesting for an end user of the build to run.

Inheritors

Task

interface Task : Launchable

Represents a task which is executable by Gradle.

Note: Task extends Launchable since 1.12.

TaskSelector

interface TaskSelector : Launchable

Represents a Launchable that uses task name to select tasks executed from a given project and its sub-projects. This is roughly equivalent to running `gradle <task-name>` from the command-line.