Package org.elasticsearch.action.index

Class IndexRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

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

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

org.elasticsearch.action.index.IndexRequest

All Implemented Interfaces:

org.apache.lucene.util.Accountable, CompositeIndicesRequest, DocWriteRequest<IndexRequest>, IndicesRequest, WriteRequest<IndexRequest>, Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest

public class IndexRequest
extends ReplicatedWriteRequest<IndexRequest>
implements DocWriteRequest<IndexRequest>, CompositeIndicesRequest

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[], XContentType) to be set. The source (content to index) can be set in its bytes form using (source(byte[], XContentType)), its string form (source(String, XContentType)) 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/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

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

DocWriteRequest.OpType

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

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Nested classes/interfaces inherited from interface org.elasticsearch.action.support.WriteRequest

WriteRequest.RefreshPolicy

Field Summary

Fields

Modifier and Type	Field	Description
static long	UNSET_AUTO_GENERATED_TIMESTAMP	Value for getAutoGeneratedTimestamp() if the document has an external provided ID.

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

DEFAULT_TIMEOUT, index, shardId, timeout, waitForActiveShards

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Fields inherited from interface org.elasticsearch.action.DocWriteRequest

REQUIRE_ALIAS

Constructor Summary

Constructors

Constructor	Description
IndexRequest()
IndexRequest(String index)	Constructs a new index request against the specific index.
IndexRequest(String index, String type)	Deprecated. Types are in the process of being removed.
IndexRequest(String index, String type, String id)	Deprecated. Types are in the process of being removed.
IndexRequest(StreamInput in)
IndexRequest(ShardId shardId, StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	checkAutoIdWithOpTypeCreateSupportedByVersion(Version version)
IndexRequest	create(boolean create)	Set to true to force this index to use DocWriteRequest.OpType.CREATE.
IndexRequest	defaultTypeIfNull(String defaultType)	Deprecated. Types are in the process of being removed.
long	getAutoGeneratedTimestamp()	Returns the timestamp the auto generated ID was created or -1L if the document has no auto generated timestamp.
org.elasticsearch.common.xcontent.XContentType	getContentType()	The content type.
Map<String,String>	getDynamicTemplates()	Returns a map from the full path of field names to the name of dynamic mapping templates.
String	getFinalPipeline()	Returns the final ingest pipeline to be executed before indexing the document.
String	getPipeline()	Returns the ingest pipeline to be executed before indexing the document
String	id()	The id of the indexed document.
IndexRequest	id(String id)	Sets the id of the indexed document.
long	ifPrimaryTerm()	If set, only perform this indexing request if the document was last modification was assigned this primary term.
long	ifSeqNo()	If set, only perform this indexing request if the document was last modification was assigned this sequence number.
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
boolean	isPipelineResolved()	Returns whether or not the pipeline for this request has been resolved by the coordinating node.
IndexRequest	isPipelineResolved(boolean isPipelineResolved)	Sets if the pipeline for this request has been resolved by the coordinating node.
boolean	isRequireAlias()	Should this request override specifically require the destination to be an alias?
boolean	isRetry()	Returns true if this request has been sent to a shard copy more than once.
void	onRetry()	This method is called before this replication request is retried the first time.
DocWriteRequest.OpType	opType()	Get the requested document operation type of the request
IndexRequest	opType(String opType)	Sets a string representation of the opType(OpType).
IndexRequest	opType(DocWriteRequest.OpType opType)	Sets the type of operation to perform.
void	process(Version indexCreatedVersion, MappingMetadata mappingMd, String concreteIndex)
long	ramBytesUsed()
void	resolveRouting(Metadata metadata)
String	routing()	Controls the shard routing of the request.
IndexRequest	routing(String routing)	Controls the shard routing of the request.
IndexRequest	setDynamicTemplates(Map<String,String> dynamicTemplates)	Specifies a map from the full path of field names to the name of dynamic mapping templates
IndexRequest	setFinalPipeline(String finalPipeline)	Sets the final ingest pipeline to be executed before indexing the document.
IndexRequest	setIfPrimaryTerm(long term)	only performs this indexing request if the document was last modification was assigned the given primary term.
IndexRequest	setIfSeqNo(long seqNo)	only perform this indexing request if the document was last modification was assigned the given sequence number.
IndexRequest	setPipeline(String pipeline)	Sets the ingest pipeline to be executed before indexing the document
IndexRequest	setRequireAlias(boolean requireAlias)
BytesReference	source()	The source of the document to index, recopied to a new array if it is unsafe.
IndexRequest	source(byte[] source, int offset, int length, org.elasticsearch.common.xcontent.XContentType xContentType)	Sets the document to index in bytes form (assumed to be safe to be used from different threads).
IndexRequest	source(byte[] source, org.elasticsearch.common.xcontent.XContentType xContentType)	Sets the document to index in bytes form.
IndexRequest	source(Object... source)	Sets the content source to index using the default content type (Requests.INDEX_CONTENT_TYPE)
IndexRequest	source(String source, org.elasticsearch.common.xcontent.XContentType xContentType)	Sets the document source to index.
IndexRequest	source(Map<String,?> source)	Index the Map in Requests.INDEX_CONTENT_TYPE format
IndexRequest	source(Map<String,?> source, org.elasticsearch.common.xcontent.XContentType contentType)	Index the Map as the provided content type.
IndexRequest	source(BytesReference source, org.elasticsearch.common.xcontent.XContentType xContentType)	Sets the document to index in bytes form.
IndexRequest	source(org.elasticsearch.common.xcontent.XContentBuilder sourceBuilder)	Sets the content source to index.
IndexRequest	source(org.elasticsearch.common.xcontent.XContentType xContentType, Object... source)	Sets the content source to index.
Map<String,Object>	sourceAsMap()
String	toString()
String	type()	Deprecated. Types are in the process of being removed.
IndexRequest	type(String type)	Deprecated. Types are in the process of being removed.
ActionRequestValidationException	validate()
long	version()	Returns stored version.
IndexRequest	version(long version)	Sets the version, which will perform the operation only if a matching version exists and no changes happened on the doc since then.
VersionType	versionType()	Get the document version type for this request
IndexRequest	versionType(VersionType versionType)	Sets the versioning type.
void	writeThin(StreamOutput out)	Thin serialization that does not write ReplicationRequest.shardId and will only write ReplicationRequest.index if it is different from the index name in ReplicationRequest.shardId.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

getRefreshPolicy, setRefreshPolicy

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

createTask, getDescription, index, index, indices, routedBasedOnClusterVersion, shardId, timeout, timeout, timeout, waitForActiveShards, waitForActiveShards, waitForActiveShards

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Methods inherited from interface org.elasticsearch.action.DocWriteRequest

index, index

Methods inherited from interface org.elasticsearch.action.IndicesRequest

allowsRemoteIndices, indices

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

setParentTask

Methods inherited from interface org.elasticsearch.action.support.WriteRequest

setRefreshPolicy

Field Details

UNSET_AUTO_GENERATED_TIMESTAMP

public static final long UNSET_AUTO_GENERATED_TIMESTAMP

Value for getAutoGeneratedTimestamp() if the document has an external provided ID.

See Also:

Constant Field Values

Constructor Details

IndexRequest

public IndexRequest(StreamInput in)
             throws IOException

Throws:

IOException

IndexRequest

public IndexRequest(@Nullable
 ShardId shardId,
 StreamInput in)
             throws IOException

Throws:

IOException

IndexRequest

public IndexRequest()

IndexRequest

public IndexRequest(String index)

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

IndexRequest

@Deprecated
public IndexRequest(String index,
 String type)

Deprecated.

Types are in the process of being removed. Use IndexRequest(String) instead.

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

IndexRequest

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

Deprecated.

Types are in the process of being removed. Use IndexRequest(String) with id(String) instead.

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 Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in interface WriteRequest<IndexRequest>

Overrides:

validate in class ReplicationRequest<IndexRequest>

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface DocWriteRequest<IndexRequest>

Specified by:

indicesOptions in interface IndicesRequest

Overrides:

indicesOptions in class ReplicationRequest<IndexRequest>

Returns:

the indices options

getContentType

public org.elasticsearch.common.xcontent.XContentType getContentType()

The content type. This will be used when generating a document from user provided objects like Maps and when parsing the source at index time

type

@Deprecated
public String type()

Deprecated.

Types are in the process of being removed.

The type of the indexed document.

Specified by:

type in interface DocWriteRequest<IndexRequest>

Returns:

the type

type

@Deprecated
public IndexRequest type(String type)

Deprecated.

Types are in the process of being removed.

Sets the type of the indexed document.

Specified by:

type in interface DocWriteRequest<IndexRequest>

Returns:

the Request

defaultTypeIfNull

@Deprecated
public IndexRequest defaultTypeIfNull(String defaultType)

Deprecated.

Types are in the process of being removed.

Set the default type supplied to a bulk request if this individual request's type is null or empty

Specified by:

defaultTypeIfNull in interface DocWriteRequest<IndexRequest>

Returns:

the Request

id

public String id()

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

Specified by:

id in interface DocWriteRequest<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 DocWriteRequest<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 DocWriteRequest<IndexRequest>

Returns:

the Routing

setPipeline

public IndexRequest setPipeline(String pipeline)

Sets the ingest pipeline to be executed before indexing the document

getPipeline

public String getPipeline()

Returns the ingest pipeline to be executed before indexing the document

setFinalPipeline

public IndexRequest setFinalPipeline(String finalPipeline)

Sets the final ingest pipeline to be executed before indexing the document.

Parameters:

finalPipeline - the name of the final pipeline

Returns:

this index request

getFinalPipeline

public String getFinalPipeline()

Returns the final ingest pipeline to be executed before indexing the document.

Returns:

the name of the final pipeline

isPipelineResolved

public IndexRequest isPipelineResolved(boolean isPipelineResolved)

Sets if the pipeline for this request has been resolved by the coordinating node.

Parameters:

isPipelineResolved - true if the pipeline has been resolved

Returns:

the request

isPipelineResolved

public boolean isPipelineResolved()

Returns whether or not the pipeline for this request has been resolved by the coordinating node.

Returns:

true if the pipeline has been resolved

source

public BytesReference source()

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

sourceAsMap

public Map<String,Object> sourceAsMap()

source

public IndexRequest source(Map<String,?> source)
                    throws ElasticsearchGenerationException

Index the Map in Requests.INDEX_CONTENT_TYPE format

Parameters:

source - The map to index

Throws:

ElasticsearchGenerationException

source

public IndexRequest source(Map<String,?> source,
 org.elasticsearch.common.xcontent.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,
 org.elasticsearch.common.xcontent.XContentType xContentType)

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[], XContentType).

source

public IndexRequest source(org.elasticsearch.common.xcontent.XContentBuilder sourceBuilder)

Sets the content source to index.

source

public IndexRequest source(Object... source)

Sets the content source to index using the default content type (Requests.INDEX_CONTENT_TYPE)

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.

source

public IndexRequest source(org.elasticsearch.common.xcontent.XContentType xContentType,
 Object... source)

Sets the content source to index.

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

source

public IndexRequest source(BytesReference source,
 org.elasticsearch.common.xcontent.XContentType xContentType)

Sets the document to index in bytes form.

source

public IndexRequest source(byte[] source,
 org.elasticsearch.common.xcontent.XContentType xContentType)

Sets the document to index in bytes form.

source

public IndexRequest source(byte[] source,
 int offset,
 int length,
 org.elasticsearch.common.xcontent.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

opType

public IndexRequest opType(DocWriteRequest.OpType opType)

Sets the type of operation to perform.

opType

public IndexRequest opType(String opType)

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

create

public IndexRequest create(boolean create)

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

opType

public DocWriteRequest.OpType opType()

Description copied from interface: DocWriteRequest

Get the requested document operation type of the request

Specified by:

opType in interface DocWriteRequest<IndexRequest>

Returns:

the operation type DocWriteRequest.OpType

version

public IndexRequest version(long version)

Description copied from interface: DocWriteRequest

Sets the version, which will perform the operation only if a matching version exists and no changes happened on the doc since then.

Specified by:

version in interface DocWriteRequest<IndexRequest>

version

public long version()

Returns stored version. If currently stored version is Versions.MATCH_ANY and opType is DocWriteRequest.OpType.CREATE, returns Versions.MATCH_DELETED.

Specified by:

version in interface DocWriteRequest<IndexRequest>

Returns:

the document version

versionType

public IndexRequest versionType(VersionType versionType)

Description copied from interface: DocWriteRequest

Sets the versioning type. Defaults to VersionType.INTERNAL.

Specified by:

versionType in interface DocWriteRequest<IndexRequest>

setIfSeqNo

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

Specified by:

setIfSeqNo in interface DocWriteRequest<IndexRequest>

setIfPrimaryTerm

public IndexRequest setIfPrimaryTerm(long term)

only performs 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.

Specified by:

setIfPrimaryTerm in interface DocWriteRequest<IndexRequest>

ifSeqNo

public long ifSeqNo()

If set, only perform this indexing request if the document was last modification was assigned this sequence number. If the document last modification was assigned a different sequence number a VersionConflictEngineException will be thrown.

Specified by:

ifSeqNo in interface DocWriteRequest<IndexRequest>

ifPrimaryTerm

public long ifPrimaryTerm()

If set, only perform this indexing request if the document was last modification was assigned this primary term. If the document last modification was assigned a different term a VersionConflictEngineException will be thrown.

Specified by:

ifPrimaryTerm in interface DocWriteRequest<IndexRequest>

versionType

public VersionType versionType()

Description copied from interface: DocWriteRequest

Get the document version type for this request

Specified by:

versionType in interface DocWriteRequest<IndexRequest>

Returns:

the document version type

process

public void process(Version indexCreatedVersion,
 @Nullable
 MappingMetadata mappingMd,
 String concreteIndex)

resolveRouting

public void resolveRouting(Metadata metadata)

checkAutoIdWithOpTypeCreateSupportedByVersion

public void checkAutoIdWithOpTypeCreateSupportedByVersion(Version version)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ReplicatedWriteRequest<IndexRequest>

Throws:

IOException

writeThin

public void writeThin(StreamOutput out)
               throws IOException

Description copied from class: ReplicationRequest

Thin serialization that does not write ReplicationRequest.shardId and will only write ReplicationRequest.index if it is different from the index name in ReplicationRequest.shardId.

Overrides:

writeThin in class ReplicatedWriteRequest<IndexRequest>

Throws:

IOException

toString

public String toString()

Specified by:

toString in class ReplicationRequest<IndexRequest>

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.indices() should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.

Specified by:

includeDataStreams in interface IndicesRequest

isRetry

public boolean isRetry()

Returns true if this request has been sent to a shard copy more than once.

onRetry

public void onRetry()

Description copied from class: ReplicationRequest

This method is called before this replication request is retried the first time.

Overrides:

onRetry in class ReplicationRequest<IndexRequest>

getAutoGeneratedTimestamp

public long getAutoGeneratedTimestamp()

Returns the timestamp the auto generated ID was created or -1L if the document has no auto generated timestamp. This method will return a positive value iff the id was auto generated.

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface org.apache.lucene.util.Accountable

isRequireAlias

public boolean isRequireAlias()

Description copied from interface: DocWriteRequest

Should this request override specifically require the destination to be an alias?

Specified by:

isRequireAlias in interface DocWriteRequest<IndexRequest>

Returns:

boolean flag, when true specifically requires an alias

setRequireAlias

public IndexRequest setRequireAlias(boolean requireAlias)

setDynamicTemplates

public IndexRequest setDynamicTemplates(Map<String,String> dynamicTemplates)

Specifies a map from the full path of field names to the name of dynamic mapping templates

getDynamicTemplates

public Map<String,String> getDynamicTemplates()

Returns a map from the full path of field names to the name of dynamic mapping templates.

See Also:

setDynamicTemplates(Map)