Package com.thoughtworks.go.plugin.api.info

Interface PluginDescriptor

All Superinterfaces:
java.io.Serializable
public interface PluginDescriptor
extends java.io.Serializable
Descriptor represent the plugin descriptor XML file.
See Also:
Go Plugin Documentation

  • Nested Class Summary

    Nested Classes
    Modifier and Type Interface Description
    static interface  PluginDescriptor.About
    Plugin author information.
    static interface  PluginDescriptor.Vendor
    Plugin vendor information.

  • Method Summary

    Modifier and Type Method Description
    PluginDescriptor.About about()
    Plugin author information.
    java.lang.String id()
    Plugin Id.
    java.lang.String version()
    Provides version of the plugin which will be used by Go to identify the version of the plugin.

  • Method Details

    • id

      java.lang.String id()
      Plugin Id.
      Returns:
      a string containing the plugin id.

    • version

      java.lang.String version()
      Provides version of the plugin which will be used by Go to identify the version of the plugin. It will be used in plugin upgrade flow and only integer values are allowed.
      Returns:
      a string containing the plugin descriptor version.

    • about

      PluginDescriptor.About about()
      Plugin author information.
      Returns:
      object containing the author information.