TaskReportTask

API Documentation:TaskReportTask

Displays a list of tasks in the project. An instance of this type is used when you execute the tasks task from the command-line.

By default, this report shows only those tasks which have been assigned to a task group, so-called visible tasks. Tasks which have not been assigned to a task group, so-called hidden tasks, can be included in the report by enabling the command line option --all.

Properties

PropertyDescription
displayGroup

The task group to be displayed. This property can be set via command-line option '--group'.

displayGroups
Incubating

The task groups to be displayed. Task groups can be added via command-line option '--groups'.

outputFile

The file which the report will be written to. When set to null, the report is written to System.out. Defaults to null.

projects

The set of project to generate this report for. By default, the report is generated for the task's containing project.

showDetail

Whether to show "invisible" tasks without a group or dependent tasks. This property can be set via command-line option '--all'.

showTypes

Whether to show the task types next to their names in the output. This property can be set via command-line option '--types'.

Methods

No methods

Script blocks

No script blocks

Property details

String displayGroup

The task group to be displayed. This property can be set via command-line option '--group'.

List<String> displayGroups

Note: This property is incubating and may change in a future version of Gradle.

The task groups to be displayed. Task groups can be added via command-line option '--groups'.

File outputFile

The file which the report will be written to. When set to null, the report is written to System.out. Defaults to null.

Set<Project> projects

The set of project to generate this report for. By default, the report is generated for the task's containing project.

boolean showDetail (write-only)

Whether to show "invisible" tasks without a group or dependent tasks. This property can be set via command-line option '--all'.

Property<Boolean> showTypes

Whether to show the task types next to their names in the output. This property can be set via command-line option '--types'.