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

GraphQLIntrospectSchemaTask

@DisableCachingByDefault(because = "Introspects schema from a remote endpoint")

abstract class GraphQLIntrospectSchemaTask : DefaultTask

Task that executes GraphQL introspection query against specified endpoint and saves the underlying schema file.

Constructors

GraphQLIntrospectSchemaTask

constructor()

Properties

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

open val ant: AntBuilder

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

open val dependsOn: Set<Any>

open var description: @Nullable String?

open val destroyables: TaskDestroyables

open var didWork: Boolean

open var enabled: Boolean

@Input

val endpoint: Property<String>

Target GraphQL server endpoint that will be used to execute introspection queries.

open val extensions: ExtensionContainer

open val finalizedBy: TaskDependency

open var group: @Nullable String?

@Input

val headers: MapProperty<String, Any>

Optional HTTP headers to be specified on an introspection query.

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>

@OutputFile

val outputFile: RegularFileProperty

Target GraphQL schema file to be generated.

open val outputs: TaskOutputsInternal

open val path: String

pluginClasspath

@get:Classpath

val pluginClasspath: ConfigurableFileCollection

open val project: Project

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String>

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String>

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String>

requiredServices

open val requiredServices: TaskRequiredServices

sharedResources

open val sharedResources: List<ResourceLock>

open val shouldRunAfter: TaskDependency

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture

open val state: TaskStateInternal

@Input

val streamResponse: Property<Boolean>

Boolean property to indicate whether to use streamed (chunked) responses.

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>

@Input

val timeoutConfig: Property<TimeoutConfiguration>

Timeout configuration that specifies maximum amount of time (in milliseconds) to connect and execute introspection query before we cancel the request. Defaults to Ktor CIO engine defaults (5 seconds for connect timeout and 15 seconds for read timeout).

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

getWorkerExecutor

@Inject

abstract fun getWorkerExecutor(): WorkerExecutor

open fun hasProperty(propertyName: String): Boolean

open fun hasTaskActions(): Boolean

introspectSchemaAction

fun introspectSchemaAction()

Executes introspection query against specified endpoint and saves the resulting schema locally in the target output file.

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<*>>)