graphql-kotlin-gradle-plugin/com.expediagroup.graphql.plugin.gradle.tasks/GraphQLGenerateClientTask

GraphQLGenerateClientTask

@CacheableTask

abstract class GraphQLGenerateClientTask : AbstractGenerateClientTask

Generate GraphQL Kotlin client and corresponding data classes based on the provided GraphQL queries.

Constructors

GraphQLGenerateClientTask

constructor()

Properties

open var actions: List<Action<in Task>>

allowDeprecatedFields

@Input

@Optional

val allowDeprecatedFields: Property<Boolean>

Boolean flag indicating whether selection of deprecated fields is allowed or not.

open val ant: AntBuilder

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

@Input

@Optional

val customScalars: ListProperty<GraphQLScalar>

List of custom GraphQL scalar converters.

open val dependsOn: Set<Any>

open var description: @Nullable String?

open val destroyables: TaskDestroyables

open var didWork: Boolean

open var enabled: Boolean

open val extensions: ExtensionContainer

open val finalizedBy: TaskDependency

open var group: @Nullable String?

open val identityPath: Path

impliesSubProjects

open var impliesSubProjects: Boolean

open val inputs: TaskInputsInternal

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal

open val localState: TaskLocalState

open val logger: Logger

open val logging: LoggingManager

open val mustRunAfter: TaskDependency

open val name: String

open val onlyIf: Spec<in TaskInternal>

outputDirectory

@OutputDirectory

val outputDirectory: DirectoryProperty

open val outputs: TaskOutputsInternal

@Input

val packageName: Property<String>

Target package name for generated code.

@Input

@Optional

val parserOptions: Property<GraphQLParserOptions>

open val path: String

pluginClasspath

@get:Classpath

val pluginClasspath: ConfigurableFileCollection

open val project: Project

queryFileDirectory

@InputDirectory

@Optional

@PathSensitive(value = PathSensitivity.RELATIVE)

val queryFileDirectory: DirectoryProperty

Directory containing GraphQL queries. Defaults to src/main/resources when generating main sources and src/test/resources when generating test client.

@InputFiles

@Optional

@PathSensitive(value = PathSensitivity.RELATIVE)

val queryFiles: ConfigurableFileCollection

List of query files to be processed. Instead of a list of files to be processed you can also specify queryFileDirectory directory containing all the files. If this property is specified it will take precedence over the corresponding directory property.

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String>

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String>

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String>

requiredServices

open val requiredServices: TaskRequiredServices

@InputFile

@PathSensitive(value = PathSensitivity.RELATIVE)

val schemaFile: RegularFileProperty

GraphQL schema file that will be used to generate client code.

@Input

@Optional

val serializer: Property<GraphQLSerializer>

sharedResources

open val sharedResources: List<ResourceLock>

open val shouldRunAfter: TaskDependency

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture

open val state: TaskStateInternal

open val taskActions: List<InputChangesAwareTaskAction>

taskDependencies

open val taskDependencies: TaskDependencyInternal

open val taskIdentity: TaskIdentity<*>

open val temporaryDir: File

temporaryDirFactory

open val temporaryDirFactory: Factory<File>

open val timeout: Property<Duration>

useOptionalInputWrapper

@Input

@Optional

val useOptionalInputWrapper: Property<Boolean>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

open operator fun compareTo(otherTask: Task): Int

open fun configure(closure: Closure<*>): Task

open fun dependsOn(vararg paths: Any): Task

open fun doFirst(action: Closure<*>): Task

open fun doFirst(action: Action<in Task>): Task

open fun doFirst(actionName: String, action: Action<in Task>): Task

open fun doLast(action: Closure<*>): Task

open fun doLast(action: Action<in Task>): Task

open fun doLast(actionName: String, action: Action<in Task>): Task

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String, spec: Spec<in TaskInternal>)

open fun finalizedBy(vararg paths: Any): Task

generateGraphQLClientAction

fun generateGraphQLClientAction()

getWorkerExecutor

@Inject

abstract fun getWorkerExecutor(): WorkerExecutor

open fun hasProperty(propertyName: String): Boolean

open fun hasTaskActions(): Boolean

open fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

open fun onlyIf(onlyIfClosure: Closure<*>)

open fun onlyIf(spec: Spec<in Task>)

open fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task>)

open fun property(propertyName: String): Any

open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal>)

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction>)

open fun setDependsOn(dependsOn: Iterable<*>)

open fun setFinalizedBy(finalizedByTasks: Iterable<*>)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>)

open fun setOnlyIf(onlyIfClosure: Closure<*>)

open fun setOnlyIf(spec: Spec<in Task>)

open fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

open fun setProperty(name: String, value: Any)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>)

open fun shouldRunAfter(vararg paths: Any): TaskDependency

open fun usesService(service: Provider<out BuildService<*>>)