Package org.elasticsearch.client

Class Request

java.lang.Object

org.elasticsearch.client.Request

public final class Request
extends Object

HTTP Request to Elasticsearch.

Constructor Summary

Constructors

Constructor	Description
Request(String method, String endpoint)	Create the Request.

Method Summary

Modifier and Type	Method	Description
void	addParameter(String name, String value)	Add a query string parameter.
void	addParameters(Map<String,String> paramSource)
boolean	equals(Object obj)
String	getEndpoint()	The path of the request (without scheme, host, port, or prefix).
HttpEntity	getEntity()	The body of the request.
String	getMethod()	The HTTP method.
RequestOptions	getOptions()	Get the portion of an HTTP request to Elasticsearch that can be manipulated without changing Elasticsearch's behavior.
Map<String,String>	getParameters()	Query string parameters.
int	hashCode()
void	setEntity(HttpEntity entity)	Set the body of the request.
void	setJsonEntity(String entity)	Set the body of the request to a string.
void	setOptions(RequestOptions options)	Set the portion of an HTTP request to Elasticsearch that can be manipulated without changing Elasticsearch's behavior.
void	setOptions(RequestOptions.Builder options)	Set the portion of an HTTP request to Elasticsearch that can be manipulated without changing Elasticsearch's behavior.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Request

public Request(String method,
               String endpoint)

Create the Request.

Parameters:

method - the HTTP method

endpoint - the path of the request (without scheme, host, port, or prefix)

Method Detail

getMethod

public String getMethod()

The HTTP method.

getEndpoint

public String getEndpoint()

The path of the request (without scheme, host, port, or prefix).

addParameter

public void addParameter(String name,
                         String value)

Add a query string parameter.

Parameters:

name - the name of the url parameter. Must not be null.

value - the value of the url url parameter. If null then the parameter is sent as name rather than name=value

Throws:

IllegalArgumentException - if a parameter with that name has already been set

addParameters

public void addParameters(Map<String,String> paramSource)

getParameters

public Map<String,String> getParameters()

Query string parameters. The returned map is an unmodifiable view of the map in the request so calls to addParameter(String, String) will change it.

setEntity

public void setEntity(HttpEntity entity)

Set the body of the request. If not set or set to null then no body is sent with the request.

setJsonEntity

public void setJsonEntity(String entity)

Set the body of the request to a string. If not set or set to null then no body is sent with the request. The Content-Type will be sent as application/json. If you need a different content type then use setEntity(HttpEntity).

getEntity

public HttpEntity getEntity()

The body of the request. If null then no body is sent with the request.

setOptions

public void setOptions(RequestOptions options)

Set the portion of an HTTP request to Elasticsearch that can be manipulated without changing Elasticsearch's behavior.

setOptions

public void setOptions(RequestOptions.Builder options)

Set the portion of an HTTP request to Elasticsearch that can be manipulated without changing Elasticsearch's behavior.

getOptions

public RequestOptions getOptions()

Get the portion of an HTTP request to Elasticsearch that can be manipulated without changing Elasticsearch's behavior.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object