Package org.opensearch.rest

Class RestHandler.ReplacedRoute

java.lang.Object
org.opensearch.rest.RestHandler.Route
org.opensearch.rest.RestHandler.ReplacedRoute
Enclosing interface:
RestHandler
public static class RestHandler.ReplacedRoute
extends RestHandler.Route
Represents an API that has had its path or method changed. Holds both the new and previous path and method combination.

  • Constructor Summary

    Constructors 
    Constructor Description
    ReplacedRoute​(RestHandler.Route route, java.lang.String prefix, java.lang.String deprecatedPrefix)
    Construct replaced routes using route, new and deprecated prefixes
    ReplacedRoute​(RestRequest.Method method, java.lang.String path, java.lang.String deprecatedPath)
    Construct replaced routes using route method, new and deprecated paths This constructor can be used when both new and deprecated paths use the same method
    ReplacedRoute​(RestRequest.Method method, java.lang.String path, RestRequest.Method deprecatedMethod, java.lang.String deprecatedPath)
    Construct replaced routes using new and deprocated methods and new and deprecated paths

  • Method Summary

    Modifier and Type Method Description
    RestRequest.Method getDeprecatedMethod()  
    java.lang.String getDeprecatedPath()  

    Methods inherited from class org.opensearch.rest.RestHandler.Route

    getMethod, getPath

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ReplacedRoute

      public ReplacedRoute​(RestRequest.Method method, java.lang.String path, RestRequest.Method deprecatedMethod, java.lang.String deprecatedPath)
      Construct replaced routes using new and deprocated methods and new and deprecated paths
      Parameters:
      method - route method
      path - new route path
      deprecatedMethod - deprecated method
      deprecatedPath - deprecated path

    • ReplacedRoute

      public ReplacedRoute​(RestRequest.Method method, java.lang.String path, java.lang.String deprecatedPath)
      Construct replaced routes using route method, new and deprecated paths This constructor can be used when both new and deprecated paths use the same method
      Parameters:
      method - route method
      path - new route path
      deprecatedPath - deprecated path

    • ReplacedRoute

      public ReplacedRoute​(RestHandler.Route route, java.lang.String prefix, java.lang.String deprecatedPrefix)
      Construct replaced routes using route, new and deprecated prefixes
      Parameters:
      route - route
      prefix - new route prefix
      deprecatedPrefix - deprecated prefix

  • Method Details