# DependencyInsightReportTask

API Documentation: | `DependencyInsightReportTask`

Generates a report that attempts to answer questions like:

- Why is this dependency in the dependency graph?
- Exactly which dependencies are pulling this dependency into the graph?
- What is the actual version (i.e. *selected* version) of the dependency that will be used? Is it the same as what was *requested*?
- Why is the *selected* version of a dependency different to the *requested*?

Use this task to get insight into a particular dependency (or dependencies) and find out what exactly happens during dependency resolution and conflict resolution. If the dependency version was forced or selected by the conflict resolution this information will be available in the report.

While the regular dependencies report (`DependencyReportTask`) shows the path from the top level dependencies down through the transitive dependencies, the dependency insight report shows the path from a particular dependency to the dependencies that pulled it in. That is, it is an inverted view of the regular dependencies report.

The task requires setting the dependency spec and the configuration. For more information on how to configure those please refer to docs for `DependencyInsightReportTask.setDependencySpec(java.lang.Object)` and `DependencyInsightReportTask.setConfiguration(java.lang.String)`.

The task can also be configured from the command line. For more information please refer to `DependencyInsightReportTask.setDependencySpec(java.lang.Object)` and `DependencyInsightReportTask.setConfiguration(java.lang.String)`

### Properties

Property | Description
`actions` | The sequence of `Action` objects which will be executed by this task, in the order of execution.
`ant` | The `AntBuilder` for this task. You can use this in your build file to execute ant tasks.
`configuration` | Configuration to look the dependency in
`convention` | The `Convention` object for this task. A `Plugin` can use the convention object to contribute properties and methods to this task.
`dependencySpec` | Selects the dependency (or dependencies if multiple matches found) to show the report for.
`dependsOn` | The dependencies of this task.
`description` | The description of this task.
`destroyables` | The destroyables of this task.
`didWork` | Checks if the task actually did any work. Even if a Task executes, it may determine that it has nothing to do. For example, a compilation task may determine that source files have not changed since the last time a the task was run.
`enabled` | Returns if this task is enabled or not.
`extensions` | The container of extensions.
`finalizedBy` | Returns tasks that finalize this task.
`group` | The task group which this task belongs to. The task group is used in reports and user interfaces to group related tasks together when presenting a list of tasks to the user.
`inputs` | The inputs of this task.
`localState` | The local state of this task.
`logger` | The logger for this task. You can use this in your build file to write log messages.
`logging` | The `LoggingManager` which can be used to receive logging and to control the standard output/error capture for this task. By default, System.out is redirected to the Gradle logging system at the QUIET log level, and System.err is redirected at the ERROR log level.
`mustRunAfter` | Returns tasks that this task must run after.
`name` | The name of this task. The name uniquely identifies the task within its `Project`.
`outputs` | The outputs of this task.
`path` | The path of the task, which is a fully qualified name for the task. The path of a task is the path of its `Project` plus the name of the task, separated by `:`.
`project` | The `Project` which this task belongs to.
`shouldRunAfter` | Returns tasks that this task should run after.
`state` | The execution state of this task. This provides information about the execution of this task, such as whether it has executed, been skipped, has failed, etc.
`taskDependencies` | Returns a `TaskDependency` which contains all the tasks that this task depends on.
`temporaryDir` | Returns a directory which this task can use to write temporary files to. Each task instance is provided with a separate temporary directory. There are no guarantees that the contents of this directory will be kept beyond the execution of the task.
`timeout` | The timeout of this task.

### Methods

Method | Description
`dependsOn(paths)` | Adds the given dependencies to this task. See here for a description of the types of objects which can be used as task dependencies.
`doFirst(action)` | Adds the given closure to the beginning of this task's action list. The closure is passed this task as a parameter when executed.
`doFirst(actionName, action)` | Adds the given `Action` to the beginning of this task's action list.
`doFirst(action)` | Adds the given `Action` to the beginning of this task's action list.
`doLast(action)` | Adds the given closure to the end of this task's action list. The closure is passed this task as a parameter when executed.
`doLast(actionName, action)` | Adds the given `Action` to the end of this task's action list.
`doLast(action)` | Adds the given `Action` to the end of this task's action list.
`finalizedBy(paths)` | Adds the given finalizer tasks for this task.
`hasProperty(propertyName)` | Determines if this task has the given property. See here for details of the properties which are available for a task.
`mustRunAfter(paths)` | Specifies that this task must run after all of the supplied tasks.
`onlyIf(onlyIfClosure)` | Execute the task only if the given closure returns true. The closure will be evaluated at task execution time, not during configuration. The closure will be passed a single parameter, this task. If the closure returns false, the task will be skipped.
`onlyIf(onlyIfSpec)` | Execute the task only if the given spec is satisfied. The spec will be evaluated at task execution time, not during configuration. If the Spec is not satisfied, the task will be skipped.
`property(propertyName)` | Returns the value of the given property of this task. This method locates a property as follows:
`setProperty(name, value)` | Sets a property of this task. This method searches for a property with the given name in the following locations, and sets the property on the first location where it finds the property.
`shouldRunAfter(paths)` | Specifies that this task should run after all of the supplied tasks.

### Script blocks

No script blocks

### Property details

#### ``List`<`Action`<? super `Task`>>` `actions`

The sequence of `Action` objects which will be executed by this task, in the order of execution.

#### `AntBuilder` `ant` (read-only)

The `AntBuilder` for this task. You can use this in your build file to execute ant tasks.

#### `Configuration` `configuration`

Configuration to look the dependency in

Default with `java` plugin:
  `compileClasspath` configuration

#### `Convention` `convention` (read-only)

The `Convention` object for this task. A `Plugin` can use the convention object to contribute properties and methods to this task.

#### ``Spec`<`DependencyResult`>` `dependencySpec`

Selects the dependency (or dependencies if multiple matches found) to show the report for.

Default with `java` plugin:
  -

#### ``Set`<`Object`>` `dependsOn`

The dependencies of this task.

#### `String` `description`

The description of this task.

#### `TaskDestroyables` `destroyables` (read-only)

The destroyables of this task.

#### `boolean` `didWork`

Checks if the task actually did any work. Even if a Task executes, it may determine that it has nothing to do. For example, a compilation task may determine that source files have not changed since the last time a the task was run.

#### `boolean` `enabled`

Returns if this task is enabled or not.

#### `ExtensionContainer` `extensions` (read-only)

The container of extensions.

#### `TaskDependency` `finalizedBy`

Returns tasks that finalize this task.

#### `String` `group`

The task group which this task belongs to. The task group is used in reports and user interfaces to group related tasks together when presenting a list of tasks to the user.

#### `TaskInputs` `inputs` (read-only)

The inputs of this task.

#### `TaskLocalState` `localState` (read-only)

The local state of this task.

#### `Logger` `logger` (read-only)

The logger for this task. You can use this in your build file to write log messages.

#### `LoggingManager` `logging` (read-only)

The `LoggingManager` which can be used to receive logging and to control the standard output/error capture for this task. By default, System.out is redirected to the Gradle logging system at the QUIET log level, and System.err is redirected at the ERROR log level.

#### `TaskDependency` `mustRunAfter`

Returns tasks that this task must run after.

#### `String` `name` (read-only)

The name of this task. The name uniquely identifies the task within its `Project`.

#### `TaskOutputs` `outputs` (read-only)

The outputs of this task.

#### `String` `path` (read-only)

The path of the task, which is a fully qualified name for the task. The path of a task is the path of its `Project` plus the name of the task, separated by `:`.

#### `Project` `project` (read-only)

The `Project` which this task belongs to.

#### `TaskDependency` `shouldRunAfter`

Returns tasks that this task should run after.

#### `TaskState` `state` (read-only)

The execution state of this task. This provides information about the execution of this task, such as whether it has executed, been skipped, has failed, etc.

#### `TaskDependency` `taskDependencies` (read-only)

Returns a `TaskDependency` which contains all the tasks that this task depends on.

#### `File` `temporaryDir` (read-only)

Returns a directory which this task can use to write temporary files to. Each task instance is provided with a separate temporary directory. There are no guarantees that the contents of this directory will be kept beyond the execution of the task.

#### ``Property`<`Duration`>` `timeout`

The timeout of this task.

    task myTask {
        timeout = Duration.ofMinutes(10)
    }

The Thread executing this task will be interrupted if the task takes longer than the specified amount of time to run. In order for a task to work properly with this feature, it needs to react to interrupts and must clean up any resources it opened.

By default, tasks never time out.

### Method details

#### `Task` `dependsOn`(``Object`...` paths)

Adds the given dependencies to this task. See here for a description of the types of objects which can be used as task dependencies.

#### `Task` `doFirst`(`Closure` action)

Adds the given closure to the beginning of this task's action list. The closure is passed this task as a parameter when executed.

#### `Task` `doFirst`(`String` actionName, ``Action`<? super `Task`>` action)

Adds the given `Action` to the beginning of this task's action list.

#### `Task` `doFirst`(``Action`<? super `Task`>` action)

Adds the given `Action` to the beginning of this task's action list.

#### `Task` `doLast`(`Closure` action)

Adds the given closure to the end of this task's action list. The closure is passed this task as a parameter when executed.

#### `Task` `doLast`(`String` actionName, ``Action`<? super `Task`>` action)

Adds the given `Action` to the end of this task's action list.

#### `Task` `doLast`(``Action`<? super `Task`>` action)

Adds the given `Action` to the end of this task's action list.

#### `Task` `finalizedBy`(``Object`...` paths)

Adds the given finalizer tasks for this task.

    task taskY {
        finalizedBy "taskX"
    }

See here for a description of the types of objects which can be used to specify a finalizer task.

#### `boolean` `hasProperty`(`String` propertyName)

Determines if this task has the given property. See here for details of the properties which are available for a task.

#### `Task` `mustRunAfter`(``Object`...` paths)

Specifies that this task must run after all of the supplied tasks.

    task taskY {
        mustRunAfter "taskX"
    }

For each supplied task, this action adds a task 'ordering', and does not specify a 'dependency' between the tasks. As such, it is still possible to execute 'taskY' without first executing the 'taskX' in the example.

See here for a description of the types of objects which can be used to specify an ordering relationship.

#### `void` `onlyIf`(`Closure` onlyIfClosure)

Execute the task only if the given closure returns true. The closure will be evaluated at task execution time, not during configuration. The closure will be passed a single parameter, this task. If the closure returns false, the task will be skipped.

You may add multiple such predicates. The task is skipped if any of the predicates return false.

Typical usage:`myTask.onlyIf { isProductionEnvironment() }`

#### `void` `onlyIf`(``Spec`<? super `Task`>` onlyIfSpec)

Execute the task only if the given spec is satisfied. The spec will be evaluated at task execution time, not during configuration. If the Spec is not satisfied, the task will be skipped.

You may add multiple such predicates. The task is skipped if any of the predicates return false.

Typical usage (from Java):

    myTask.onlyIf(new Spec<Task>() {
       boolean isSatisfiedBy(Task task) {
          return isProductionEnvironment();
       }
    });

#### `Object` `property`(`String` propertyName)

Returns the value of the given property of this task. This method locates a property as follows:

1. If this task object has a property with the given name, return the value of the property.
2. If this task has an extension with the given name, return the extension.
3. If this task's convention object has a property with the given name, return the value of the property.
4. If this task has an extra property with the given name, return the value of the property.
5. If not found, throw `MissingPropertyException`

#### `void` `setProperty`(`String` name, `Object` value)

Sets a property of this task. This method searches for a property with the given name in the following locations, and sets the property on the first location where it finds the property.

1. The task object itself. For example, the `enabled` project property.
2. The task's convention object.
3. The task's extra properties.

If the property is not found, a `MissingPropertyException` is thrown.

#### `TaskDependency` `shouldRunAfter`(``Object`...` paths)

Specifies that this task should run after all of the supplied tasks.

    task taskY {
        shouldRunAfter "taskX"
    }

For each supplied task, this action adds a task 'ordering', and does not specify a 'dependency' between the tasks. As such, it is still possible to execute 'taskY' without first executing the 'taskX' in the example.

See here for a description of the types of objects which can be used to specify an ordering relationship.