class CodegenMetadata(val version: String, val targetLanguage: TargetLanguage, val entries: List<ResolverEntry>, val inlineProperties: Map<String, String?>, val scalarTargets: Map<String, String>, val scalarAdapters: Map<String, String>, val scalarIsUserDefined: Map<String, Boolean>)

CodegenMetadata contains information about what target classes were generated for each GraphQL types so that downstream modules can reuse them.

CodegenOptions

@Serializable

class CodegenOptions(val targetLanguage: TargetLanguage?, val packageName: String?, val rootPackageName: String?, val decapitalizeFields: Boolean?, val useSemanticNaming: Boolean?, val generateMethods: List<GeneratedMethod>?, val operationManifestFormat: String?, val generateSchema: Boolean?, val generatedSchemaName: String?, val sealedClassesForEnumsMatching: List<String>?, val generateAsInternal: Boolean?, val addUnknownForEnums: Boolean?, val addDefaultArgumentForInputObjects: Boolean?, val generateFilterNotNull: Boolean?, val generateInputBuilders: Boolean?, val addJvmOverloads: Boolean?, val requiresOptInAnnotation: String?, val jsExport: Boolean?, val generateModelBuilders: Boolean?, val classesForEnumsMatching: List<String>?, val generatePrimitiveTypes: Boolean?, val nullableFieldStyle: JavaNullable?, val generateFragmentImplementations: Boolean?, val generateQueryDocument: Boolean?) : SchemaCodegenOptions, OperationsCodegenOptions

CodegenSchema

@Serializable

class CodegenSchema(val schema: Schema, val normalizedPath: String)

A Schema linked with other options that are bound to this schema and need to be the same in all modules using this schema

CodegenSchemaOptions

@Serializable

class CodegenSchemaOptions(val scalarTypeMapping: Map<String, String>, val scalarAdapterMapping: Map<String, String>, val generateDataBuilders: Boolean)

CommonCodegenOpt

interface CommonCodegenOpt

EntryPoints

class EntryPoints

EntryPoints contains code called using reflection from the Gradle plugin. This is so that the classloader can be isolated, and we can use our preferred version of Kotlin and other dependencies without risking conflicts.

ExpressionAdapterInitializer

@Serializable

@SerialName(value = "expression")

class ExpressionAdapterInitializer(val expression: String) : AdapterInitializer

The adapter expression will be used as-is (can be an object, a public val, a class instantiation).

GeneratedMethod

enum GeneratedMethod : Enum<GeneratedMethod>

InputFile

class InputFile(val file: File, val normalizedPath: String)

An input file together with its normalizedPath. normalizedPath is used to compute the package name in some cases

IrOptions

@Serializable

class IrOptions(val fieldsOnDisjointTypesMustMerge: Boolean?, val decapitalizeFields: Boolean?, val flattenModels: Boolean?, val warnOnDeprecatedUsages: Boolean?, val failOnWarnings: Boolean?, val addTypename: String?, val generateOptionalOperationVariables: Boolean?, val alwaysGenerateTypesMatching: Set<String>?, val codegenModels: String?)

JavaCodegenOpt

interface JavaCodegenOpt

JavaNullable

enum JavaNullable : Enum<JavaNullable>

JavaOperationsCodegenOptions

interface JavaOperationsCodegenOptions : CommonCodegenOpt, OperationsCodegenOpt, JavaCodegenOpt

JavaSchemaCodegenOptions

interface JavaSchemaCodegenOptions : CommonCodegenOpt, SchemaCodegenOpt, JavaCodegenOpt

KotlinCodegenOpt

interface KotlinCodegenOpt

KotlinOperationsCodegenOptions

interface KotlinOperationsCodegenOptions : CommonCodegenOpt, OperationsCodegenOpt, KotlinCodegenOpt

KotlinSchemaCodegenOptions

interface KotlinSchemaCodegenOptions : CommonCodegenOpt, SchemaCodegenOpt, KotlinCodegenOpt

LayoutFactory

fun interface LayoutFactory

OperationIdsGenerator

fun interface OperationIdsGenerator

OperationsCodegenOpt

interface OperationsCodegenOpt

OperationsCodegenOptions

interface OperationsCodegenOptions : JavaOperationsCodegenOptions, KotlinOperationsCodegenOptions

OperationsTransform

fun interface OperationsTransform

A OperationsTransform transforms operations and fragments at build time. OperationsTransform can add or remove fields automatically, for an example.

Order

sealed interface Order

RuntimeAdapterInitializer

@Serializable

@SerialName(value = "runtime")

object RuntimeAdapterInitializer : AdapterInitializer

The adapter instance will be looked up in the com.apollographql.apollo.api.CustomScalarAdapters provided at runtime.

SchemaCodegenOpt

interface SchemaCodegenOpt

SchemaCodegenOptions

interface SchemaCodegenOptions : JavaSchemaCodegenOptions, KotlinSchemaCodegenOptions

SchemaListener

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v5_0_0)

interface ~~SchemaListener~~

SchemaTransform

fun interface SchemaTransform

TargetLanguage

enum TargetLanguage : Enum<TargetLanguage>

Transform

fun interface Transform<T>

Transforms a type

UsedCoordinates

@Serializable

class UsedCoordinates

Properties

ADD_TYPENAME_ALWAYS

const val ADD_TYPENAME_ALWAYS: String

ADD_TYPENAME_IF_ABSTRACT

const val ADD_TYPENAME_IF_ABSTRACT: String

ADD_TYPENAME_IF_FRAGMENTS

const val ADD_TYPENAME_IF_FRAGMENTS: String

ADD_TYPENAME_IF_POLYMORPHIC

const val ADD_TYPENAME_IF_POLYMORPHIC: String

APOLLO_VERSION

const val APOLLO_VERSION: String

MANIFEST_NONE

const val MANIFEST_NONE: String

MANIFEST_OPERATION_OUTPUT

@ApolloDeprecatedSince(version = ApolloDeprecatedSince.Version.v4_0_1)

const val ~~MANIFEST_OPERATION_OUTPUT~~: String

MANIFEST_PERSISTED_QUERY

const val MANIFEST_PERSISTED_QUERY: String

MODELS_OPERATION_BASED

const val MODELS_OPERATION_BASED: String

MODELS_OPERATION_BASED_WITH_INTERFACES

const val MODELS_OPERATION_BASED_WITH_INTERFACES: String

MODELS_RESPONSE_BASED

const val MODELS_RESPONSE_BASED: String

Functions

buildCodegenOptions

fun buildCodegenOptions(targetLanguage: TargetLanguage? = null, decapitalizeFields: Boolean? = null, useSemanticNaming: Boolean? = null, generateMethods: List<GeneratedMethod>? = null, operationManifestFormat: String? = null, generateSchema: Boolean? = null, generatedSchemaName: String? = null, sealedClassesForEnumsMatching: List<String>? = null, generateAsInternal: Boolean? = null, addUnknownForEnums: Boolean? = null, addDefaultArgumentForInputObjects: Boolean? = null, generateFilterNotNull: Boolean? = null, generateInputBuilders: Boolean? = null, addJvmOverloads: Boolean? = null, requiresOptInAnnotation: String? = null, jsExport: Boolean? = null, generateModelBuilders: Boolean? = null, classesForEnumsMatching: List<String>? = null, generatePrimitiveTypes: Boolean? = null, nullableFieldStyle: JavaNullable? = null, generateFragmentImplementations: Boolean? = null, generateQueryDocument: Boolean? = null, packageName: String? = null, rootPackageName: String? = null): CodegenOptions

buildIrOptions

fun buildIrOptions(fieldsOnDisjointTypesMustMerge: Boolean? = null, decapitalizeFields: Boolean? = null, flattenModels: Boolean? = null, warnOnDeprecatedUsages: Boolean? = null, failOnWarnings: Boolean? = null, addTypename: String? = null, generateOptionalOperationVariables: Boolean? = null, alwaysGenerateTypesMatching: Set<String>? = null, codegenModels: String? = null): IrOptions

capitalizeFirstLetter

fun String.capitalizeFirstLetter(): String

A variation of String.capitalize that:

decapitalizeFirstLetter

fun String.decapitalizeFirstLetter(): String

A variation of String.decapitalize that:

findCodegenSchemaFile