Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To get started creating a custom plugin, you can copy the code at https://github.com/data-integrations/example-transform as a starting point for your project.

Maven Archetypes

To get started on creating a custom plugin, you can use the Maven archetype to create your project:

  • cdap-data-pipeline-plugins-archetype (contains batch, Spark plugin, and other types)

This command will create a project from an archetype:

Code Block
$ mvn archetype:generate \
      -DarchetypeGroupId=io.cdap.cdap \
      -DarchetypeArtifactId=cdap-data-pipeline-plugins-archetype \
      -DarchetypeVersion=6.2.0 \
      -DgroupId=org.example.plugin

Note: Replace the groupId parameter (org.example.plugin) with your own organization, but it must not be replaced with io.cdap.cdap.

Complete examples for each archetype:

Code Block
$ mvn archetype:generate -DarchetypeGroupId=io.cdap.cdap -DarchetypeArtifactId=cdap-data-pipeline-plugins-archetype -DarchetypeVersion=6.2.0 -DgroupId=org.example.plugin

Maven supplies a guide to the naming convention used above at https://maven.apache.org/guides/mini/guide-naming-conventions.html.

Class Annotations

These annotations are used for plugin classes:

...