org.elasticsearch.action.index

Class IndexRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Request>

org.elasticsearch.action.support.ChildTaskActionRequest<T>

org.elasticsearch.action.support.replication.ReplicationRequest<IndexRequest>

org.elasticsearch.action.index.IndexRequest

All Implemented Interfaces:

DocumentRequest<IndexRequest>, IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class IndexRequest
extends ReplicationRequest<IndexRequest>
implements DocumentRequest<IndexRequest>

Index request to index a typed JSON document into a specific index and make it searchable. Best created using Requests.indexRequest(String).

The index requires the ReplicationRequest.index(), type(String), id(String) and source(byte[]) to be set.

The source (content to index) can be set in its bytes form using (source(byte[])), its string form (source(String)) or using a XContentBuilder (source(org.elasticsearch.common.xcontent.XContentBuilder)).

If the id(String) is not set, it will be automatically generated.

See Also:

IndexResponse, Requests.indexRequest(String), Client.index(IndexRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexRequest.OpType Operation type controls if the type of the index operation.

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

Fields inherited from class org.elasticsearch.action.support.replication.ReplicationRequest

DEFAULT_TIMEOUT, index, shardId, timeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
IndexRequest()
IndexRequest(ActionRequest request) Creates an index request caused by some other request, which is provided as an argument so that its headers and context can be copied to the new request
IndexRequest(IndexRequest indexRequest, ActionRequest originalRequest) Copy constructor that creates a new index request that is a copy of the one provided as an argument.
IndexRequest(String index) Constructs a new index request against the specific index.
IndexRequest(String index, String type) Constructs a new index request against the specific index and type.
IndexRequest(String index, String type, String id) Constructs a new index request against the index, type, id and using the source.

Method Summary

Modifier and Type	Method and Description
boolean	autoGeneratedId() Has the id been auto generated?
IndexRequest	contentType(XContentType contentType) Sets the content type that will be used when generating a document from user provided objects (like Map).
IndexRequest	create(boolean create) Set to true to force this index to use IndexRequest.OpType.CREATE.
XContentType	getContentType() The content type that will be used when generating a document from user provided objects like Maps.
String	id() The id of the indexed document.
IndexRequest	id(String id) Sets the id of the indexed document.
IndexRequest.OpType	opType() The type of operation to perform.
IndexRequest	opType(IndexRequest.OpType opType) Sets the type of operation to perform.
IndexRequest	opType(String opType) Sets a string representation of the opType(org.elasticsearch.action.index.IndexRequest.OpType).
String	parent()
IndexRequest	parent(String parent) Sets the parent id of this document.
void	process(MetaData metaData, MappingMetaData mappingMd, boolean allowIdGeneration, String concreteIndex)
void	readFrom(StreamInput in)
boolean	refresh()
IndexRequest	refresh(boolean refresh) Should a refresh be executed post this index operation causing the operation to be searchable.
String	routing() Controls the shard routing of the request.
IndexRequest	routing(String routing) Controls the shard routing of the request.
BytesReference	source() The source of the document to index, recopied to a new array if it is unsage.
IndexRequest	source(byte[] source) Sets the document to index in bytes form.
IndexRequest	source(byte[] source, int offset, int length) Sets the document to index in bytes form (assumed to be safe to be used from different threads).
IndexRequest	source(BytesReference source) Sets the document to index in bytes form.
IndexRequest	source(Map source) Index the Map as a Requests.INDEX_CONTENT_TYPE.
IndexRequest	source(Map source, XContentType contentType) Index the Map as the provided content type.
IndexRequest	source(Object... source)
IndexRequest	source(String source) Sets the document source to index.
IndexRequest	source(String field1, Object value1)
IndexRequest	source(String field1, Object value1, String field2, Object value2)
IndexRequest	source(String field1, Object value1, String field2, Object value2, String field3, Object value3)
IndexRequest	source(String field1, Object value1, String field2, Object value2, String field3, Object value3, String field4, Object value4)
IndexRequest	source(XContentBuilder sourceBuilder) Sets the content source to index.
Map<String,Object>	sourceAsMap()
String	timestamp()
IndexRequest	timestamp(String timestamp) Sets the timestamp either as millis since the epoch, or, in the configured date format.
String	toString()
TimeValue	ttl()
IndexRequest	ttl(long ttl) Sets the relative ttl value in milliseconds.
IndexRequest	ttl(String ttl)
IndexRequest	ttl(TimeValue ttl)
String	type() The type of the indexed document.
IndexRequest	type(String type) Sets the type of the indexed document.
ActionRequestValidationException	validate()
long	version()
IndexRequest	version(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.
VersionType	versionType()
IndexRequest	versionType(VersionType versionType) Sets the versioning type.
void	writeTo(StreamOutput out)

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

canHaveDuplicates, consistencyLevel, consistencyLevel, createTask, getDescription, index, index, indices, indicesOptions, setShardId, shardId, timeout, timeout, timeout

Methods inherited from class org.elasticsearch.action.support.ChildTaskActionRequest

createTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.DocumentRequest

index, indicesOptions

Methods inherited from interface org.elasticsearch.action.IndicesRequest

indices

Constructor Detail

IndexRequest

public IndexRequest()

IndexRequest

public IndexRequest(ActionRequest request)

Creates an index request caused by some other request, which is provided as an argument so that its headers and context can be copied to the new request

IndexRequest

public IndexRequest(IndexRequest indexRequest,
                    ActionRequest originalRequest)

Copy constructor that creates a new index request that is a copy of the one provided as an argument. The new request will inherit though headers and context from the original request that caused it.

IndexRequest

public IndexRequest(String index)

Constructs a new index request against the specific index. The type(String) source(byte[]) must be set.

IndexRequest

public IndexRequest(String index,
                    String type)

Constructs a new index request against the specific index and type. The source(byte[]) must be set.

IndexRequest

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

Constructs a new index request against the index, type, id and using the source.

Parameters:

index - The index to index into

type - The type to index into

id - The id of document

Method Detail

validate

public ActionRequestValidationException validate()

Overrides:

validate in class ReplicationRequest<IndexRequest>

getContentType

public XContentType getContentType()

The content type that will be used when generating a document from user provided objects like Maps.

contentType

public IndexRequest contentType(XContentType contentType)

Sets the content type that will be used when generating a document from user provided objects (like Map).

type

public String type()

The type of the indexed document.

Specified by:

type in interface DocumentRequest<IndexRequest>

Returns:

the type

type

public IndexRequest type(String type)

Sets the type of the indexed document.

id

public String id()

The id of the indexed document. If not set, will be automatically generated.

Specified by:

id in interface DocumentRequest<IndexRequest>

Returns:

the id

id

public IndexRequest id(String id)

Sets the id of the indexed document. If not set, will be automatically generated.

routing

public IndexRequest routing(String routing)

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

Specified by:

routing in interface DocumentRequest<IndexRequest>

Returns:

the Request

routing

public String routing()

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

Specified by:

routing in interface DocumentRequest<IndexRequest>

Returns:

the Routing

parent

public IndexRequest parent(String parent)

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

parent

public String parent()

timestamp

public IndexRequest timestamp(String timestamp)

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

timestamp

public String timestamp()

ttl

public IndexRequest ttl(long ttl)
                 throws ElasticsearchGenerationException

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

Throws:

ElasticsearchGenerationException

ttl

public IndexRequest ttl(String ttl)

ttl

public IndexRequest ttl(TimeValue ttl)

ttl

public TimeValue ttl()

source

public BytesReference source()

The source of the document to index, recopied to a new array if it is unsage.

sourceAsMap

public Map<String,Object> sourceAsMap()

source

public IndexRequest source(Map source)
                    throws ElasticsearchGenerationException

Index the Map as a Requests.INDEX_CONTENT_TYPE.

Parameters:

source - The map to index

Throws:

ElasticsearchGenerationException

source

public IndexRequest source(Map source,
                           XContentType contentType)
                    throws ElasticsearchGenerationException

Index the Map as the provided content type.

Parameters:

source - The map to index

Throws:

ElasticsearchGenerationException

source

public IndexRequest source(String source)

Sets the document source to index.

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

source

public IndexRequest source(XContentBuilder sourceBuilder)

Sets the content source to index.

source

public IndexRequest source(String field1,
                           Object value1)

source

public IndexRequest source(String field1,
                           Object value1,
                           String field2,
                           Object value2)

source

public IndexRequest source(String field1,
                           Object value1,
                           String field2,
                           Object value2,
                           String field3,
                           Object value3)

source

public IndexRequest source(String field1,
                           Object value1,
                           String field2,
                           Object value2,
                           String field3,
                           Object value3,
                           String field4,
                           Object value4)

source

public IndexRequest source(Object... source)

source

public IndexRequest source(BytesReference source)

Sets the document to index in bytes form.

source

public IndexRequest source(byte[] source)

Sets the document to index in bytes form.

source

public IndexRequest source(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

opType

public IndexRequest opType(IndexRequest.OpType opType)

Sets the type of operation to perform.

opType

public IndexRequest opType(String opType)

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

create

public IndexRequest create(boolean create)

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

opType

public IndexRequest.OpType opType()

The type of operation to perform.

refresh

public IndexRequest refresh(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.

refresh

public boolean refresh()

version

public IndexRequest version(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.

version

public long version()

versionType

public IndexRequest versionType(VersionType versionType)

Sets the versioning type. Defaults to VersionType.INTERNAL.

versionType

public VersionType versionType()

autoGeneratedId

public boolean autoGeneratedId()

Has the id been auto generated?

process

public void process(MetaData metaData,
                    @Nullable
                    MappingMetaData mappingMd,
                    boolean allowIdGeneration,
                    String concreteIndex)

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ReplicationRequest<IndexRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ReplicationRequest<IndexRequest>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class ReplicationRequest<IndexRequest>