Module org.elasticsearch.server

Package org.elasticsearch.action.index

Class IndexRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestLazyBuilder<Request,Response>

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

org.elasticsearch.action.index.IndexRequestBuilder

All Implemented Interfaces:

RequestBuilder<IndexRequest,DocWriteResponse>, WriteRequestBuilder<IndexRequestBuilder>

public class IndexRequestBuilder
extends ReplicationRequestBuilder<IndexRequest,DocWriteResponse,IndexRequestBuilder>
implements WriteRequestBuilder<IndexRequestBuilder>

An index document action request builder.

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestLazyBuilder

action, client

Constructor Summary

Constructors

Constructor	Description
IndexRequestBuilder(ElasticsearchClient client)
IndexRequestBuilder(ElasticsearchClient client, String index)

Method Summary

Modifier and Type	Method	Description
IndexRequest	request()	This method creates the request.
IndexRequestBuilder	setCreate(boolean create)	Set to true to force this index to use DocWriteRequest.OpType.CREATE.
IndexRequestBuilder	setId(String id)	Sets the id to index the document under.
IndexRequestBuilder	setIfPrimaryTerm(long term)	only perform this indexing request if the document was last modification was assigned the given primary term.
IndexRequestBuilder	setIfSeqNo(long seqNo)	only perform this indexing request if the document was last modification was assigned the given sequence number.
IndexRequestBuilder	setOpType(DocWriteRequest.OpType opType)	Sets the type of operation to perform.
IndexRequestBuilder	setPipeline(String pipeline)	Sets the ingest pipeline to be executed before indexing the document
IndexRequestBuilder	setRefreshPolicy(String refreshPolicy)	Parse the refresh policy from a string, only modifying it if the string is non null.
IndexRequestBuilder	setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)	Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).
IndexRequestBuilder	setRequireAlias(boolean requireAlias)	Sets the require_alias flag
IndexRequestBuilder	setRequireDataStream(boolean requireDataStream)	Sets the require_data_stream flag
IndexRequestBuilder	setRouting(String routing)	Controls the shard routing of the request.
IndexRequestBuilder	setSource(byte[] source, int offset, int length, XContentType xContentType)	Sets the document to index in bytes form (assumed to be safe to be used from different threads).
IndexRequestBuilder	setSource(byte[] source, XContentType xContentType)	Sets the document to index in bytes form.
IndexRequestBuilder	setSource(Object... source)	Constructs a simple document with a field name and value pairs.
IndexRequestBuilder	setSource(String source, XContentType xContentType)	Sets the document source to index.
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(BytesReference source, XContentType xContentType)	Sets the source.
IndexRequestBuilder	setSource(XContentBuilder sourceBuilder)	Sets the content source to index.
IndexRequestBuilder	setSource(XContentType xContentType, Object... source)	Constructs a simple document with a field name and value pairs.
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

apply, getIndex, setIndex, setTimeout, setTimeout, setWaitForActiveShards, setWaitForActiveShards

Methods inherited from class org.elasticsearch.action.ActionRequestLazyBuilder

execute, execute, get, get

Methods inherited from class java.lang.Object

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

Constructor Details

IndexRequestBuilder

public IndexRequestBuilder(ElasticsearchClient client)

IndexRequestBuilder

public IndexRequestBuilder(ElasticsearchClient client,
 @Nullable
 String index)

Method Details

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.

setSource

public IndexRequestBuilder setSource(BytesReference source,
 XContentType xContentType)

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,
 XContentType xContentType)

Sets the document source to index.

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

setSource

public IndexRequestBuilder setSource(XContentBuilder sourceBuilder)

Sets the content source to index.

setSource

public IndexRequestBuilder setSource(byte[] source,
 XContentType xContentType)

Sets the document to index in bytes form.

setSource

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

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

xContentType - The type/format of the source

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. Also the first argument in each pair (the field name) must have a valid String representation.

setSource

public IndexRequestBuilder setSource(XContentType xContentType,
 Object... source)

Constructs a simple document with a field name and value pairs.

Note: the number of objects passed as varargs to this method must be an even number. Also the first argument in each pair (the field name) must have a valid String representation.

setOpType

public IndexRequestBuilder setOpType(DocWriteRequest.OpType opType)

Sets the type of operation to perform.

setCreate

public IndexRequestBuilder setCreate(boolean create)

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

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.

setIfSeqNo

public IndexRequestBuilder setIfSeqNo(long seqNo)

only perform this indexing request if the document was last modification was assigned the given sequence number. Must be used in combination with setIfPrimaryTerm(long) If the document last modification was assigned a different sequence number a VersionConflictEngineException will be thrown.

setIfPrimaryTerm

public IndexRequestBuilder setIfPrimaryTerm(long term)

only perform this indexing request if the document was last modification was assigned the given primary term. Must be used in combination with setIfSeqNo(long) If the document last modification was assigned a different term a VersionConflictEngineException will be thrown.

setPipeline

public IndexRequestBuilder setPipeline(String pipeline)

Sets the ingest pipeline to be executed before indexing the document

setRequireAlias

public IndexRequestBuilder setRequireAlias(boolean requireAlias)

Sets the require_alias flag

setRequireDataStream

public IndexRequestBuilder setRequireDataStream(boolean requireDataStream)

Sets the require_data_stream flag

setRefreshPolicy

public IndexRequestBuilder setRefreshPolicy(WriteRequest.RefreshPolicy refreshPolicy)

Description copied from interface: WriteRequestBuilder

Should this request trigger a refresh (WriteRequest.RefreshPolicy.IMMEDIATE), wait for a refresh ( WriteRequest.RefreshPolicy.WAIT_UNTIL), or proceed ignore refreshes entirely (WriteRequest.RefreshPolicy.NONE, the default).

Specified by:

setRefreshPolicy in interface WriteRequestBuilder<IndexRequestBuilder>

setRefreshPolicy

public IndexRequestBuilder setRefreshPolicy(String refreshPolicy)

Description copied from interface: WriteRequestBuilder

Parse the refresh policy from a string, only modifying it if the string is non null. Convenient to use with request parsing.

Specified by:

setRefreshPolicy in interface WriteRequestBuilder<IndexRequestBuilder>

request

public IndexRequest request()

Description copied from class: ActionRequestLazyBuilder

This method creates the request. The caller of this method is responsible for calling Request#decRef.

Specified by:

request in interface RequestBuilder<IndexRequest,DocWriteResponse>

Specified by:

request in interface WriteRequestBuilder<IndexRequestBuilder>

Specified by:

request in class ActionRequestLazyBuilder<IndexRequest,DocWriteResponse>

Returns:

A newly-built Request, fully initialized by this builder.