Package org.opensearch.jobscheduler.rest.action

Class RestGetLockAction

java.lang.Object
org.opensearch.rest.BaseRestHandler
org.opensearch.jobscheduler.rest.action.RestGetLockAction
All Implemented Interfaces:
org.opensearch.rest.RestHandler
public class RestGetLockAction extends org.opensearch.rest.BaseRestHandler
This class consists of the REST handler to GET a lock model for extensions

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.opensearch.rest.BaseRestHandler

    org.opensearch.rest.BaseRestHandler.RestChannelConsumer, org.opensearch.rest.BaseRestHandler.StreamingRestChannelConsumer, org.opensearch.rest.BaseRestHandler.Wrapper

    Nested classes/interfaces inherited from interface org.opensearch.rest.RestHandler

    org.opensearch.rest.RestHandler.DeprecatedRoute, org.opensearch.rest.RestHandler.ReplacedRoute, org.opensearch.rest.RestHandler.Route

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    org.opensearch.jobscheduler.spi.utils.LockService
    lockService
     

    Fields inherited from class org.opensearch.rest.BaseRestHandler

    MULTI_ALLOW_EXPLICIT_INDEX

  • Constructor Summary

    Constructors
    Constructor
    Description
    RestGetLockAction(org.opensearch.jobscheduler.spi.utils.LockService lockService)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
     
    protected org.opensearch.rest.BaseRestHandler.RestChannelConsumer
    prepareRequest(org.opensearch.rest.RestRequest restRequest, org.opensearch.transport.client.node.NodeClient client)
     
    List<org.opensearch.rest.RestHandler.Route>
    routes()
     

    Methods inherited from class org.opensearch.rest.BaseRestHandler

    getUsageCount, handleRequest, parseDeprecatedMasterTimeoutParameter, responseParams, sendTask, unrecognized, unrecognizedStrings, validateAndGetPageParams

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.rest.RestHandler

    allowsUnsafeBuffers, allowSystemIndexAccessByDefault, canTripCircuitBreaker, deprecatedRoutes, isActionPaginated, replacedRoutes, supportsContentStream, supportsStreaming

  • Field Details

    • lockService

      public org.opensearch.jobscheduler.spi.utils.LockService lockService

  • Constructor Details

    • RestGetLockAction

      public RestGetLockAction(org.opensearch.jobscheduler.spi.utils.LockService lockService)

  • Method Details

    • getName

      public String getName()
      Specified by:
      getName in class org.opensearch.rest.BaseRestHandler

    • routes

      public List<org.opensearch.rest.RestHandler.Route> routes()

    • prepareRequest

      protected org.opensearch.rest.BaseRestHandler.RestChannelConsumer prepareRequest(org.opensearch.rest.RestRequest restRequest, org.opensearch.transport.client.node.NodeClient client) throws IOException
      Specified by:
      prepareRequest in class org.opensearch.rest.BaseRestHandler
      Throws:
      IOException