Overview (Gradle API 9.7.0)
Description: package index

# Gradle API 9.7.0

Packages
Package
Description
org.gradle
The top-level package for the Gradle build system.
org.gradle.api
Gradle's build language API, which is available from your build files.
org.gradle.api.artifacts
Classes for declaring and using artifacts and artifact dependencies.
org.gradle.api.artifacts.capability
Classes related to requesting and providing capabilities of variants.
org.gradle.api.artifacts.component
Classes that provide meta-data about software components.
org.gradle.api.artifacts.dsl
Classes used in the artifact DSL.
org.gradle.api.artifacts.ivy
Classes for declaring and using Ivy modules.
org.gradle.api.artifacts.maven
Classes for declaring and using Maven modules.
org.gradle.api.artifacts.query
Classes used for querying the artifacts.
org.gradle.api.artifacts.repositories
Classes for declaring and using artifact repositories.
org.gradle.api.artifacts.result
Classes that compose the resolution result
org.gradle.api.artifacts.transform
Provides classes, interfaces and annotations for registering and implementing artifact transforms.
org.gradle.api.artifacts.type
Types related to artifact type definitions.
org.gradle.api.artifacts.verification
Dependency verification related configuration classes
org.gradle.api.attributes
Classes for dealing with configuration and artifact attributes.
org.gradle.api.attributes.java
Attributes specific to the Java ecosystem.
org.gradle.api.attributes.plugin
Attributes specific to Gradle's plugin system.
org.gradle.api.cache
Classes for configuring cache-related components.
org.gradle.api.capabilities
Classes for dealing with capabilities.
org.gradle.api.component
Types for declaring and using Software Components.
org.gradle.api.configuration
Classes related to build configuration.
org.gradle.api.credentials
general credentials related classes.
org.gradle.api.distribution
The main interfaces and classes of the distribution plugin.
org.gradle.api.distribution.plugins
The distribution plugin itself.
org.gradle.api.execution
Classes for managing and monitoring build execution.
org.gradle.api.file
Classes for working with files.
org.gradle.api.flow
Gradle Flow API.
org.gradle.api.initialization
Classes for managing and monitoring build initialization.
org.gradle.api.initialization.definition
Types related to the build definition for included builds.
org.gradle.api.initialization.dsl
Classes used in the initialization DSL.
org.gradle.api.initialization.resolve
Classes for managing cross-project dependency resolution.
org.gradle.api.invocation
Classes for invoking and monitoring gradle builds.
org.gradle.api.java.archives
Classes for working with JAR manifests.
org.gradle.api.jvm
Interfaces for configuring the Java Platform Module System (JPMS).
org.gradle.api.launcher.cli
Interfaces for configuring the cli client.
org.gradle.api.logging
Classes for managing logging in Gradle.
org.gradle.api.logging.configuration
Classes for logging configuration.
org.gradle.api.model
Classes that operate on the Gradle model.
org.gradle.api.plugins
The standard `Plugin` implementations.
org.gradle.api.plugins.antlr
A `Plugin` for generating parsers from Antlr grammars.
org.gradle.api.plugins.catalog
org.gradle.api.plugins.jvm
Dependency modifiers that can access platform and enforced platforms in `dependencies` blocks.
org.gradle.api.plugins.quality
Plugins which measure and enforce code quality.
org.gradle.api.plugins.scala
A `Plugin` which compiles and tests Scala sources.
org.gradle.api.problems
new Problems API
org.gradle.api.project
`Project` specific APIs.
org.gradle.api.provider
The interfaces for value providers.
org.gradle.api.publish
Classes that deal with publishing artifacts.
org.gradle.api.publish.ivy
Types that deal with publishing in the Ivy format.
org.gradle.api.publish.ivy.plugins
Plugins for Ivy publishing.
org.gradle.api.publish.ivy.tasks
Tasks for Ivy publishing.
org.gradle.api.publish.maven
Types that deal with publishing in the Maven format.
org.gradle.api.publish.maven.plugins
Plugins for publishing in the Maven format.
org.gradle.api.publish.maven.tasks
Tasks for publishing in the Maven format.
org.gradle.api.publish.plugins
Publishing plugin.
org.gradle.api.publish.tasks
Tasks used for publishing to a binary repository.
org.gradle.api.reflect
Classes and API for the reflection and types.
org.gradle.api.reporting
Classes for reporting
org.gradle.api.reporting.components
Reporting components used by software reports.
org.gradle.api.reporting.dependencies
Types responsible for generating dependency reports.
org.gradle.api.reporting.dependents
Types representing dependent components and rendered for them.
org.gradle.api.reporting.model
Configuration model reporting tasks.
org.gradle.api.reporting.plugins
Plugins for reporting
org.gradle.api.resources
Interfaces and API for the 'Resources' concept.
org.gradle.api.services
Types for defining and using build services.
org.gradle.api.specs
Classes for defining general purpose criteria.
org.gradle.api.tasks
The standard `Task` implementations.
org.gradle.api.tasks.ant
The Ant integration `Task` implementations.
org.gradle.api.tasks.application
Tasks for creating and running java applications.
org.gradle.api.tasks.bundling
The archive bundling `Task` implementations.
org.gradle.api.tasks.compile
The compilation `Task` implementations.
org.gradle.api.tasks.diagnostics
The diagnostic `Task` implementations.
org.gradle.api.tasks.diagnostics.artifact.transforms
org.gradle.api.tasks.diagnostics.configurations
Diagnostic tasks which report information about configurations.
org.gradle.api.tasks.incremental
API classes for implementing incremental tasks.
org.gradle.api.tasks.javadoc
The documentation generation `Task` implementations.
org.gradle.api.tasks.options
Annotations for exposing task properties as command line options.
org.gradle.api.tasks.scala
org.gradle.api.tasks.testing
The unit testing `Task` implementations.
org.gradle.api.tasks.testing.junit
JUnit specific testing classes.
org.gradle.api.tasks.testing.junitplatform
org.gradle.api.tasks.testing.logging
Types related to logging of test related information to the console.
org.gradle.api.tasks.testing.source
Defines different test sources that can be associated to tests.
org.gradle.api.tasks.testing.testng
TestNG specific testing classes.
org.gradle.api.tasks.util
Utility classes used by the standard task implementations.
org.gradle.api.tasks.wrapper
The Gradle wrapper `Task`.
org.gradle.api.toolchain.management
APIs to influence how toolchains are resolved.
org.gradle.authentication
Classes related to transport authentication protocols.
org.gradle.authentication.aws
Classes related to transport authentication protocols for S3.
org.gradle.authentication.http
Classes related to transport authentication protocols for HTTP.
org.gradle.build.event
Types for receiving build events.
org.gradle.buildconfiguration.tasks
Public types for updating the Gradle Daemon JVM criteria.
org.gradle.buildinit
Build init plugins and tasks.
org.gradle.buildinit.plugins
Build init plugins.
org.gradle.buildinit.specs
Provides the API that plugins can use to contribute additional types of builds to the `init` task.
org.gradle.buildinit.tasks
Build init plugins.
org.gradle.caching
Classes for build caches and for types to extend build cache functionality.
org.gradle.caching.configuration
Classes for configuring build caches.
org.gradle.caching.http
Classes for HTTP build cache service.
org.gradle.caching.local
Classes for local build cache services.
org.gradle.concurrent
Classes related to Gradle parallelism and concurrency.
org.gradle.external.javadoc
Classes to run Javadoc.
org.gradle.ide.visualstudio
Model classes for visual studio.
org.gradle.ide.visualstudio.plugins
Plugins for Visual Studio integration.
org.gradle.ide.visualstudio.tasks
Task classes for visual studio.
org.gradle.ide.xcode
Model classes for XCode.
org.gradle.ide.xcode.plugins
Plugins for XCode integration.
org.gradle.ide.xcode.tasks
Task classes for XCode.
org.gradle.ivy
Component types for Ivy modules.
org.gradle.jvm
Types for support of JVM runtime.
org.gradle.jvm.application.scripts
Classes that enable JVM application script generation.
org.gradle.jvm.application.tasks
Tasks for the JVM application plugin.
org.gradle.jvm.tasks
Tasks that add support for JVM runtime.
org.gradle.jvm.toolchain
Defines tools and configuration options that can build things that run on the JVM.
org.gradle.language
Model classes for managing language sources.
org.gradle.language.assembler
Model classes for building from Assembler language sources.
org.gradle.language.assembler.plugins
Plugins for building from Assembler language sources.
org.gradle.language.assembler.tasks
Tasks for assembling Assembler sources for a native runtime.
org.gradle.language.base
General purpose types for language support.
org.gradle.language.base.artifact
Classes representing artifacts relevant to languages in general.
org.gradle.language.base.compile
General purpose types for related to compiling.
org.gradle.language.base.plugins
Base plugins for language support.
org.gradle.language.base.sources
General purpose types for language sources support.
org.gradle.language.c
Model classes for building from C language sources.
org.gradle.language.c.plugins
Plugins for building from C language sources.
org.gradle.language.c.tasks
Tasks for compiling C sources for a native runtime.
org.gradle.language.cpp
Model classes for building from C++ language sources.
org.gradle.language.cpp.plugins
Plugins for building from C++ language sources.
org.gradle.language.cpp.tasks
Tasks for compiling C++ sources for a native runtime.
org.gradle.language.java.artifact
Classes representing artifacts relevant to the Java language.
org.gradle.language.jvm.tasks
Tasks for support for JVM languages.
org.gradle.language.nativeplatform
Model classes for managing language sources.
org.gradle.language.nativeplatform.tasks
Base classes for native language compile tasks.
org.gradle.language.objectivec
Model classes for building from Objective-C language sources.
org.gradle.language.objectivec.plugins
Plugins for building from Objective-C language sources.
org.gradle.language.objectivec.tasks
Tasks for compiling Objective-C sources for a native runtime.
org.gradle.language.objectivecpp
Model classes for building from Objective-C++ language sources.
org.gradle.language.objectivecpp.plugins
Plugins for building from Objective-C++ language sources.
org.gradle.language.objectivecpp.tasks
Tasks for compiling Objective-C++ sources for a native runtime.
org.gradle.language.plugins
Base plugins for the native languages.
org.gradle.language.rc
Model classes for building from Windows Resource scripts.
org.gradle.language.rc.plugins
Plugins for building from Windows Resource scripts.
org.gradle.language.rc.tasks
Tasks for compiling Windows resources for a native runtime.
org.gradle.language.scala.tasks
Tasks that add support for Scala language.
org.gradle.language.swift
Model classes for building from Swift language sources.
org.gradle.language.swift.plugins
Plugins for building from Swift language sources.
org.gradle.language.swift.tasks
Tasks for compiling Swift sources for a native runtime.
org.gradle.maven
Component types for Maven modules.
org.gradle.model
Classes that operate upon the Gradle model.
org.gradle.nativeplatform
Classes that model aspects of native component projects.
org.gradle.nativeplatform.platform
Classes that allow defining a native binary platform.
org.gradle.nativeplatform.plugins
Plugins for building native component projects.
org.gradle.nativeplatform.tasks
Tasks for building native component projects.
org.gradle.nativeplatform.test
API classes for testing native binaries.
org.gradle.nativeplatform.test.cpp
API classes for C++ test integration.
org.gradle.nativeplatform.test.cpp.plugins
Plugins for C++ test integration.
org.gradle.nativeplatform.test.cunit
API classes for cunit integration.
org.gradle.nativeplatform.test.cunit.plugins
Plugins for cunit testing.
org.gradle.nativeplatform.test.cunit.tasks
Tasks for cunit integration.
org.gradle.nativeplatform.test.googletest
API classes for Google Test integration.
org.gradle.nativeplatform.test.googletest.plugins
Plugins for Google Test testing.
org.gradle.nativeplatform.test.plugins
Plugin classes for generic support for testing native binaries.
org.gradle.nativeplatform.test.tasks
Tasks for test execution.
org.gradle.nativeplatform.test.xctest
Model classes for the XCTest plugins.
org.gradle.nativeplatform.test.xctest.plugins
Plugins for XCTest testing.
org.gradle.nativeplatform.test.xctest.tasks
Tasks for XCTest execution.
org.gradle.nativeplatform.toolchain
Classes that allow C++ tool chains to be configured.
org.gradle.nativeplatform.toolchain.plugins
Built-in tool chain support.
org.gradle.normalization
Interfaces and API for input normalization.
org.gradle.platform
Types to define build environment.
org.gradle.platform.base
General purpose types for runtime support.
org.gradle.platform.base.binary
General purpose types for binary support.
org.gradle.platform.base.component
General purpose types for library support.
org.gradle.platform.base.plugins
Base plugins for software model support.
org.gradle.plugin.devel
Classes for assisting with plugin development.
org.gradle.plugin.devel.plugins
Plugins for assisting with plugin development.
org.gradle.plugin.devel.tasks
Tasks for assisting with plugin development.
org.gradle.plugin.management
APIs to influence how plugins are resolved.
org.gradle.plugin.use
Classes for managing plugin resolution and use.
org.gradle.plugins.ear
Support for generating EAR archives in a Gradle build
org.gradle.plugins.ear.descriptor
Classes for working with EAR deployment descriptors.
org.gradle.plugins.ide
General purpose IDE types.
org.gradle.plugins.ide.api
General ide plugin api.
org.gradle.plugins.ide.eclipse
A `Plugin` for generating Eclipse files.
org.gradle.plugins.ide.eclipse.model
Classes for the model used by the eclipse plugins.
org.gradle.plugins.ide.idea
A `Plugin` for generating IDEA files.
org.gradle.plugins.ide.idea.model
Classes for the model used by the `IdeaPlugin`.
org.gradle.plugins.signing
The signing plugin.
org.gradle.plugins.signing.signatory
The signing plugin signatory types.
org.gradle.plugins.signing.signatory.pgp
PGP signing support.
org.gradle.plugins.signing.type
The signing plugin signature types.
org.gradle.plugins.signing.type.pgp
PGP signing support.
org.gradle.process
Classes for executing system and Java processes.
org.gradle.swiftpm
Model classes that describe a Swift Package Manager package.
org.gradle.swiftpm.plugins
Plugins that produce Swift Package Manager manifests from the Gradle model.
org.gradle.swiftpm.tasks
Tasks that produce Swift Package Manager manifests from the Gradle model.
org.gradle.testfixtures
Classes and interfaces for testing custom task and plugin implementations.
org.gradle.testing.base
General purpose types for test suite support.
org.gradle.testing.base.plugins
Plugin classes for generic support for testing.
org.gradle.testing.jacoco.plugins
Plugins to work with the JaCoCo code coverage library.
org.gradle.testing.jacoco.tasks
Tasks to work with the JaCoCo code coverage library.
org.gradle.testing.jacoco.tasks.rules
Implementations for Jacoco code coverage rules.
org.gradle.testkit.runner
Support for executing contrived Gradle builds for the purpose of testing build logic.
org.gradle.tooling
The main interfaces and classes of the Gradle tooling API.
org.gradle.tooling.events
The interfaces and classes related to registering for event notifications and listening to dispatched events.
org.gradle.tooling.events.configuration
Project configuration specific interfaces and classes related to event notifications.
org.gradle.tooling.events.download
File download specific interfaces and classes related to event notifications.
org.gradle.tooling.events.lifecycle
Build lifecycle interfaces and classes related to event notifications.
org.gradle.tooling.events.problems
Problem specific interfaces and classes related to event notifications.
org.gradle.tooling.events.task
Task execution specific interfaces and classes related to event notifications.
org.gradle.tooling.events.task.java
Task execution result interfaces specific to Java projects.
org.gradle.tooling.events.test
Test execution specific interfaces and classes related to event notifications.
org.gradle.tooling.events.test.source
Defines Tooling API client types for different test sources that can be associated to tests.
org.gradle.tooling.events.transform
Artifact transform execution specific interfaces and classes related to event notifications.
org.gradle.tooling.events.work
Work item execution specific interfaces and classes related to event notifications.
org.gradle.tooling.exceptions
Exceptions thrown when using the tooling API.
org.gradle.tooling.model
The general-purpose tooling model types, provided by the tooling API.
org.gradle.tooling.model.build
Tooling models for the build environment, which includes information such as Gradle or Java versions.
org.gradle.tooling.model.cpp
Types that represent the tooling model for C++ projects.
org.gradle.tooling.model.dsl
Generic DSL related tooling models.
org.gradle.tooling.model.eclipse
Eclipse-centric tooling models.
org.gradle.tooling.model.gradle
The tooling models for Gradle builds and projects.
org.gradle.tooling.model.idea
IntelliJ IDEA centric tooling models.
org.gradle.tooling.model.java
Java-specific details for tooling models.
org.gradle.tooling.model.kotlin.dsl
Kotlin DSL related tooling models.
org.gradle.tooling.provider.model
Interfaces and classes that allow tooling models to be made available to the tooling API client.
org.gradle.util
Contains Gradle utility classes.
org.gradle.vcs
Packages for version control systems.
org.gradle.vcs.git
The API for dealing with Version Control Systems in Gradle.
org.gradle.work
Classes used for implementing units of work.
org.gradle.workers
Workers allow running pieces of work in the background, either in-process in isolated classloaders or out-of-process in reusable daemons.