org.elasticsearch.action.index

Class IndexRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder>

org.elasticsearch.action.support.replication.ReplicationRequestBuilder<IndexRequest,IndexResponse,IndexRequestBuilder>

org.elasticsearch.action.index.IndexRequestBuilder

public class IndexRequestBuilder
extends ReplicationRequestBuilder<IndexRequest,IndexResponse,IndexRequestBuilder>

An index document action request builder.

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor and Description
IndexRequestBuilder(ElasticsearchClient client, IndexAction action)
IndexRequestBuilder(ElasticsearchClient client, IndexAction action, String index)

Method Summary

Methods

Modifier and Type	Method and Description
IndexRequestBuilder	setContentType(XContentType contentType) The content type that will be used to generate a document from user provided objects (like Map).
IndexRequestBuilder	setCreate(boolean create) Set to true to force this index to use IndexRequest.OpType.CREATE.
IndexRequestBuilder	setId(String id) Sets the id to index the document under.
IndexRequestBuilder	setOpType(IndexRequest.OpType opType) Sets the type of operation to perform.
IndexRequestBuilder	setOpType(String opType) Sets a string representation of the setOpType(org.elasticsearch.action.index.IndexRequest.OpType).
IndexRequestBuilder	setParent(String parent) Sets the parent id of this document.
IndexRequestBuilder	setRefresh(boolean refresh) Should a refresh be executed post this index operation causing the operation to be searchable.
IndexRequestBuilder	setRouting(String routing) Controls the shard routing of the request.
IndexRequestBuilder	setSource(byte[] source) Sets the document to index in bytes form.
IndexRequestBuilder	setSource(byte[] source, int offset, int length) Sets the document to index in bytes form (assumed to be safe to be used from different threads).
IndexRequestBuilder	setSource(BytesReference source) Sets the source.
IndexRequestBuilder	setSource(Map<String,?> source) Index the Map as a JSON.
IndexRequestBuilder	setSource(Map<String,?> source, XContentType contentType) Index the Map as the provided content type.
IndexRequestBuilder	setSource(Object... source) Constructs a simple document with a field name and value pairs.
IndexRequestBuilder	setSource(String source) Sets the document source to index.
IndexRequestBuilder	setSource(String field1, Object value1) Constructs a simple document with a field and a value.
IndexRequestBuilder	setSource(String field1, Object value1, String field2, Object value2) Constructs a simple document with a field and value pairs.
IndexRequestBuilder	setSource(String field1, Object value1, String field2, Object value2, String field3, Object value3) Constructs a simple document with a field and value pairs.
IndexRequestBuilder	setSource(String field1, Object value1, String field2, Object value2, String field3, Object value3, String field4, Object value4) Constructs a simple document with a field and value pairs.
IndexRequestBuilder	setSource(XContentBuilder sourceBuilder) Sets the content source to index.
IndexRequestBuilder	setTimestamp(String timestamp) Sets the timestamp either as millis since the epoch, or, in the configured date format.
IndexRequestBuilder	setTTL(long ttl) Sets the relative ttl value in milliseconds.
IndexRequestBuilder	setTTL(String ttl) Sets the ttl value as a time value expression.
IndexRequestBuilder	setTTL(TimeValue ttl) Sets the ttl as a TimeValue instance.
IndexRequestBuilder	setType(String type) Sets the type to index the document to.
IndexRequestBuilder	setVersion(long version) Sets the version, which will cause the index operation to only be performed if a matching version exists and no changes happened on the doc since then.
IndexRequestBuilder	setVersionType(VersionType versionType) Sets the versioning type.

Methods inherited from class org.elasticsearch.action.support.replication.ReplicationRequestBuilder

setConsistencyLevel, setIndex, setTimeout, setTimeout

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

beforeExecute, execute, execute, get, get, get, putHeader, request

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexRequestBuilder

public IndexRequestBuilder(ElasticsearchClient client,
                   IndexAction action)

IndexRequestBuilder

public IndexRequestBuilder(ElasticsearchClient client,
                   IndexAction action,
                   @Nullable
                   String index)

Method Detail

setType

public IndexRequestBuilder setType(String type)

Sets the type to index the document to.

setId

public IndexRequestBuilder setId(String id)

Sets the id to index the document under. Optional, and if not set, one will be automatically generated.

setRouting

public IndexRequestBuilder setRouting(String routing)

Controls the shard routing of the request. Using this value to hash the shard and not the id.

setParent

public IndexRequestBuilder setParent(String parent)

Sets the parent id of this document. If routing is not set, automatically set it as the routing as well.

setSource

public IndexRequestBuilder setSource(BytesReference source)

Sets the source.

setSource

public IndexRequestBuilder setSource(Map<String,?> source)

Index the Map as a JSON.

Parameters:

source - The map to index

setSource

public IndexRequestBuilder setSource(Map<String,?> source,
                            XContentType contentType)

Index the Map as the provided content type.

Parameters:

source - The map to index

setSource

public IndexRequestBuilder setSource(String source)

Sets the document source to index.

Note, its preferable to either set it using setSource(org.elasticsearch.common.xcontent.XContentBuilder) or using the setSource(byte[]).

setSource

public IndexRequestBuilder setSource(XContentBuilder sourceBuilder)

Sets the content source to index.

setSource

public IndexRequestBuilder setSource(byte[] source)

Sets the document to index in bytes form.

setSource

public IndexRequestBuilder setSource(byte[] source,
                            int offset,
                            int length)

Sets the document to index in bytes form (assumed to be safe to be used from different threads).

Parameters:

source - The source to index

offset - The offset in the byte array

length - The length of the data

setSource

public IndexRequestBuilder setSource(String field1,
                            Object value1)

Constructs a simple document with a field and a value.

setSource

public IndexRequestBuilder setSource(String field1,
                            Object value1,
                            String field2,
                            Object value2)

Constructs a simple document with a field and value pairs.

setSource

public IndexRequestBuilder setSource(String field1,
                            Object value1,
                            String field2,
                            Object value2,
                            String field3,
                            Object value3)

Constructs a simple document with a field and value pairs.

setSource

public IndexRequestBuilder setSource(String field1,
                            Object value1,
                            String field2,
                            Object value2,
                            String field3,
                            Object value3,
                            String field4,
                            Object value4)

Constructs a simple document with a field and value pairs.

setSource

public IndexRequestBuilder setSource(Object... source)

Constructs a simple document with a field name and value pairs. Note: the number of objects passed to this method must be an even number.

setContentType

public IndexRequestBuilder setContentType(XContentType contentType)

The content type that will be used to generate a document from user provided objects (like Map).

setOpType

public IndexRequestBuilder setOpType(IndexRequest.OpType opType)

Sets the type of operation to perform.

setOpType

public IndexRequestBuilder setOpType(String opType)

Sets a string representation of the setOpType(org.elasticsearch.action.index.IndexRequest.OpType). Can be either "index" or "create".

setCreate

public IndexRequestBuilder setCreate(boolean create)

Set to true to force this index to use IndexRequest.OpType.CREATE.

setRefresh

public IndexRequestBuilder setRefresh(boolean refresh)

Should a refresh be executed post this index operation causing the operation to be searchable. Note, heavy indexing should not set this to true. Defaults to false.

setVersion

public IndexRequestBuilder setVersion(long version)

Sets the version, which will cause the index operation to only be performed if a matching version exists and no changes happened on the doc since then.

setVersionType

public IndexRequestBuilder setVersionType(VersionType versionType)

Sets the versioning type. Defaults to VersionType.INTERNAL.

setTimestamp

public IndexRequestBuilder setTimestamp(String timestamp)

Sets the timestamp either as millis since the epoch, or, in the configured date format.

setTTL

public IndexRequestBuilder setTTL(String ttl)

Sets the ttl value as a time value expression.

setTTL

public IndexRequestBuilder setTTL(long ttl)

Sets the relative ttl value in milliseconds. It musts be greater than 0 as it makes little sense otherwise.

setTTL

public IndexRequestBuilder setTTL(TimeValue ttl)

Sets the ttl as a TimeValue instance.