Gradle Plugin/kotlinx.rpc.protoc/ProcessProtoFiles

ProcessProtoFiles

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

How to configure

@DisableCachingByDefault(because = "File copy task — caching overhead outweighs benefit")

abstract class ProcessProtoFiles : Sync, ProtoTask(source)

Copy proto files to a temporary directory for Buf to process.

Caching is disabled because this is a file-copy task — Gradle's default heuristic is that copy/sync tasks are not worth caching (the cost of fetching a cached artifact exceeds the cost of re-copying local files).

Properties

actions

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

ant

open override val ant: AntBuilder?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

conventionMapping

@get:Internal

open val conventionMapping: ConventionMapping?

deleter

@get:Inject

protected abstract val deleter: Deleter?

dependsOn

open override val dependsOn: Set<Any?>?

description

open override var description: @Nullable String?

destinationDir

@get:OutputDirectory

open var destinationDir: File?

destroyables

open override val destroyables: TaskDestroyables?

didWork

open override var didWork: Boolean

directoryFileTreeFactory

@get:Inject

protected abstract val directoryFileTreeFactory: DirectoryFileTreeFactory

dirPermissions

@get:Internal

open val dirPermissions: Property<ConfigurableFilePermissions>

documentationRegistry

@get:Inject

protected abstract val documentationRegistry: DocumentationRegistry

duplicatesStrategy

@get:Internal

open var duplicatesStrategy: DuplicatesStrategy

enabled

open override var enabled: Boolean

excludes

@get:Internal

open val excludes: Set<String>

extensions

open override val extensions: ExtensionContainer?

fileLookup

@get:Inject

protected abstract val fileLookup: FileLookup

filePermissions

@get:Internal

open val filePermissions: Property<ConfigurableFilePermissions>

fileResolver

@get:Inject

protected abstract val fileResolver: FileResolver

fileSystem

@get:Inject

protected abstract val fileSystem: FileSystem

filteringCharset

@get:Internal

open var filteringCharset: String

finalizedBy

open override val finalizedBy: TaskDependency?

group

open override var group: @Nullable String?

identityPath

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

includeEmptyDirs

@get:Internal

open var includeEmptyDirs: Boolean

includes

@get:Internal

open val includes: Set<String>

inputs

open override val inputs: TaskInputsInternal?

instantiator

@get:Inject

protected abstract val instantiator: Instantiator

isCaseSensitive

@get:Internal

open var isCaseSensitive: Boolean

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 override val localState: TaskLocalState?

logger

open override val logger: Logger?

logging

open override val logging: LoggingManager?

mainSpec

@get:Internal

protected open val mainSpec: CopySpecInternal

mustRunAfter

open override val mustRunAfter: TaskDependency?

name

open override val name: String?

objectFactory

@get:Inject

protected abstract val objectFactory: ObjectFactory

onlyIf

open val onlyIf: Spec<in TaskInternal?>?

outputs

open override val outputs: TaskOutputsInternal?

path

open override val path: String?

preserve

@get:Internal

open val preserve: PatternFilterable?

project

open override val project: Project?

properties

@get:Internal

open override val properties: ProtoTask.Properties

propertyFactory

@get:Inject

protected abstract val propertyFactory: PropertyFactory

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

requiredServices

open val requiredServices: TaskRequiredServices?

rootSpec

open val rootSpec: DestinationRootCopySpec

services

@get:Internal

protected open val services: ServiceRegistry?

sharedResources

open val sharedResources: List<ResourceLock?>?

shouldRunAfter

open override val shouldRunAfter: TaskDependency?

source

@get:Internal

open val source: FileCollection

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

open override val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

timeout

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

conventionMapping

open fun conventionMapping(property: String?, mapping: Closure<*>?): Task?

open fun conventionMapping(property: String?, mapping: Callable<*>?): Task?

copy

protected open fun copy()

createCopyAction

protected open fun createCopyAction(): CopyAction

createCopyActionExecuter

protected open fun createCopyActionExecuter(): CopyActionExecuter

createRootSpec

protected open fun createRootSpec(): CopySpecInternal

dependsOn

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

dirPermissions

open fun dirPermissions(configureAction: Action<in ConfigurableFilePermissions>): CopyProcessingSpec

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

eachFile

open fun eachFile(closure: Closure<*>): AbstractCopyTask

open fun eachFile(action: Action<in FileCopyDetails>): AbstractCopyTask

exclude

open fun exclude(excludeSpec: Closure<*>): AbstractCopyTask

open fun exclude(excludes: Iterable<String>): AbstractCopyTask

open fun exclude(excludeSpec: Spec<FileTreeElement>): AbstractCopyTask

open fun exclude(vararg excludes: String): AbstractCopyTask

expand

open fun expand(properties: Map<String, *>): AbstractCopyTask

open fun expand(properties: Map<String, *>, action: Action<in ExpandDetails>): AbstractCopyTask

filePermissions

open fun filePermissions(configureAction: Action<in ConfigurableFilePermissions>): CopyProcessingSpec

filesMatching

open fun filesMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask

open fun filesMatching(patterns: Iterable<String>, action: Action<in FileCopyDetails>): AbstractCopyTask

filesNotMatching

open fun filesNotMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask

open fun filesNotMatching(patterns: Iterable<String>, action: Action<in FileCopyDetails>): AbstractCopyTask

filter

open fun filter(closure: Closure<*>): AbstractCopyTask

open fun filter(filterType: Class<out FilterReader>): AbstractCopyTask

open fun filter(transformer: Transformer<@Nullable String?, String>): AbstractCopyTask

open fun filter(properties: Map<String, *>, filterType: Class<out FilterReader>): AbstractCopyTask

finalizedBy

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

from

open fun from(vararg sourcePaths: @Nullable Any?): AbstractCopyTask

open fun from(sourcePath: Any, c: Closure<*>): AbstractCopyTask

open fun from(sourcePath: Any, configureAction: Action<in CopySpec>): AbstractCopyTask

getActions

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

getAnt

open fun getAnt(): AntBuilder?

getDependsOn

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

getDescription

open fun getDescription(): @Nullable String?

getDestroyables

open fun getDestroyables(): TaskDestroyables?

getDidWork

open fun getDidWork(): Boolean

getEnabled

open fun getEnabled(): Boolean

getExtensions

open fun getExtensions(): ExtensionContainer?

getFinalizedBy

open fun getFinalizedBy(): TaskDependency?

getGroup

open fun getGroup(): @Nullable String?

getInputs

open fun getInputs(): TaskInputsInternal?

getLocalState

open fun getLocalState(): TaskLocalState?

getLogger

open fun getLogger(): Logger?

getLogging

open fun getLogging(): LoggingManager?

getMustRunAfter

open fun getMustRunAfter(): TaskDependency?

getName

open fun getName(): String?

getOutputs

open fun getOutputs(): TaskOutputsInternal?

getPath

open fun getPath(): String?

getProject

open fun getProject(): Project?

getShouldRunAfter

open fun getShouldRunAfter(): TaskDependency?

getState

open fun getState(): TaskStateInternal?

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal?

getTemporaryDir

open fun getTemporaryDir(): File?

getTimeout

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

hasProperty

open fun hasProperty(propertyName: String?): Boolean

hasTaskActions

open fun hasTaskActions(): Boolean

include

open fun include(includeSpec: Closure<*>): AbstractCopyTask

open fun include(includes: Iterable<String>): AbstractCopyTask

open fun include(includeSpec: Spec<FileTreeElement>): AbstractCopyTask

open fun include(vararg includes: String): AbstractCopyTask

into

open fun into(destDir: Any): AbstractCopyTask

open fun into(destPath: Any, configureClosure: Closure<*>): AbstractCopyTask

open fun into(destPath: Any, copySpec: Action<in CopySpec>): CopySpec

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

preserve

open fun preserve(action: Action<in PatternFilterable?>?): Sync?

property

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

rename

open fun rename(closure: Closure<*>): AbstractCopyTask

open fun rename(renamer: Transformer<@Nullable String?, String>): AbstractCopyTask

open fun rename(sourceRegEx: Pattern, replaceWith: String): AbstractCopyTask

open fun rename(sourceRegEx: String, replaceWith: String): AbstractCopyTask

restoreOnlyIf

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

restoreTaskActions

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

setActions

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

setDependsOn

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

setDescription

open fun setDescription(description: @Nullable String?)

setDidWork

open fun setDidWork(didWork: Boolean)

setEnabled

open fun setEnabled(enabled: Boolean)

setExcludes

open fun setExcludes(excludes: Iterable<String>): AbstractCopyTask

setFinalizedBy

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

setGroup

open fun setGroup(group: @Nullable String?)

setIncludes

open fun setIncludes(includes: Iterable<String>): AbstractCopyTask

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

with

open fun with(vararg sourceSpecs: CopySpec): CopySpec