org.elasticsearch.rest
Interface RestRequest

All Superinterfaces:

ToXContent.Params

All Known Subinterfaces:

HttpRequest

All Known Implementing Classes:

AbstractRestRequest, NettyHttpRequest

public interface RestRequest
extends ToXContent.Params

Nested Class Summary

static class

RestRequest.Method

Method Summary

java.lang.String	contentAsString()
byte[]	contentByteArray()
int	contentByteArrayOffset()
int	contentLength()
boolean	contentUnsafe() Is the byte array content safe or unsafe for usage on other threads
boolean	hasContent()
boolean	hasParam(java.lang.String key)
java.lang.String	header(java.lang.String name)
RestRequest.Method	method()
java.lang.String	param(java.lang.String key)
boolean	paramAsBoolean(java.lang.String key, boolean defaultValue)
java.lang.Boolean	paramAsBooleanOptional(java.lang.String key, java.lang.Boolean defaultValue)
float	paramAsFloat(java.lang.String key, float defaultValue)
int	paramAsInt(java.lang.String key, int defaultValue)
long	paramAsLong(java.lang.String key, long defaultValue)
ByteSizeValue	paramAsSize(java.lang.String key, ByteSizeValue defaultValue)
java.lang.String[]	paramAsStringArray(java.lang.String key, java.lang.String[] defaultValue)
TimeValue	paramAsTime(java.lang.String key, TimeValue defaultValue)
java.util.Map<java.lang.String,java.lang.String>	params()
java.lang.String	path() The path part of the URI (without the query string), decoded.
java.lang.String	rawPath() The non decoded, raw path provided.
java.lang.String	uri() The uri of the rest request, with the query string.

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent.Params

param

Method Detail

method

RestRequest.Method method()

uri

java.lang.String uri()

The uri of the rest request, with the query string.

rawPath

java.lang.String rawPath()

The non decoded, raw path provided.

path

java.lang.String path()

The path part of the URI (without the query string), decoded.

hasContent

boolean hasContent()

contentUnsafe

boolean contentUnsafe()

Is the byte array content safe or unsafe for usage on other threads

contentByteArray

byte[] contentByteArray()

contentByteArrayOffset

int contentByteArrayOffset()

contentLength

int contentLength()

contentAsString

java.lang.String contentAsString()

header

java.lang.String header(java.lang.String name)

hasParam

boolean hasParam(java.lang.String key)

param

java.lang.String param(java.lang.String key)

Specified by:

param in interface ToXContent.Params

paramAsStringArray

java.lang.String[] paramAsStringArray(java.lang.String key,
                                      java.lang.String[] defaultValue)

paramAsFloat

float paramAsFloat(java.lang.String key,
                   float defaultValue)

paramAsInt

int paramAsInt(java.lang.String key,
               int defaultValue)

paramAsLong

long paramAsLong(java.lang.String key,
                 long defaultValue)

paramAsBoolean

boolean paramAsBoolean(java.lang.String key,
                       boolean defaultValue)

Specified by:

paramAsBoolean in interface ToXContent.Params

paramAsBooleanOptional

java.lang.Boolean paramAsBooleanOptional(java.lang.String key,
                                         java.lang.Boolean defaultValue)

Specified by:

paramAsBooleanOptional in interface ToXContent.Params

paramAsTime

TimeValue paramAsTime(java.lang.String key,
                      TimeValue defaultValue)

paramAsSize

ByteSizeValue paramAsSize(java.lang.String key,
                          ByteSizeValue defaultValue)

params

java.util.Map<java.lang.String,java.lang.String> params()