Class RunPlugin

All Implemented Interfaces:

public final class RunPlugin extends Object implements SmithyBuildPlugin
Runs a process-based plugin.
  • Constructor Details

    • RunPlugin

      public RunPlugin()
  • Method Details

    • getName

      public String getName()
      Description copied from interface: SmithyBuildPlugin
      Gets the name of the plugin.
      Specified by:
      getName in interface SmithyBuildPlugin
      Returns the name (e.g., "MyPlugin").
    • requiresValidModel

      public boolean requiresValidModel()
      Description copied from interface: SmithyBuildPlugin
      Plugins can choose whether or not to create artifacts based on whether or not the projection encountered error or unsuppressed danger events.

      By default plugins require that there are no errors or danger events for a given projected model.

      Specified by:
      requiresValidModel in interface SmithyBuildPlugin
      Returns true if the plugin should only be called if there are no error or unsuppressed danger violations for the projection.
    • execute

      public void execute(PluginContext context)
      Description copied from interface: SmithyBuildPlugin
      Executes the plugin, creating any number of artifacts.
      Specified by:
      execute in interface SmithyBuildPlugin
      context - Plugin context for build execution.