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

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.OutputDirConnection>)

overrides the way the task is 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

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.

Properties

alwaysGenerateTypesMatching

abstract override 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 override val codegenModels: Property<String>

What codegen to use.

customScalarsMapping

abstract override val customScalarsMapping: MapProperty<String, String>

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

debugDir

abstract override val debugDir: DirectoryProperty

A debug directory where the compiler will output intermediary results

exclude

abstract override val exclude: ListProperty<String>

Files to exclude as in org.gradle.api.tasks.util.PatternFilterableThe empty list by default

failOnWarnings

abstract override val failOnWarnings: Property<Boolean>

Fail the build if there are warnings.

flattenModels

abstract override val flattenModels: Property<Boolean>

Whether to flatten the models.

generateApolloMetadata

abstract override val generateApolloMetadata: Property<Boolean>

Whether to generate Apollo metadata.

generateAsInternal

abstract override val generateAsInternal: Property<Boolean>

Whether to generate Kotlin models with internal visibility modifier.

generateFragmentImplementations

abstract override val generateFragmentImplementations: Property<Boolean>

Whether to generate default implementation classes for GraphQL fragments.

generateKotlinModels

abstract override val generateKotlinModels: Property<Boolean>

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

generateOperationOutput

abstract override val generateOperationOutput: Property<Boolean>

Whether to generate the operationOutput.

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.

graphqlSourceDirectorySet

val graphqlSourceDirectorySet: SourceDirectorySet

include

abstract override val include: ListProperty<String>

Files to include as in org.gradle.api.tasks.util.PatternFilterableDefault: "**/*.graphql", "**/*.

introspection

var introspection: DefaultIntrospection? = null

name

open override val name: String

objects

val objects: ObjectFactory

operationIdGenerator

abstract override 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 override val operationOutputFile: RegularFileProperty

The file where the operation output will be written.

operationOutputGenerator

abstract override val operationOutputGenerator: Property<OperationOutputGenerator>

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

outputDir

abstract override val outputDir: DirectoryProperty

The directory where the generated models will be written.

outputDirAction

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

packageName

abstract override val packageName: Property<String>

The package name of the models.

packageNameGenerator

abstract override val packageNameGenerator: Property<PackageNameGenerator>

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

project

val project: Project

registry

var registry: DefaultRegistry? = null

schemaFile

abstract override val schemaFile: RegularFileProperty

A shorthand property that will be used if schemaFiles is empty

schemaFiles

abstract override val schemaFiles: ConfigurableFileCollection

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

sourceFolder

abstract override val sourceFolder: Property<String>

Where to look for GraphQL sources.

useSemanticNaming

abstract override val useSemanticNaming: Property<Boolean>

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

warnOnDeprecatedUsages

abstract override val warnOnDeprecatedUsages: Property<Boolean>

Warn if using a deprecated fieldDefault value: true

Extensions

lazySchemaFiles

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