Module org.elasticsearch.server

Package org.elasticsearch.rest

Class RestHandler.Route

java.lang.Object

org.elasticsearch.rest.RestHandler.Route

Enclosing interface:

RestHandler

public static class RestHandler.Route
extends 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, 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, String path)
org.apache.logging.log4j.Level	getDeprecationLevel()
String	getDeprecationMessage()
RestRequest.Method	getMethod()
String	getPath()
RestHandler.Route	getReplacedRoute()
RestApiVersion	getRestApiVersion()
boolean	hasReplacement()
boolean	isDeprecated()

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,
 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,
 String path)

getPath

public String getPath()

getMethod

public RestRequest.Method getMethod()

getRestApiVersion

public RestApiVersion getRestApiVersion()

getDeprecationMessage

@Nullable
public String getDeprecationMessage()

getDeprecationLevel

public org.apache.logging.log4j.Level getDeprecationLevel()

isDeprecated

public boolean isDeprecated()

getReplacedRoute

@Nullable
public RestHandler.Route getReplacedRoute()

hasReplacement

public boolean hasReplacement()