ApolloExtension

The entry point for configuring the apollo plugin.

Functions

createAllAndroidVariantServices

abstract fun createAllAndroidVariantServices(sourceFolder: String, nameSuffix: String, action: Action<Service>)

registers multiple services for an android projectAndroid projects have variants for buildType/flavor combinations as well as test.

createAllKotlinSourceSetServices

abstract fun createAllKotlinSourceSetServices(sourceFolder: String, nameSuffix: String, action: Action<Service>)

registers multiple services for a Kotlin projectThis will create a GraphQL service for each source set and add the sources to the KotlinCompile task.

introspection

abstract fun introspection(configure: Action<in Introspection>)

Configures Introspection to download an introspection Json schema

operationOutputConnection

abstract fun operationOutputConnection(action: Action<in Service.OperationOutputConnection>)

overrides the way operationOutput is connected.

outputDirConnection

abstract fun outputDirConnection(action: Action<in Service.DirectoryConnection>)

Overrides the way the generated models are connected.

packageNamesFromFilePaths

abstract fun packageNamesFromFilePaths(rootPackageName: String? = null)

A helper method to configure a PackageNameGenerator that will use the file path relative to the source roots to generate the packageNames

registry

abstract fun registry(configure: Action<in Registry>)

Configures Registry to download a SDL schema from a studio registry

service

abstract fun service(name: String, action: Action<Service>)

registers a new service

srcDir

abstract fun srcDir(directory: Any)

Adds the given directory as a GraphQL source rootUse srcDir if your files are outside "src/main/graphql" or to have them in multiple folders.

testDirConnection

abstract fun testDirConnection(action: Action<in Service.DirectoryConnection>)

Overrides the way the generated test builders are connected.

useVersion2Compat

abstract fun useVersion2Compat(rootPackageName: String? = null)

A shorthand method that configures defaults that match Apollo Android 2.

Properties

alwaysGenerateTypesMatching

abstract val alwaysGenerateTypesMatching: SetProperty<String>

A list of Regex patterns for input/scalar/enum types that should be generated whether they are used by queries/fragments in this module.

codegenModels

abstract val codegenModels: Property<String>

What codegen to use.

customScalarsMapping

abstract val customScalarsMapping: MapProperty<String, String>

For custom scalar types like Date, map from the GraphQL type to the java/kotlin type.

customTypeMapping

abstract val customTypeMapping: MapProperty<String, String>

debugDir

abstract val debugDir: DirectoryProperty

A debug directory where the compiler will output intermediary results

excludes

abstract val excludes: ListProperty<String>

Operation files to exclude.

failOnWarnings

abstract val failOnWarnings: Property<Boolean>

Fail the build if there are warnings.

flattenModels

abstract val flattenModels: Property<Boolean>

Whether to flatten the models.

generateApolloMetadata

abstract val generateApolloMetadata: Property<Boolean>

Whether to generate Apollo metadata.

generateAsInternal

abstract val generateAsInternal: Property<Boolean>

Whether to generate Kotlin models with internal visibility modifier.

generateFragmentImplementations

abstract val generateFragmentImplementations: Property<Boolean>

Whether to generate default implementation classes for GraphQL fragments.

generateKotlinModels

abstract val generateKotlinModels: Property<Boolean>

Whether to generate Kotlin or Java models Default to true if the Kotlin plugin is found

generateOperationOutput

abstract val generateOperationOutput: Property<Boolean>

Whether to generate the operationOutput.

generateOptionalOperationVariables

abstract val generateOptionalOperationVariables: Property<Boolean>

Whether to generate operation variables as com.apollographql.apollo3.api.OptionalUsing com.apollographql.apollo3.api.Optional allows to omit the variables if needed but makes the callsite more verbose in most cases.

generateQueryDocument

abstract val generateQueryDocument: Property<Boolean>

Whether to write the query document in models

generateSchema

abstract val generateSchema: Property<Boolean>

Whether to generate the __Schema class.

generateTestBuilders

abstract val generateTestBuilders: Property<Boolean>

Whether to generate the type safe Data builders.

includes

abstract val includes: ListProperty<String>

Operation files to include.

languageVersion

abstract val languageVersion: Property<String>

Target language version for the generated code.

linkSqlite

abstract val linkSqlite: Property<Boolean>

For Kotlin native projects, whether to link Sqlite (-lsqlite3).

name

abstract val name: String

operationIdGenerator

abstract val operationIdGenerator: Property<OperationIdGenerator>

By default, Apollo uses Sha256 hashing algorithm to generate an ID for the query.

operationOutputFile

abstract val operationOutputFile: RegularFileProperty

The file where the operation output will be written.

operationOutputGenerator

abstract val operationOutputGenerator: Property<OperationOutputGenerator>

A generator to generate the operation output from a list of operations.

outputDir

abstract val outputDir: DirectoryProperty

The directory where the generated models will be written.

packageName

abstract val packageName: Property<String>

The package name of the models.

packageNameGenerator

abstract val packageNameGenerator: Property<PackageNameGenerator>

Use packageNameGenerator to customize how to generate package names from file paths.

schemaFile

abstract val schemaFile: RegularFileProperty

A shorthand property that will be used if schemaFiles is empty

schemaFiles

abstract val schemaFiles: ConfigurableFileCollection

The schema files as either a ".json" introspection schema or a ".sdl|.graphqls" SDL schema.

sealedClassesForEnumsMatching

abstract val sealedClassesForEnumsMatching: ListProperty<String>

A list of Regex patterns for GraphQL enums that should be generated as Kotlin sealed classes instead of the default Kotlin enums.

sourceFolder

abstract val sourceFolder: Property<String>

Where to look for GraphQL sources.

testDir

abstract val testDir: DirectoryProperty

The directory where the test builders will be written.

useSemanticNaming

abstract val useSemanticNaming: Property<Boolean>

When true, the generated classes names will end with 'Query' or 'Mutation'.

warnOnDeprecatedUsages

abstract val warnOnDeprecatedUsages: Property<Boolean>

Warn if using a deprecated fieldDefault value: true

Inheritors

DefaultApolloExtension