RestHandler.Route (server 7.13.4 API)

java.lang.Object

org.elasticsearch.rest.RestHandler.Route

Enclosing interface:: RestHandler

public static class RestHandler.Route
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class RestHandler.Route.RouteBuilder
Constructor Summary

Constructors

Constructor Description

Route(RestRequest.Method method, java.lang.String path)
Constructs a Route that pairs an HTTP method with an associated path.

Method Summary

Modifier and Type	Method	Description
`static RestHandler.Route.RouteBuilder`	`builder(RestRequest.Method method, java.lang.String path)`
`java.lang.String`	`getDeprecationMessage()`
`RestRequest.Method`	`getMethod()`
`java.lang.String`	`getPath()`
`RestHandler.Route`	`getReplacedRoute()`
`org.elasticsearch.common.RestApiVersion`	`getRestApiVersion()`
`boolean`	`isDeprecated()`
`boolean`	`isReplacement()`

Methods inherited from class java.lang.Object

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

Constructor Details
- Route
  
  public Route(RestRequest.Method method, java.lang.String path)
  
  Constructs a Route that pairs an HTTP method with an associated path.
  This is sufficient for most routes in Elasticsearch, like "GET /", "PUT /_cluster/settings", or "POST my_index/_close".
  
  Parameters:
  
  method - the method, e.g. GET
  
  path - the path, e.g. "/"
Method Details
- builder
  
  public static RestHandler.Route.RouteBuilder builder(RestRequest.Method method, java.lang.String path)
- getPath
  
  public java.lang.String getPath()
- getMethod
  
  public RestRequest.Method getMethod()
- getRestApiVersion
  
  public org.elasticsearch.common.RestApiVersion getRestApiVersion()
- getDeprecationMessage
  
  public java.lang.String getDeprecationMessage()
- isDeprecated
  
  public boolean isDeprecated()
- getReplacedRoute
  
  public RestHandler.Route getReplacedRoute()
- isReplacement
  
  public boolean isReplacement()