justworks-plugin/com.avsystem.justworks.gradle/JustworksGenerateTask

JustworksGenerateTask

@CacheableTask

abstract class JustworksGenerateTask : DefaultTask(source)

Gradle task that generates Kotlin source files from an OpenAPI spec.

Parses the OpenAPI spec via SpecParser, feeds the result to CodeGenerator, and writes the generated Kotlin source files to the output directory.

Constructors

JustworksGenerateTask

constructor()

Properties

actions

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

ant

open val ant: AntBuilder?

apiClassPrefix

@get:Input

abstract val apiClassPrefix: Property<String>

Prefix for generated API client class names.

apiClassSuffix

@get:Input

abstract val apiClassSuffix: Property<String>

Suffix for generated API client class names.

apiPackage

@get:Input

abstract val apiPackage: Property<String>

Package for generated API client classes.

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

dependsOn

open val dependsOn: Set<Any?>?

description

open var description: @Nullable String?

destroyables

open val destroyables: TaskDestroyables?

didWork

open var didWork: Boolean

enabled

open var enabled: Boolean

extensions

open val extensions: ExtensionContainer?

finalizedBy

open val finalizedBy: TaskDependency?

generateInterfaces

@get:Input

abstract val generateInterfaces: Property<Boolean>

Whether to generate an interface per API tag implemented by the client.

generateKdoc

@get:Input

abstract val generateKdoc: Property<Boolean>

Whether to emit KDoc comments in generated code.

group

open var group: @Nullable String?

identityPath

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

inputs

open val inputs: TaskInputsInternal?

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

isEnabled

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

localState

open val localState: TaskLocalState?

logger

open val logger: Logger?

logging

open val logging: LoggingManager?

modelPackage

@get:Input

abstract val modelPackage: Property<String>

Package for generated model/data classes.

mustRunAfter

open val mustRunAfter: TaskDependency?

name

open val name: String?

onlyIf

open val onlyIf: Spec<in TaskInternal?>?

outputDir

@get:OutputDirectory

abstract val outputDir: DirectoryProperty

Output directory for generated Kotlin source files.

outputs

open val outputs: TaskOutputsInternal?

path

open val path: String?

project

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?>?

shouldRunAfter

open val shouldRunAfter: TaskDependency?

specFile

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val specFile: RegularFileProperty

Path to the OpenAPI spec file.

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

state

open val state: TaskStateInternal?

taskActions

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

taskIdentity

open val taskIdentity: TaskIdentity<*>?

temporaryDir

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

timeout

open val timeout: Property<Duration?>?

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)

appendParallelSafeAction

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

compareTo

open operator fun compareTo(otherTask: Task?): Int

configure

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

dependsOn

open fun dependsOn(vararg paths: Any?): Task?

doFirst

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

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

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

doLast

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

finalizedBy

open fun finalizedBy(vararg paths: Any?): Task?

generate

fun generate()

hasProperty

open fun hasProperty(propertyName: String?): Boolean

hasTaskActions

open fun hasTaskActions(): Boolean

mustRunAfter

open fun mustRunAfter(vararg paths: Any?): Task?

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String?)

onlyIf

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

property

open fun property(propertyName: String?): Any?

restoreOnlyIf

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

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)

setDependsOn

open fun setDependsOn(dependsOn: Iterable<*>?)

setFinalizedBy

open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)

setOnlyIf

open fun setOnlyIf(onlyIfClosure: Closure<*>?)

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

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

setProperty

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

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)

shouldRunAfter

open fun shouldRunAfter(vararg paths: Any?): TaskDependency?

usesService

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