Package org.elasticsearch.client
Class Request
java.lang.Object
org.elasticsearch.client.Request
public final class Request
extends java.lang.Object
HTTP Request to Elasticsearch.
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description void
addParameter(java.lang.String name, java.lang.String value)
Add a query string parameter.void
addParameters(java.util.Map<java.lang.String,java.lang.String> paramSource)
boolean
equals(java.lang.Object obj)
java.lang.String
getEndpoint()
The path of the request (without scheme, host, port, or prefix).org.apache.http.HttpEntity
getEntity()
The body of the request.java.lang.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.java.util.Map<java.lang.String,java.lang.String>
getParameters()
Query string parameters.int
hashCode()
void
setEntity(org.apache.http.HttpEntity entity)
Set the body of the request.void
setJsonEntity(java.lang.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.java.lang.String
toString()
-
Constructor Details
-
Method Details
-
getMethod
public java.lang.String getMethod()The HTTP method. -
getEndpoint
public java.lang.String getEndpoint()The path of the request (without scheme, host, port, or prefix). -
addParameter
public void addParameter(java.lang.String name, java.lang.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. Ifnull
then the parameter is sent asname
rather thanname=value
- Throws:
java.lang.IllegalArgumentException
- if a parameter with that name has already been set
-
addParameters
public void addParameters(java.util.Map<java.lang.String,java.lang.String> paramSource) -
getParameters
public java.util.Map<java.lang.String,java.lang.String> getParameters()Query string parameters. The returned map is an unmodifiable view of the map in the request so calls toaddParameter(String, String)
will change it. -
setEntity
public void setEntity(org.apache.http.HttpEntity entity)Set the body of the request. If not set or set tonull
then no body is sent with the request. -
setJsonEntity
public void setJsonEntity(java.lang.String entity)Set the body of the request to a string. If not set or set tonull
then no body is sent with the request. TheContent-Type
will be sent asapplication/json
. If you need a different content type then usesetEntity(HttpEntity)
. -
getEntity
public org.apache.http.HttpEntity getEntity()The body of the request. Ifnull
then no body is sent with the request. -
setOptions
Set the portion of an HTTP request to Elasticsearch that can be manipulated without changing Elasticsearch's behavior. -
setOptions
Set the portion of an HTTP request to Elasticsearch that can be manipulated without changing Elasticsearch's behavior. -
getOptions
Get the portion of an HTTP request to Elasticsearch that can be manipulated without changing Elasticsearch's behavior. -
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-