The task that compiles proto files into Java files.
| Modifiers | Name | Description |
|---|---|---|
class |
GenerateProtoTask.DescriptorSetOptions |
Configuration object for descriptor generation details. |
static class |
GenerateProtoTask.PluginOptions |
The container of command-line options for a protoc plugin or a built-in output. |
| Fields inherited from class | Fields |
|---|---|
class org.gradle.api.DefaultTask |
TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS |
| Type | Name and description |
|---|---|
static int |
CMD_ARGUMENT_EXTRA_LENGTH |
static int |
DEFAULT_CMD_LENGTH_LIMIT |
static int |
WINDOWS_CMD_LENGTH_LIMIT |
java.lang.String |
buildType |
GenerateProtoTask.DescriptorSetOptions |
descriptorSetOptions |
java.util.List<java.lang.String> |
flavors |
boolean |
generateDescriptorSetIf true, will set the protoc flag --descriptor_set_out="${outputBaseDir}/descriptor_set.desc" |
org.gradle.api.provider.Provider<java.lang.String> |
outputBaseDir |
org.gradle.api.tasks.SourceSet |
sourceSet |
java.lang.Object |
variant |
| Type Params | Return Type | Name and description |
|---|---|---|
|
void |
addIncludeDir(org.gradle.api.file.FileCollection dir)Add a directory to protoc's include path. |
|
void |
addSourceDirs(org.gradle.api.file.FileCollection dirs)Add a collection of proto source files to be compiled. |
|
void |
builtins(org.gradle.api.Action<org.gradle.api.NamedDomainObjectContainer<PluginOptions>> configureAction)Configures the protoc builtins in a closure, which will be manipulating a NamedDomainObjectContainer |
|
void |
compile() |
|
protected java.lang.String |
computeExecutablePath(ExecutableLocator locator) |
|
static java.lang.String |
computeJavaExePath(boolean isWindows) |
|
void |
doneConfig() |
|
void |
doneInitializing() |
|
static java.lang.String |
escapePathUnix(java.lang.String path) |
|
static java.lang.String |
escapePathWindows(java.lang.String path) |
|
static java.util.List<java.util.List<java.lang.String>> |
generateCmds(java.util.List<java.lang.String> baseCmd, java.util.List<java.io.File> protoFiles, int cmdLengthLimit) |
|
java.lang.String |
getBuildType() |
|
org.gradle.api.NamedDomainObjectContainer<PluginOptions> |
getBuiltins()Returns the container of protoc builtins. |
|
protected java.util.Collection<PluginOptions> |
getBuiltinsForCaching()Used to expose inputs to Gradle, not to be called directly. |
|
static int |
getCmdLengthLimit() |
|
static int |
getCmdLengthLimit(java.lang.String os) |
|
java.lang.String |
getDescriptorPath() |
|
protected GenerateProtoTask.DescriptorSetOptions |
getDescriptorSetOptionsForCaching()Used to expose inputs to Gradle, not to be called directly. |
|
org.gradle.api.file.FileCollection |
getExecutables()Not for external use. |
|
java.util.List<java.lang.String> |
getFlavors() |
|
org.gradle.api.file.FileCollection |
getIncludeDirs() |
|
org.gradle.api.provider.Provider<java.lang.Boolean> |
getIsAndroidProject() |
|
boolean |
getIsTest()Returns true if the Java source set or Android variant is test related. |
|
org.gradle.api.provider.Provider<java.lang.Boolean> |
getIsTestProvider() |
|
boolean |
getIsTestVariant() |
|
org.gradle.api.model.ObjectFactory |
getObjectFactory() |
|
java.lang.String |
getOutputBaseDir() |
|
java.lang.String |
getOutputDir(GenerateProtoTask.PluginOptions plugin) |
|
org.gradle.api.file.SourceDirectorySet |
getOutputSourceDirectorySet()Returns a SourceDirectorySet representing the generated source
directories. |
|
org.gradle.api.NamedDomainObjectContainer<PluginOptions> |
getPlugins()Returns the container of protoc plugins. |
|
protected java.util.Collection<PluginOptions> |
getPluginsForCaching()Used to expose inputs to Gradle, not to be called directly. |
|
org.gradle.api.provider.ProviderFactory |
getProviderFactory() |
|
org.gradle.api.provider.Provider<java.util.List<java.lang.String>> |
getReleaseArtifacts()Not for external use. |
|
org.gradle.api.file.FileCollection |
getSourceDirs() |
|
org.gradle.api.tasks.SourceSet |
getSourceSet() |
|
java.lang.Object |
getVariant() |
|
boolean |
hasPlugin(java.lang.String name)Returns true if the task has a plugin with the given name, false otherwise. |
|
static boolean |
isWindows(java.lang.String os) |
|
static boolean |
isWindows() |
|
static java.lang.String |
makeOptionsPrefix(java.util.List<java.lang.String> options) |
|
static void |
mkdirsForFile(java.io.File outputFile) |
|
void |
plugins(org.gradle.api.Action<org.gradle.api.NamedDomainObjectContainer<PluginOptions>> configureAction)Configures the protoc plugins in a closure, which will be maniuplating a NamedDomainObjectContainer |
|
void |
setBuildType(java.lang.String buildType) |
|
static void |
setExecutableOrFail(java.io.File outputFile) |
|
void |
setFlavors(java.util.List<java.lang.String> flavors) |
|
void |
setOutputBaseDir(org.gradle.api.provider.Provider<java.lang.String> outputBaseDir) |
|
void |
setSourceSet(org.gradle.api.tasks.SourceSet sourceSet) |
|
void |
setVariant(java.lang.Object variant, boolean isTestVariant) |
| Methods inherited from class | Name |
|---|---|
class org.gradle.api.DefaultTask |
org.gradle.api.DefaultTask#getProject(), org.gradle.api.DefaultTask#setDescription(java.lang.String), org.gradle.api.DefaultTask#setGroup(java.lang.String), org.gradle.api.DefaultTask#getAnt(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#getDidWork(), org.gradle.api.DefaultTask#doLast(org.gradle.api.Action), org.gradle.api.DefaultTask#doLast(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#doLast(groovy.lang.Closure), org.gradle.api.DefaultTask#getEnabled(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getDestroyables(), org.gradle.api.DefaultTask#getLocalState(), org.gradle.api.DefaultTask#getTemporaryDir(), org.gradle.api.DefaultTask#mustRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#setMustRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#getMustRunAfter(), org.gradle.api.DefaultTask#finalizedBy([Ljava.lang.Object;), org.gradle.api.DefaultTask#setFinalizedBy(java.lang.Iterable), org.gradle.api.DefaultTask#getFinalizedBy(), org.gradle.api.DefaultTask#shouldRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#setShouldRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#getShouldRunAfter(), org.gradle.api.DefaultTask#usesService(org.gradle.api.provider.Provider), org.gradle.api.DefaultTask#setActions(java.util.List), org.gradle.api.DefaultTask#getDependsOn(), org.gradle.api.DefaultTask#setDependsOn(java.lang.Iterable), org.gradle.api.DefaultTask#dependsOn([Ljava.lang.Object;), org.gradle.api.DefaultTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#onlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#setDidWork(boolean), org.gradle.api.DefaultTask#doFirst(org.gradle.api.Action), org.gradle.api.DefaultTask#doFirst(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#doFirst(groovy.lang.Closure), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#getTimeout(), org.gradle.api.DefaultTask#getExtensions(), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#getDescription(), org.gradle.api.DefaultTask#setEnabled(boolean), org.gradle.api.DefaultTask#property(java.lang.String), org.gradle.api.DefaultTask#hasProperty(java.lang.String), org.gradle.api.DefaultTask#getGroup(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#compareTo(java.lang.Object), org.gradle.api.DefaultTask#compareTo(org.gradle.api.Task), org.gradle.api.DefaultTask#getName(), org.gradle.api.DefaultTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.DefaultTask#getLogger(), org.gradle.api.DefaultTask#getActions(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getPath(), org.gradle.api.DefaultTask#getIdentityPath(), org.gradle.api.DefaultTask#getStandardOutputCapture(), org.gradle.api.DefaultTask#getConvention(), org.gradle.api.DefaultTask#getAsDynamicObject(), org.gradle.api.DefaultTask#getTaskIdentity(), org.gradle.api.DefaultTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.gradle.api.DefaultTask#getTaskActions(), org.gradle.api.DefaultTask#hasTaskActions(), org.gradle.api.DefaultTask#getOnlyIf(), org.gradle.api.DefaultTask#getImpliesSubProjects(), org.gradle.api.DefaultTask#setImpliesSubProjects(boolean), org.gradle.api.DefaultTask#setLoggerMessageRewriter(org.gradle.internal.logging.slf4j.ContextAwareTaskLogger$MessageRewriter), org.gradle.api.DefaultTask#getTemporaryDirFactory(), org.gradle.api.DefaultTask#prependParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#appendParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#isHasCustomActions(), org.gradle.api.DefaultTask#getRequiredServices(), org.gradle.api.DefaultTask#getSharedResources(), org.gradle.api.DefaultTask#isEnabled(), org.gradle.api.DefaultTask#wait(long), org.gradle.api.DefaultTask#wait(long, int), org.gradle.api.DefaultTask#wait(), org.gradle.api.DefaultTask#equals(java.lang.Object), org.gradle.api.DefaultTask#toString(), org.gradle.api.DefaultTask#hashCode(), org.gradle.api.DefaultTask#getClass(), org.gradle.api.DefaultTask#notify(), org.gradle.api.DefaultTask#notifyAll() |
If true, will set the protoc flag --descriptor_set_out="${outputBaseDir}/descriptor_set.desc" Default: false
Add a directory to protoc's include path.
Add a collection of proto source files to be compiled.
Configures the protoc builtins in a closure, which will be manipulating a
NamedDomainObjectContainer
Returns the container of protoc builtins.
Used to expose inputs to Gradle, not to be called directly.
Used to expose inputs to Gradle, not to be called directly.
Not for external use. Used to expose inputs to Gradle.
Returns true if the Java source set or Android variant is test related.
Returns a SourceDirectorySet representing the generated source
directories.
Returns the container of protoc plugins.
Used to expose inputs to Gradle, not to be called directly.
Not for external use. Used to expose inputs to Gradle. For each protoc and code gen plugin defined by an artifact specification, this list will contain a String with the group, artifact, and version, as long as the version is a stable release version. Giving this as an input to the task allows gradle to ignore the OS classifier and use cached outputs generated from different operating systems since the expectation is that different operating systems will produce the same generated code.
Returns true if the task has a plugin with the given name, false otherwise.
Configures the protoc plugins in a closure, which will be maniuplating a
NamedDomainObjectContainer