Google is committed to advancing racial equity for Black communities. See how.

Class Index

These are all the API classes. See all API packages.

A   B   C   D   E   F   G   I   J   L   M   N   O   P   Q   S   T   U   V  

A

AaptOptions

DSL object for configuring aapt options.

AaptOptions

Defines a variant's aapt options.

AarMetadata

DSL object for configuring AAR metadata.

AbiSplit

DSL object for configuring per-abi splits options.

ActionableComponentObject

Tag interface for interfaces or classes that can be used as parameter to an org.gradle.api.Action or lambda in the Variant API.

AdbOptions

Options for the adb tool.

AndroidBasePlugin

Common plugin applied by all plugins.

AndroidSourceDirectorySet

An AndroidSourceDirectorySet represents a set of directory inputs for an Android project.

AndroidSourceFile

An AndroidSourceFile represents a single file input for an Android project.

AndroidSourceSet

An AndroidSourceSet represents a logical group of Java, aidl and RenderScript sources as well as Android and non-Android (Java-style) resources.

AndroidTest

Variant of the android test artifact

AndroidTestProperties

Properties for the android test Variant of a module

AnnotationProcessorOptions

Options for configuring Java annotation processor.

ApkExtension

Common extension properties for the Android Gradle Plugin Application and Dynamic Feature plugins.

ApplicationBaseFlavor

ApplicationBuildFeatures

A list of build features that can be disabled or enabled in an Android Application project.

ApplicationBuildType

ApplicationDefaultConfig

ApplicationExtension

Extension for the Android Gradle Plugin Application plugin.

ApplicationProductFlavor

ApplicationVariant

Application specific variant object that contains properties that will determine the variant's build flow.

ApplicationVariantDimension

ApplicationVariantProperties

Properties for the main Variant of an application.

Artifact

Defines a type of artifact handled by the Android Gradle Plugin.

Artifact.Appendable

Denotes an artifact type that can be appended to.

Artifact.ContainsMany

Denotes a single DIRECTORY that may contain zero to many com.android.build.api.variant.BuiltArtifact.

Artifact.MultipleArtifact

Denotes possible multiple FileSystemLocation instances for this artifact type.

Artifact.Replaceable

Denotes an artifact type that can be replaced.

Artifact.SingleArtifact

Denotes a single FileSystemLocation instance of this artifact type at a given time.

Artifact.Transformable

Denotes an artifact type that can transformed.

ArtifactKind

Exhaustive list of artifact file representations supported by the Android Gradle plugin.

ArtifactKind.DIRECTORY

ArtifactKind.FILE

Artifacts

Access to the artifacts on a Variant object.

ArtifactTransformationRequest

When a Directory contains more than one artifact (for example, consider ArtifactType.APK with multiple APKs for different screen densities), this object will abstract away having to deal with BuiltArtifacts and manually load and write the metadata files.

ArtifactType

Public Artifact for Android Gradle plugin.

ArtifactType.APK

APK directory where final APK files will be located.

ArtifactType.BUNDLE

ArtifactType.MERGED_MANIFEST

Merged manifest file that will be used in the APK, Bundle and InstantApp packages.

ArtifactType.OBFUSCATION_MAPPING_FILE

AssetPackExtension

Extension properties for the Asset Pack plugin.

AssetPackPlugin

B

BaseFlavor

Shared properties between DSL objects ProductFlavor and DefaultConfig

BuildConfigField

Field definition for the generated BuildConfig class.

BuildFeatures

A list of build features that can be disabled or enabled in an Android project.

BuildType

DSL object to configure build types.

BuildTypeAttr

Type for the attribute holding BuildType information.

BuildTypedComponentActionRegistrar

Allows registering Actions on ComponentT, with the ability to include filters to target sub sets of ComponentT.

BuiltArtifact

Represents a built artifact that is present in the file system.

BuiltArtifacts

Represents a Collection of BuiltArtifact produced by a org.gradle.api.Task.

BuiltArtifacts.TransformParams

Specialized version of Gradle's WorkParameters so we can retrieve the output file generated when transforming an instance of BuiltArtifacts into a new one.

BuiltArtifactsLoader

Facility to load BuiltArtifacts instances from metadata files in the file system.

Bundle

BundleAbi

BundleDensity

BundleLanguage

BundleTexture

C

Cmake

DSL object for per-module CMake configurations, such as the path to your CMakeLists.txt build script and external native build output directory.

CombiningOperationRequest

CommonExtension

Common extension properties for the Android Application.

CompileOptions

Java compilation options.

Component

Component object that contains properties that must be set during configuration time as it changes the build flow for the variant.

ComponentIdentity

Variant Configuration represents the identify of a variant

ComponentProperties

ComposeOptions

Optional settings for the Compose feature.

Context

Context for the transform.

D

DataBinding

DSL object for configuring databinding options.

DefaultConfig

Specifies defaults for variant properties that the Android plugin applies to all build variants.

DensitySplit

DSL object for configuring per-density splits options.

DependenciesInfo

DSL object to specify whether to include SDK dependency information in APKs and Bundles.

DependenciesInfo

Read-only object to access dependencies information properties during com.android.build.api.dsl.CommonExtension.onVariantProperties

DirectoryInput

A QualifiedContent of type directory.

DynamicDelivery

DSL object to configure dynamic delivery of an asset pack.

DynamicFeatureBaseFlavor

DynamicFeatureBuildFeatures

A list of build features that can be disabled or enabled in an Android Dynamic Feature project.

DynamicFeatureBuildType

DynamicFeatureDefaultConfig

DynamicFeatureExtension

Extension for the Android Dynamic Feature Gradle Plugin.

DynamicFeatureProductFlavor

DynamicFeatureVariant

DynamicFeatureVariantDimension

DynamicFeatureVariantProperties

E

ExternalNativeBuild

DSL object to configure external native builds using CMake or ndk-build

ExternalNativeBuildOptions

DSL object for per-variant CMake and ndk-build configurations, such as toolchain arguments and compiler flags.

ExternalNativeCmakeOptions

DSL object for per-variant CMake options, such as CMake arguments and compiler flags.

ExternalNativeNdkBuildOptions

DSL object for per-variant ndk-build options, such as ndk-build arguments and compiler flags.

F

FileNames

Known file names for artifacts that will be stored in the final APK.

FilterConfiguration

Immutable filter configuration.

FilterConfiguration.FilterType

Split dimension type

FilteredComponentActionRegistrar

Allows registering Actions on ComponentT, with the ability to include filters to target sub sets of ComponentT.

FlavoredComponentActionRegistrar

Allows registering Actions on ComponentT, with the ability to include filters to target sub sets of ComponentT.

Format

The format in which content is stored.

G

GenericFilteredComponentActionRegistrar

Allows registering Actions on ComponentT, with the ability to include filters to target sub sets of ComponentT.

I

InAndOutDirectoryOperationRequest

InAndOutFileOperationRequest

Operations performed by a Task with a single RegularFile or Directory output.

J

JacocoOptions

DSL object for configuring JaCoCo settings.

JarInput

A QualifiedContent of type jar.

JavaCompileOptions

DSL object for javaCompileOptions.

L

LibraryBaseFlavor

LibraryBuildFeatures

A list of build features that can be disabled or enabled in an Android Library project.

LibraryBuildType

LibraryDefaultConfig

LibraryExtension

Extension for the Android Library Gradle Plugin.

LibraryProductFlavor

LibraryVariant

Variant type for library projects

LibraryVariantDimension

LibraryVariantProperties

VariantProperties for Library projects

LintOptions

DSL object for configuring lint options.

M

MultipleArtifactType

Public Artifact for Android Gradle plugin.

N

Ndk

DSL object for per-variant NDK settings, such as the ABI filter.

NdkBuild

DSL object for per-module ndk-build configurations, such as the path to your Android.mk build script and external native build output directory.

O

OutOperationRequest

Operations performed by a Task with a single RegularFile or Directory output.

P

PackagingOptions

PrefabPackagingOptions

Options for including Prefab packages in AARs.

ProductFlavor

Encapsulates all product flavors properties for this project.

ProductFlavorAttr

Type for the attribute holding ProductFlavor information.

Q

QualifiedContent

Represent content qualified with one or more ContentType and one or more Scope.

QualifiedContent.ContentType

A content type that is requested through the transform API.

QualifiedContent.DefaultContentType

The type of of the content.

QualifiedContent.Scope

The scope of the content.

QualifiedContent.ScopeType

Definition of a scope.

S

SdkComponents

SecondaryFile

A secondary input file(s) for a Transform.

SecondaryInput

Represents a change event for a SecondaryFile transform input.

Shaders

Options for configuring scoped shader options.

SigningConfig

DSL object to configure signing configs.

SplitOptions

Base data representing how an FULL_APK should be split for a given dimension (density, abi).

Splits

DSL object for configuring APK Splits options.

Status

The file changed status for incremental execution.

T

TaskBasedOperation

Interface with methods to wire input and output method references to Task-based operations.

TestBaseFlavor

TestBuildFeatures

A list of build features that can be disabled or enabled in an Android Test project.

TestBuildType

TestComponent

TestComponentProperties

TestDefaultConfig

TestedExtension

Common extension properties for the Android Application.

TestExtension

Extension for the Android Test Gradle Plugin.

TestOptions

Options for running tests.

TestProductFlavor

TestVariant

Variant type for tests associated with a module.

TestVariantDimension

TestVariantProperties

VariantProperties for test-only modules.

Transform

A Transform that processes intermediary build artifacts.

TransformException

An exception during the execution of a Transform.

TransformInput

The input to a Transform.

TransformInvocation

An invocation object used to pass of pertinent information for a Transform#transform(TransformInvocation) call.

TransformOutputProvider

The output of a transform.

U

UnitTest

Variant of the unit test artifact

UnitTestOptions

Options for controlling unit tests execution.

UnitTestProperties

Properties for the unit test Variant of a module

V

Variant

Variant object that contains properties that must be set during configuration time as it changes the build flow for the variant.

VariantAttr

Type for the attribute holding the variant name information.

VariantDimension

Shared properties between DSL objects that contribute to a variant.

VariantFilter

Interface for variant control, allowing to query a variant for some base data and allowing to disable some variants.

VariantInfo

Information about the variant being built.

VariantOutput

Defines a variant output.

VariantOutputConfiguration

VariantOutputConfiguration.OutputType

Type of package file, either the main APK or a full split APK file containing resources for a particular split dimension.

VariantProperties

Parent interface for all types of variants.

VectorDrawables

DSL object used to configure vector drawable options.