DefaultService

abstract class DefaultService @Inject() constructor(project: Project, name: String) : Service

Functions

introspection

open override fun introspection(configure: Action<in Introspection>)

Configures Introspection to download an introspection Json schema

mapScalar

open override fun mapScalar(graphQLName: String, targetName: String)

Map a GraphQL scalar type to the Java/Kotlin type.

open override fun mapScalar(graphQLName: String, targetName: String, expression: String)

Map a GraphQL scalar type to the Java/Kotlin type and provided adapter expression.

mapScalarToJavaBoolean

open override fun mapScalarToJavaBoolean(graphQLName: String)

Map the given GraphQL scalar to java.lang.Boolean and use the builtin adapter

mapScalarToJavaDouble

open override fun mapScalarToJavaDouble(graphQLName: String)

Map the given GraphQL scalar to java.lang.Double and use the builtin adapter

mapScalarToJavaFloat

open override fun mapScalarToJavaFloat(graphQLName: String)

Map the given GraphQL scalar to java.lang.Float and use the builtin adapter

mapScalarToJavaInteger

open override fun mapScalarToJavaInteger(graphQLName: String)

Map the given GraphQL scalar to java.lang.Integer and use the builtin adapter

mapScalarToJavaLong

open override fun mapScalarToJavaLong(graphQLName: String)

Map the given GraphQL scalar to java.lang.Long and use the builtin adapter

mapScalarToJavaObject

open override fun mapScalarToJavaObject(graphQLName: String)

Map the given GraphQL scalar to java.lang.Object and use the builtin adapter

mapScalarToJavaString

open override fun mapScalarToJavaString(graphQLName: String)

Map the given GraphQL scalar to java.lang.String and use the builtin adapter

mapScalarToKotlinAny

open override fun mapScalarToKotlinAny(graphQLName: String)

Map the given GraphQL scalar to kotlin.Any and use the builtin adapter

mapScalarToKotlinBoolean

open override fun mapScalarToKotlinBoolean(graphQLName: String)

Map the given GraphQL scalar to kotlin.Boolean and use the builtin adapter

mapScalarToKotlinDouble

open override fun mapScalarToKotlinDouble(graphQLName: String)

Map the given GraphQL scalar to kotlin.Double and use the builtin adapter

mapScalarToKotlinFloat

open override fun mapScalarToKotlinFloat(graphQLName: String)

Map the given GraphQL scalar to kotlin.Float and use the builtin adapter

mapScalarToKotlinInt

open override fun mapScalarToKotlinInt(graphQLName: String)

Map the given GraphQL scalar to kotlin.Int and use the builtin adapter

mapScalarToKotlinLong

open override fun mapScalarToKotlinLong(graphQLName: String)

Map the given GraphQL scalar to kotlin.Long and use the builtin adapter

mapScalarToKotlinString

open override fun mapScalarToKotlinString(graphQLName: String)

Map the given GraphQL scalar to kotlin.String and use the builtin adapter

mapScalarToUpload

open override fun mapScalarToUpload(graphQLName: String)

Map the given GraphQL scalar to com.apollographql.apollo3.api.

operationOutputConnection

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

overrides the way operationOutput is connected.

outputDirConnection

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

Overrides the way the generated models are connected.

packageNamesFromFilePaths

open override fun packageNamesFromFilePaths(rootPackageName: String?)

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

registerOperations

open override fun registerOperations(configure: Action<in RegisterOperationsConfig>)

Configures operation safelisting (requires an Apollo Studio account)

registry

open override fun registry(configure: Action<in Registry>)

Configures Registry to download a SDL schema from a studio registry

srcDir

open override 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

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

Overrides the way the generated test builders are connected.

useVersion2Compat

open override fun useVersion2Compat(rootPackageName: String?)

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

Properties

addJvmOverloads

abstract val addJvmOverloads: Property<Boolean>

Whether to generate kotlin constructors with @JvmOverloads for more graceful Java interop experience when default values are present.

addTypename

abstract val addTypename: Property<String>

When to add __typename.

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

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_0_1)

abstract val customScalarsMapping: MapProperty<String, String>

For custom scalar types like Date, map from the GraphQL type to the Java/Kotlin type.

customTypeMapping

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v3_0_0)

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.

generatedSchemaName

abstract val generatedSchemaName: Property<String>

Class name to use when generating the Schema class.

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.

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

@ApolloExperimental()

abstract val generateTestBuilders: Property<Boolean>

Whether to generate the type safe Data builders.

graphqlSourceDirectorySet

val graphqlSourceDirectorySet: SourceDirectorySet

includes

abstract val includes: ListProperty<String>

Operation files to include.

introspection

var introspection: DefaultIntrospection? = null

languageVersion

abstract val languageVersion: Property<String>

Target language version for the generated code.

name

open override val name: String

objects

val objects: ObjectFactory

operationIdGenerator

abstract val operationIdGenerator: Property<OperationIdGenerator>

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

operationOutputAction

var operationOutputAction: Action<in Service.OperationOutputConnection>? = null

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.

outputDirAction

var outputDirAction: Action<in Service.DirectoryConnection>? = null

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.

project

val project: Project

registerOperationsConfig

var registerOperationsConfig: DefaultRegisterOperationsConfig? = null

registry

var registry: DefaultRegistry? = null

scalarAdapterMapping

val scalarAdapterMapping: MutableMap<String, String>

scalarTypeMapping

val scalarTypeMapping: MutableMap<String, String>

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.

testDirAction

var testDirAction: Action<in Service.DirectoryConnection>? = null

useSchemaPackageNameForFragments

abstract val useSchemaPackageNameForFragments: Property<Boolean>

Whether to use the schema package name for fragments.

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

Extensions

lazySchemaFiles

fun DefaultService.lazySchemaFiles(project: Project): Set<File>