com.linkedin.pegasus.gradle.tasks

Class GenerateAvroSchemaTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.linkedin.pegasus.gradle.tasks.GenerateAvroSchemaTask

All Implemented Interfaces:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

@CacheableTask
public class GenerateAvroSchemaTask
extends org.gradle.api.DefaultTask

Generate the Avro schema (.avsc) files from data schema files. To use this plugin, add these three lines to your build.gradle:

 apply plugin: 'li-pegasus2'
 

The plugin will scan the source set's pegasus directory, e.g. "src/main/pegasus" for data schema (.pdsc) files.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
GenerateAvroSchemaTask()

Method Summary

Modifier and Type	Method and Description
void	generate()
org.gradle.api.file.FileCollection	getCodegenClasspath()
java.io.File	getDestinationDir() Directory to write the generated Avro schema files.
java.io.File	getInputDir() Directory containing the data schema files.
java.lang.String	getOverrideNamespace() Value of project property "generator.avro.namespace.override"
org.gradle.api.file.FileCollection	getResolverPath() The resolver path.
java.lang.String	getTranslateOptionalDefault() Value of project property "generator.avro.optional.default"
java.lang.String	getTypeRefPropertiesExcludeList() Value of project property "generator.avro.typeref.properties.exclude"
void	setCodegenClasspath(org.gradle.api.file.FileCollection codegenClasspath)
void	setDestinationDir(java.io.File destinationDir)
void	setInputDir(java.io.File inputDir)
void	setResolverPath(org.gradle.api.file.FileCollection resolverPath)

Methods inherited from class org.gradle.api.DefaultTask

newInputDirectory, newInputFile, newOutputDirectory, newOutputFile

Methods inherited from class org.gradle.api.internal.AbstractTask

addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GenerateAvroSchemaTask

public GenerateAvroSchemaTask()

Method Detail

generate

public void generate()

getInputDir

@InputDirectory
 @SkipWhenEmpty
 @PathSensitive(value=RELATIVE)
public java.io.File getInputDir()

Directory containing the data schema files.

setInputDir

public void setInputDir(java.io.File inputDir)

getResolverPath

@Classpath
public org.gradle.api.file.FileCollection getResolverPath()

The resolver path.

setResolverPath

public void setResolverPath(org.gradle.api.file.FileCollection resolverPath)

getCodegenClasspath

@Classpath
public org.gradle.api.file.FileCollection getCodegenClasspath()

setCodegenClasspath

public void setCodegenClasspath(org.gradle.api.file.FileCollection codegenClasspath)

getDestinationDir

@OutputDirectory
public java.io.File getDestinationDir()

Directory to write the generated Avro schema files.

setDestinationDir

public void setDestinationDir(java.io.File destinationDir)

getTranslateOptionalDefault

@Input
 @Optional
public java.lang.String getTranslateOptionalDefault()

Value of project property "generator.avro.optional.default"

getOverrideNamespace

@Input
 @Optional
public java.lang.String getOverrideNamespace()

Value of project property "generator.avro.namespace.override"

getTypeRefPropertiesExcludeList

@Input
 @Optional
public java.lang.String getTypeRefPropertiesExcludeList()

Value of project property "generator.avro.typeref.properties.exclude"