Package com.illumon.iris.db.tables.remotequery

Interface WorkerKind

All Known Implementing Classes:
DndWorkerKind, EnterpriseWorkerKind, GenericCommandWorkerKind
public interface WorkerKind
The WorkerKind class is used to map instructions from the RemoteProcessingRequest into the appropriate worker control invocations to create the requested worker. The default worker kind is a Deephaven Enterprise worker, the same version as the dispatcher. The alternative worker kind that we are most interested in is a Deephaven community worker.

  • Field Details

  • Method Details

    • workerControlTypes

      Collection<String> workerControlTypes()
      What kind of worker controls could be required for starting these kind of workers?
      Returns:
      the desired WorkerControlType

    • getWorkerControlTypeForRequest

      String getWorkerControlTypeForRequest​(RemoteProcessingRequest request)
      The worker control type required for a particular request.
      Parameters:
      request - the request that a worker is being created for
      Returns:
      the type of worker control for this particular request

    • getDescription

      @Nullable String getDescription()
      Return an optional description of this WorkerKind for use in the UI.
      Returns:
      a description, or null

    • getTitle

      @NotNull String getTitle()
      Return a string that should be used for drop-down menus in the UI.
      Returns:
      the title of the worker

    • implementedProtocols

      List<String> implementedProtocols()
      What protocols does this kind of worker implement?
      Returns:
      a list of protocol names that this worker implements