Module org.elasticsearch.cli
Package org.elasticsearch.cli

Interface CliToolProvider

public interface CliToolProvider
An interface for command line tools to be instantiated and run.

  • Method Summary

    Modifier and Type
    Method
    Description
    Command
    create()
    Constructs the CLI instance to be run.
    static CliToolProvider
    load(String toolname, String libs)
    Loads a tool provider from the Elasticsearch distribution.
    String
    name()
    Returns the name of the tool provider.

  • Method Details

    • name

      String name()
      Returns the name of the tool provider. This must be unique across all tool providers.

    • create

      Command create()
      Constructs the CLI instance to be run.

    • load

      static CliToolProvider load(String toolname, String libs)
      Loads a tool provider from the Elasticsearch distribution.
      Parameters:
      toolname - the name of the tool to load
      libs - the library directories to load, relative to the Elasticsearch homedir
      Returns:
      the instance of the loaded tool
      Throws:
      AssertionError - if the given toolname cannot be found or there are more than one tools found with the same name