Package org.opensearch.jobscheduler

Class JobSchedulerPlugin

java.lang.Object
org.opensearch.plugins.Plugin
org.opensearch.jobscheduler.JobSchedulerPlugin
All Implemented Interfaces:
Closeable, AutoCloseable, org.opensearch.plugins.ActionPlugin, org.opensearch.plugins.ExtensiblePlugin, org.opensearch.plugins.SystemIndexPlugin
public class JobSchedulerPlugin extends org.opensearch.plugins.Plugin implements org.opensearch.plugins.ActionPlugin, org.opensearch.plugins.ExtensiblePlugin, org.opensearch.plugins.SystemIndexPlugin

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.plugins.ActionPlugin

    org.opensearch.plugins.ActionPlugin.ActionHandler<Request extends org.opensearch.action.ActionRequest,Response extends org.opensearch.core.action.ActionResponse>

    Nested classes/interfaces inherited from interface org.opensearch.plugins.ExtensiblePlugin

    org.opensearch.plugins.ExtensiblePlugin.ExtensionLoader

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    JS_BASE_URI
     
    static final String
    OPEN_DISTRO_JOB_SCHEDULER_THREAD_POOL_NAME
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    JobSchedulerPlugin()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Collection<Object>
    createComponents(org.opensearch.transport.client.Client client, org.opensearch.cluster.service.ClusterService clusterService, org.opensearch.threadpool.ThreadPool threadPool, org.opensearch.watcher.ResourceWatcherService resourceWatcherService, org.opensearch.script.ScriptService scriptService, org.opensearch.core.xcontent.NamedXContentRegistry xContentRegistry, org.opensearch.env.Environment environment, org.opensearch.env.NodeEnvironment nodeEnvironment, org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, org.opensearch.cluster.metadata.IndexNameExpressionResolver indexNameExpressionResolver, Supplier<org.opensearch.repositories.RepositoriesService> repositoriesServiceSupplier)
     
    List<org.opensearch.threadpool.ExecutorBuilder<?>>
    getExecutorBuilders(org.opensearch.common.settings.Settings settings)
     
    Map<String,ScheduledJobProvider>
    getIndexToJobProviders()
     
    Set<String>
    getIndicesToListen()
     
    List<org.opensearch.core.xcontent.NamedXContentRegistry.Entry>
    getNamedXContent()
     
    List
    getRestHandlers(org.opensearch.common.settings.Settings settings, org.opensearch.rest.RestController restController, org.opensearch.common.settings.ClusterSettings clusterSettings, org.opensearch.common.settings.IndexScopedSettings indexScopedSettings, org.opensearch.common.settings.SettingsFilter settingsFilter, org.opensearch.cluster.metadata.IndexNameExpressionResolver indexNameExpressionResolver, Supplier<org.opensearch.cluster.node.DiscoveryNodes> nodesInCluster)
     
    List<org.opensearch.common.settings.Setting<?>>
    getSettings()
     
    Collection<org.opensearch.indices.SystemIndexDescriptor>
    getSystemIndexDescriptors(org.opensearch.common.settings.Settings settings)
     
    void
    loadExtensions(org.opensearch.plugins.ExtensiblePlugin.ExtensionLoader loader)
     
    void
    onIndexModule(org.opensearch.index.IndexModule indexModule)
     

    Methods inherited from class org.opensearch.plugins.Plugin

    additionalSettings, close, createGuiceModules, getAdditionalIndexSettingProviders, getBootstrapChecks, getFeature, getGuiceServiceClasses, getIndexTemplateMetadataUpgrader, getNamedWriteables, getRoles, getSecureSettingFactory, getSettingsFilter, getSettingUpgraders

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.opensearch.plugins.ActionPlugin

    getActionFilters, getActions, getClientActions, getRestHandlerWrapper, getRestHeaders, getTaskHeaders, indicesAliasesRequestValidators, mappingRequestValidators

  • Field Details

  • Constructor Details

    • JobSchedulerPlugin

      public JobSchedulerPlugin()

  • Method Details

    • getIndicesToListen

      public Set<String> getIndicesToListen()

    • getIndexToJobProviders

      public Map<String,ScheduledJobProvider> getIndexToJobProviders()

    • getSystemIndexDescriptors

      public Collection<org.opensearch.indices.SystemIndexDescriptor> getSystemIndexDescriptors(org.opensearch.common.settings.Settings settings)
      Specified by:
      getSystemIndexDescriptors in interface org.opensearch.plugins.SystemIndexPlugin

    • createComponents

      public Collection<Object> createComponents(org.opensearch.transport.client.Client client, org.opensearch.cluster.service.ClusterService clusterService, org.opensearch.threadpool.ThreadPool threadPool, org.opensearch.watcher.ResourceWatcherService resourceWatcherService, org.opensearch.script.ScriptService scriptService, org.opensearch.core.xcontent.NamedXContentRegistry xContentRegistry, org.opensearch.env.Environment environment, org.opensearch.env.NodeEnvironment nodeEnvironment, org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry, org.opensearch.cluster.metadata.IndexNameExpressionResolver indexNameExpressionResolver, Supplier<org.opensearch.repositories.RepositoriesService> repositoriesServiceSupplier)
      Overrides:
      createComponents in class org.opensearch.plugins.Plugin

    • getSettings

      public List<org.opensearch.common.settings.Setting<?>> getSettings()
      Overrides:
      getSettings in class org.opensearch.plugins.Plugin

    • getExecutorBuilders

      public List<org.opensearch.threadpool.ExecutorBuilder<?>> getExecutorBuilders(org.opensearch.common.settings.Settings settings)
      Overrides:
      getExecutorBuilders in class org.opensearch.plugins.Plugin

    • onIndexModule

      public void onIndexModule(org.opensearch.index.IndexModule indexModule)
      Overrides:
      onIndexModule in class org.opensearch.plugins.Plugin

    • loadExtensions

      public void loadExtensions(org.opensearch.plugins.ExtensiblePlugin.ExtensionLoader loader)
      Specified by:
      loadExtensions in interface org.opensearch.plugins.ExtensiblePlugin

    • getNamedXContent

      public List<org.opensearch.core.xcontent.NamedXContentRegistry.Entry> getNamedXContent()
      Overrides:
      getNamedXContent in class org.opensearch.plugins.Plugin

    • getRestHandlers

      public List getRestHandlers(org.opensearch.common.settings.Settings settings, org.opensearch.rest.RestController restController, org.opensearch.common.settings.ClusterSettings clusterSettings, org.opensearch.common.settings.IndexScopedSettings indexScopedSettings, org.opensearch.common.settings.SettingsFilter settingsFilter, org.opensearch.cluster.metadata.IndexNameExpressionResolver indexNameExpressionResolver, Supplier<org.opensearch.cluster.node.DiscoveryNodes> nodesInCluster)
      Specified by:
      getRestHandlers in interface org.opensearch.plugins.ActionPlugin