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

BufExecTask

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

How to configure

@DisableCachingByDefault(because = "Custom buf subclasses must opt in to caching explicitly via @CacheableTask")

abstract class BufExecTask @Inject constructor(properties: ProtoTask.Properties) : DefaultProtoTask(source)

Abstract base class for buf tasks.

Caching is disabled at this level because generic buf invocations are not known to be deterministic. Concrete subclasses with deterministic inputs/outputs (e.g. BufGenerateTask) opt in explicitly via @CacheableTask.

Inheritors

BufGenerateTask

Constructors

BufExecTask

@Inject

constructor(properties: ProtoTask.Properties)

Properties

actions

@get:Internal

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

ant

@get:Internal

open override val ant: AntBuilder?

args

@get:Input

abstract val args: ListProperty<String>

Arguments for the buf command.

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

bufTimeoutInWholeSeconds

@get:Input

abstract val bufTimeoutInWholeSeconds: Property<Long>

command

@get:Input

abstract val command: Property<String>

The buf command to execute.

configFile

@get:InputFile

@get:PathSensitive(value = PathSensitivity.NONE)

@get:Optional

abstract val configFile: Property<File>

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

debug

@get:Input

abstract val debug: Property<Boolean>

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

dependsOn

@get:Internal

open override val dependsOn: Set<Any?>?

description

@get:Internal

open override var description: @Nullable String?

destroyables

@get:Internal

open override val destroyables: TaskDestroyables?

didWork

@get:Internal

open override var didWork: Boolean

enabled

@get:Internal

open override var enabled: Boolean

extensions

@get:Internal

open override val extensions: ExtensionContainer?

finalizedBy

@get:Internal

open override val finalizedBy: TaskDependency?

group

@get:Internal

open override var group: @Nullable String?

identityPath

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

inputs

open override 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

@get:Internal

open override val localState: TaskLocalState?

logFormat

@get:Input

abstract val logFormat: Property<BufExtension.LogFormat>

logger

@get:Internal

open override val logger: Logger?

logging

@get:Internal

open override val logging: LoggingManager?

mustRunAfter

@get:Internal

open override val mustRunAfter: TaskDependency?

name

@get:Internal

open override val name: String?

onlyIf

open val onlyIf: Spec<in TaskInternal?>?

outputs

open override val outputs: TaskOutputsInternal?

path

@get:Internal

open override val path: String?

project

@get:Internal

open override val project: Project?

properties

@get:Internal

override val properties: ProtoTask.Properties

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

requiredServices

open val requiredServices: TaskRequiredServices?

services

@get:Internal

protected open val services: ServiceRegistry?

sharedResources

open val sharedResources: List<ResourceLock?>?

shouldRunAfter

@get:Internal

open override val shouldRunAfter: TaskDependency?

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

state

open override val state: TaskStateInternal?

taskActions

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open override val taskDependencies: TaskDependencyInternal?

taskIdentity

open val taskIdentity: TaskIdentity<*>?

temporaryDir

@get:Internal

open override val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

timeout

@get:Internal

open override val timeout: Property<Duration?>?

workingDir

@get:InputDirectory

@get:Classpath

abstract val workingDir: Property<File>

The working directory for the buf command.

Functions

acceptServiceReferences

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

appendParallelSafeAction

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

compareTo

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

configure

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

dependsOn

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

doFirst

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?

doLast

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?

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String?)

doNotTrackStateIf

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

finalizedBy

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

getActions

@Internal

open fun getActions(): List<Action<in Task?>?>?

getAnt

@Internal

open fun getAnt(): AntBuilder?

getDependsOn

@Internal

open fun getDependsOn(): Set<Any?>?

getDescription

@Internal

open fun getDescription(): @Nullable String?

getDestroyables

@Internal

open fun getDestroyables(): TaskDestroyables?

getDidWork

@Internal

open fun getDidWork(): Boolean

getEnabled

@Internal

open fun getEnabled(): Boolean

getExtensions

@Internal

open fun getExtensions(): ExtensionContainer?

getFinalizedBy

@Internal

open fun getFinalizedBy(): TaskDependency?

getGroup

@Internal

open fun getGroup(): @Nullable String?

getInputs

open fun getInputs(): TaskInputsInternal?

getLocalState

@Internal

open fun getLocalState(): TaskLocalState?

getLogger

@Internal

open fun getLogger(): Logger?

getLogging

@Internal

open fun getLogging(): LoggingManager?

getMustRunAfter

@Internal

open fun getMustRunAfter(): TaskDependency?

getName

@Internal

open fun getName(): String?

getOutputs

open fun getOutputs(): TaskOutputsInternal?

getPath

@Internal

open fun getPath(): String?

getProject

@Internal

open fun getProject(): Project?

getShouldRunAfter

@Internal

open fun getShouldRunAfter(): TaskDependency?

getState

open fun getState(): TaskStateInternal?

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal?

getTemporaryDir

@Internal

open fun getTemporaryDir(): File?

getTimeout

@Internal

open fun getTimeout(): Property<Duration?>?

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(onlyIfSpec: Spec<in Task?>?)

@Incubating

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

prependParallelSafeAction

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

property

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

restoreOnlyIf

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

restoreTaskActions

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

setActions

open fun setActions(actions: List<Action<in Task?>?>?)

setDependsOn

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

setDescription

open fun setDescription(description: @Nullable String?)

setDidWork

open fun setDidWork(didWork: Boolean)

setEnabled

open fun setEnabled(enabled: Boolean)

setFinalizedBy

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

setGroup

open fun setGroup(group: @Nullable String?)

setMustRunAfter

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

setOnlyIf

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

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

@Incubating

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

setProperty

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

setShouldRunAfter

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

shouldRunAfter

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

usesService

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