Gradle Plugin/kotlinx.rpc.buf.tasks/BufGenerateTask

BufGenerateTask

Available in a dev version: 0․11․0-grpc-186

How to configure

abstract class BufGenerateTask : BufExecTask(source)

Buf generate command.

See also

Properties

Link copied to clipboard
@get:Internal
open override var actions: List<Action<in Task?>?>?
Link copied to clipboard
@get:Input
@get:Optional
abstract val additionalArgs: ListProperty<String>

Additional arguments for buf generate command.

Link copied to clipboard
@get:Internal
open override val ant: AntBuilder?
Link copied to clipboard
@get:Input
abstract val args: ListProperty<String>

Arguments for the buf command.

Link copied to clipboard
@get:Internal
open val asDynamicObject: DynamicObject
Link copied to clipboard
@get:Input
abstract val bufTimeoutInWholeSeconds: Property<Long>
Link copied to clipboard
@get:Input
abstract val command: Property<String>

The buf command to execute.

Link copied to clipboard
@get:InputFile
@get:Optional
abstract val configFile: Property<File>

The buf.yaml file to use via --config option.

Link copied to clipboard
@get:Input
abstract val debug: Property<Boolean>

Whether to enable debug logging for the buf command using --debug option.

Link copied to clipboard
@get:Internal
open override val dependsOn: Set<Any?>?
Link copied to clipboard
@get:Internal
open override var description: @Nullable String?
Link copied to clipboard
@get:Internal
open override val destroyables: TaskDestroyables?
Link copied to clipboard
@get:Internal
open override var didWork: Boolean
Link copied to clipboard
@get:Internal
open override var enabled: Boolean
Link copied to clipboard
@get:Input
abstract val errorFormat: Property<BufGenerateExtension.ErrorFormat>

--error-format option.

Link copied to clipboard
@get:InputFiles
abstract val executableFiles: ListProperty<File>

List of executable files used during buf generate command execution.

Link copied to clipboard
@get:Internal
open override val extensions: ExtensionContainer?
Link copied to clipboard
@get:Internal
open override val finalizedBy: TaskDependency?
Link copied to clipboard
@get:Internal
open override var group: @Nullable String?
Link copied to clipboard
open val identityPath: Path?
Link copied to clipboard
Link copied to clipboard
@get:Input
abstract val includeImports: Property<Boolean>

Whether to include imports.

Link copied to clipboard
@get:Input
abstract val includeWkt: Property<Boolean>

Whether to include Well-Known Types.

Link copied to clipboard
open override val inputs: TaskInputsInternal?
Link copied to clipboard
Link copied to clipboard
@get:Internal
open var isEnabled: Boolean
Link copied to clipboard
Link copied to clipboard
@get:Internal
open val lifecycleDependencies: TaskDependencyInternal?
Link copied to clipboard
@get:Internal
open override val localState: TaskLocalState?
Link copied to clipboard
@get:Input
abstract val logFormat: Property<BufExtension.LogFormat>
Link copied to clipboard
@get:Internal
open override val logger: Logger?
Link copied to clipboard
@get:Internal
open override val logging: LoggingManager?
Link copied to clipboard
@get:Internal
open override val mustRunAfter: TaskDependency?
Link copied to clipboard
@get:Internal
open override val name: String?
Link copied to clipboard
open val onlyIf: Spec<in TaskInternal?>?
Link copied to clipboard
@get:OutputDirectory
abstract val outputDirectory: Property<File>

The directory to output generated files to, used as a buf generate --output argument, not the directory for sources. For that see outputSourceDirectories.

Link copied to clipboard
open override val outputs: TaskOutputsInternal?
Link copied to clipboard
@get:OutputDirectories
val outputSourceDirectories: Provider<List<File>>

Generated source directories by plugin name.

Link copied to clipboard
@get:Internal
open override val path: String?
Link copied to clipboard
@get:Input
abstract val pluginNames: ListProperty<String>

List of plugin names used during buf generate command execution.

Link copied to clipboard
@get:Internal
open override val project: Project?
Link copied to clipboard
@get:Internal
override val properties: ProtoTask.Properties
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open val requiredServices: TaskRequiredServices?
Link copied to clipboard
@get:Internal
protected open val services: ServiceRegistry?
Link copied to clipboard
open val sharedResources: List<ResourceLock?>?
Link copied to clipboard
@get:Internal
open override val shouldRunAfter: TaskDependency?
Link copied to clipboard
open val standardOutputCapture: StandardOutputCapture?
Link copied to clipboard
open override val state: TaskStateInternal?
Link copied to clipboard
open val taskActions: List<InputChangesAwareTaskAction?>?
Link copied to clipboard
open override val taskDependencies: TaskDependencyInternal?
Link copied to clipboard
open val taskIdentity: TaskIdentity<*>?
Link copied to clipboard
@get:Internal
open override val temporaryDir: File?
Link copied to clipboard
open val temporaryDirFactory: Factory<File?>?
Link copied to clipboard
@get:Internal
open override val timeout: Property<Duration?>?
Link copied to clipboard
@get:InputDirectory
@get:Classpath
abstract val workingDir: Property<File>

The working directory for the buf command.

Functions

Link copied to clipboard
open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)
Link copied to clipboard
open fun appendParallelSafeAction(action: Action<in Task?>?)
Link copied to clipboard
open operator fun compareTo(other: Task?): Int
Link copied to clipboard
open fun configure(configureClosure: Closure<*>?): Task?
Link copied to clipboard
open fun dependsOn(vararg paths: Any?): Task?
Link copied to clipboard
open fun doFirst(@DelegatesTo(value = Task::class) action: Closure<*>?): Task?
open fun doFirst(action: Action<in Task?>?): Task?
open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?
Link copied to clipboard
open fun doLast(@DelegatesTo(value = Task::class) action: Closure<*>?): Task?
open fun doLast(action: Action<in Task?>?): Task?
open fun doLast(actionName: String?, action: Action<in Task?>?): Task?
Link copied to clipboard
open fun doNotTrackState(reasonNotToTrackState: String?)
Link copied to clipboard
open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)
Link copied to clipboard
open fun finalizedBy(vararg paths: Any?): Task?
Link copied to clipboard
@Internal
open fun getActions(): List<Action<in Task?>?>?
Link copied to clipboard
@Internal
open fun getAnt(): AntBuilder?
Link copied to clipboard
@Internal
open fun getDependsOn(): Set<Any?>?
Link copied to clipboard
@Internal
open fun getDescription(): @Nullable String?
Link copied to clipboard
@Internal
open fun getDestroyables(): TaskDestroyables?
Link copied to clipboard
@Internal
open fun getDidWork(): Boolean
Link copied to clipboard
@Internal
open fun getEnabled(): Boolean
Link copied to clipboard
@Internal
open fun getExtensions(): ExtensionContainer?
Link copied to clipboard
@Internal
open fun getFinalizedBy(): TaskDependency?
Link copied to clipboard
@Internal
open fun getGroup(): @Nullable String?
Link copied to clipboard
open fun getInputs(): TaskInputsInternal?
Link copied to clipboard
@Internal
open fun getLocalState(): TaskLocalState?
Link copied to clipboard
@Internal
open fun getLogger(): Logger?
Link copied to clipboard
@Internal
open fun getLogging(): LoggingManager?
Link copied to clipboard
@Internal
open fun getMustRunAfter(): TaskDependency?
Link copied to clipboard
@Internal
open fun getName(): String?
Link copied to clipboard
open fun getOutputs(): TaskOutputsInternal?
Link copied to clipboard
@Internal
open fun getPath(): String?
Link copied to clipboard
@Internal
open fun getProject(): Project?
Link copied to clipboard
@Internal
open fun getShouldRunAfter(): TaskDependency?
Link copied to clipboard
open fun getState(): TaskStateInternal?
Link copied to clipboard
open fun getTaskDependencies(): TaskDependencyInternal?
Link copied to clipboard
@Internal
open fun getTemporaryDir(): File?
Link copied to clipboard
@Internal
open fun getTimeout(): Property<Duration?>?
Link copied to clipboard
open fun hasProperty(propertyName: String?): Boolean
Link copied to clipboard
open fun hasTaskActions(): Boolean
Link copied to clipboard
open fun mustRunAfter(vararg paths: Any?): Task?
Link copied to clipboard
Link copied to clipboard
open fun onlyIf(onlyIfClosure: Closure<*>?)
open fun onlyIf(onlyIfSpec: Spec<in Task?>?)
@Incubating
open fun onlyIf(onlyIfReason: String?, onlyIfSpec: Spec<in Task?>?)
Link copied to clipboard
open fun prependParallelSafeAction(action: Action<in Task?>?)
Link copied to clipboard
open fun property(propertyName: String?): @Nullable Any?
Link copied to clipboard
open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal?>?)
Link copied to clipboard
open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)
Link copied to clipboard
open fun setActions(actions: List<Action<in Task?>?>?)
Link copied to clipboard
open fun setDependsOn(dependsOnTasks: Iterable<*>?)
Link copied to clipboard
open fun setDescription(description: @Nullable String?)
Link copied to clipboard
open fun setDidWork(didWork: Boolean)
Link copied to clipboard
open fun setEnabled(enabled: Boolean)
Link copied to clipboard
open fun setFinalizedBy(finalizedBy: Iterable<*>?)
Link copied to clipboard
open fun setGroup(group: @Nullable String?)
Link copied to clipboard
open fun setMustRunAfter(mustRunAfter: Iterable<*>?)
Link copied to clipboard
open fun setOnlyIf(onlyIfClosure: Closure<*>?)
open fun setOnlyIf(onlyIfSpec: Spec<in Task?>?)
@Incubating
open fun setOnlyIf(onlyIfReason: String?, onlyIfSpec: Spec<in Task?>?)
Link copied to clipboard
open fun setProperty(name: String?, value: Any?)
Link copied to clipboard
open fun setShouldRunAfter(shouldRunAfter: Iterable<*>?)
Link copied to clipboard
open fun shouldRunAfter(vararg paths: Any?): TaskDependency?
Link copied to clipboard
open fun usesService(service: Provider<out BuildService<*>?>?)
Generated by Dokka
© 2026 JetBrains s.r.o and contributors. Apache License 2.0