io.searchbox.core

Class Doc

java.lang.Object

io.searchbox.core.Doc

public class Doc
extends Object

Represents a single get request description in a MultiGet request.

Author:

Dogukan Sonmez, cihat keser

Constructor Summary

Constructors

Constructor and Description
Doc(String index, String id)
Doc(String index, String type, String id)

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(String field) Specific stored fields can be specified to be retrieved per document to get, similar to the fields parameter of the Get API.
void	addFields(Collection<String> fields) Specific stored fields can be specified to be retrieved per document to get, similar to the fields parameter of the Get API.
Collection<String>	getFields()
String	getId()
String	getIndex()
String	getRouting()
Object	getSource()
String	getType()
void	setRouting(String routing)
void	setSource(Object source) By default, the _source field will be returned for every document (if stored).
protected Map<String,Object>	toMap()

Methods inherited from class java.lang.Object

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

Constructor Detail

Doc

public Doc(String index,
   String id)

Doc

public Doc(String index,
   String type,
   String id)

Parameters:

index -

type - The mget API allows for _type to be optional. Set it to _all or null in order to fetch the first document matching the id across all types.

id -

Method Detail

getIndex

public String getIndex()

getType

public String getType()

getId

public String getId()

getFields

public Collection<String> getFields()

addFields

public void addFields(Collection<String> fields)

Specific stored fields can be specified to be retrieved per document to get, similar to the fields parameter of the Get API.

addField

public void addField(String field)

Specific stored fields can be specified to be retrieved per document to get, similar to the fields parameter of the Get API.

setRouting

public void setRouting(String routing)

getRouting

public String getRouting()

setSource

public void setSource(Object source)

By default, the _source field will be returned for every document (if stored). Similar to the get API, you can retrieve only parts of the _source (or not at all) by using the _source parameter. You can also use the url parameters _source, _source_include & _source_exclude to specify defaults, which will be used when there are no per-document instructions.

getSource

public Object getSource()

toMap

protected Map<String,Object> toMap()