Class Index

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

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

A

AaptOptions

AarMetadata

DSL object for configuring AAR metadata.

AarMetadata

Variant object for configuring AAR metadata.

AbiSplit

DSL object for configuring per-abi splits options.

AdbOptions

Options for the adb tool.

AndroidBasePlugin

Common plugin applied by all plugins.

AndroidComponentsExtension

Generic extension for Android Gradle Plugin related components.

AndroidPluginVersion

Represents a version of the Android Gradle Plugin

AndroidResources

DSL object for configuring aapt options.

AndroidResources

Defines a variant's aapt options.

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

Properties for the android test Variant of a module.

AndroidVersion

AnnotationProcessorOptions

Options for configuring Java annotation processor.

ApkExtension

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

ApkPackaging

Defines an APK variant's packaging options.

ApkSigningConfig

DSL object to configure signing configs.

ApplicationAndroidComponentsExtension

Extension for Application module variant.

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

Properties for the main Variant of an application.

ApplicationVariantBuilder

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

ApplicationVariantDimension

Artifact

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

Artifact.Appendable

Denotes an artifact type that can be appended to.

Artifact.Category

Defines the kind of artifact type.

Artifact.ContainsMany

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

Artifact.Multiple

Denotes possible multiple FileSystemLocation instances for this artifact type.

Artifact.Replaceable

Denotes an artifact type that can be replaced.

Artifact.Single

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 SingleArtifact.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.

AsmClassVisitorFactory

A factory to create class visitor objects to instrument classes.

AssetPackBundleExtension

AssetPackBundlePlugin

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.

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

BundleDeviceTier

BundleLanguage

BundleTexture

C

ClassContext

ClassData

Data about the class to be instrumented.

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

ComponentBuilder

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

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.extension.AndroidComponentsExtension#onVariants

DependenciesInfoBuilder

Device

Top-level interface for all devices to run applications by tasks in the Android Gradle Plugin.

DeviceGroup

A group of devices to be run with tests using the Unified Test Platform.

DexPackagingOptions

Packaging options for Dex (Android Dalvik Executable) files

DexPackagingOptions

Defines an APK variant's packaging options for dex files.

DirectoryInput

A QualifiedContent of type directory.

DslExtension

Third party DSL extension configuration.

DslExtension.Builder

Creates a Builder to instance to create a DslExtension containing all desired extension points to the Android Gradle Plugin DSL.

DynamicDelivery

DSL object to configure dynamic delivery of an asset pack.

DynamicFeatureAndroidComponentsExtension

Extension for Dynamic Feature module variant.

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

DynamicFeatureVariantBuilder

DynamicFeatureVariantDimension

E

EmulatorSnapshots

Options for configuring Android Test Retention.

ExternalNativeBuild

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

ExternalNativeBuild

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.

ExternalNdkBuild

Interface for ndk-build per-variant info.

F

FailureRetention

Options for configuring Android Test Retention.

FilterConfiguration

Immutable filter configuration.

FilterConfiguration.FilterType

Split dimension type

Format

The format in which content is stored.

FramesComputationMode

Indicates the frame computation mode that will be applied to the bytecode of the classes instrumented by ASM visitors registered through Component.transformClassesWith.

G

GeneratesAar

GeneratesApk

Cross cutting interface for com.android.build.api.component.Component subtypes that are producing APK files.

GeneratesTestApk

H

HasAndroidResources

HasAndroidTestBuilder

Interface that mark the potential existence of android tests associated with a variant.

I

InAndOutDirectoryOperationRequest

InAndOutFileOperationRequest

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

Installation

Options for the adb tool.

InstrumentationContext

Instrumentation context data that will be injected to AsmClassVisitorFactory on instantiation.

InstrumentationParameters

Parameters for a registered AsmClassVisitorFactory.

InstrumentationParameters.None

InstrumentationScope

J

JacocoOptions

DSL object for configuring JaCoCo settings.

JarInput

A QualifiedContent of type jar.

JavaCompileOptions

DSL object for javaCompileOptions.

JniLibsApkPackaging

Defines an APK variant's packaging options for native library (.

JniLibsPackaging

Defines a variant's packaging options for native library (.

JniLibsPackagingOptions

Packaging options for native library (.

L

LibraryAndroidComponentsExtension

Extension for Library module variant.

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 for Library projects

LibraryVariantBuilder

VariantBuilder type for library projects

LibraryVariantDimension

Lint

DSL object for configuring lint options.

LintOptions

DSL object for configuring lint options.

M

ManagedVirtualDevice

Device type for emulators to be managed by the Android Gradle Plugin.

MultipleArtifact

Public Artifact for Android Gradle plugin.

MultipleArtifact.ALL_CLASSES_DIRS

All classes that will eventually be dex'ed for this module provided as directories.

MultipleArtifact.ALL_CLASSES_JARS

All classes that will eventually be dex'ed for this module provided as jar files.

MultipleArtifact.MULTIDEX_KEEP_PROGUARD

Text files with additional ProGuard rules to be used to determine which classes are compiled into the main dex file.

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

Packaging

Defines a variant's packaging options.

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.

R

Renderscript

ResourcesPackaging

ResourcesPackagingOptions

Packaging options for java resource files

ResValue

Resource to be generated by the build system.

ResValue.Key

a generated resource is identified by its type+name as you can create

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 for configuring options related to signing for APKs and bundles.

SigningConfig

Defines a variant's signing config.

SingleArtifact

Public Artifact for Android Gradle plugin.

SingleArtifact.AAR

The final AAR file as it would be published.

SingleArtifact.APK

Directory where APK files will be located.

SingleArtifact.BUNDLE

The final Bundle ready for consumption at Play Store.

SingleArtifact.MERGED_MANIFEST

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

SingleArtifact.OBFUSCATION_MAPPING_FILE

SingleArtifact.PUBLIC_ANDROID_RESOURCES_LIST

A file containing the list of public resources exported by a library project.

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.

TestAndroidComponentsExtension

Extension for Test module variant.

TestBaseFlavor

TestBuildFeatures

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

TestBuildType

TestComponent

TestCoverage

Settings related to the gathering of code-coverage data from tests

TestDefaultConfig

TestedExtension

Common extension properties for the Android Application.

TestExtension

Extension for the Android Test Gradle Plugin.

TestFixtures

TestOptions

Options for running tests.

TestProductFlavor

TestVariant

Variant for test-only modules.

TestVariantBuilder

VariantBuilder type for tests associated with a module.

TestVariantDimension

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

Properties for the unit test variant of a module.

UnitTestOptions

Options for controlling unit tests execution.

V

Variant

Parent interface for all types of variants.

VariantBuilder

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

VariantDimension

Shared properties between DSL objects that contribute to a variant.

VariantExtension

Marker type for Variant extension objects.

VariantExtensionConfig

Configuration object passed to the lambda responsible for creating a com.android.build.api.variant.VariantExtension for each com.android.build.api.variant.Variant instance.

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.

VariantSelector

Selector to reduce the number of variants that are of interests when calling any of the variant API like AndroidComponentsExtension.beforeVariants.

VectorDrawables

DSL object used to configure vector drawable options.