Module org.elasticsearch.server

Package org.elasticsearch.index.engine

Class Engine.Index

java.lang.Object

org.elasticsearch.index.engine.Engine.Operation

org.elasticsearch.index.engine.Engine.Index

Enclosing class:

Engine

public static class Engine.Index
extends Engine.Operation

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.index.engine.Engine.Operation

Engine.Operation.Origin, Engine.Operation.TYPE

Constructor Summary

Constructors

Constructor	Description
Index(org.apache.lucene.util.BytesRef uid, long primaryTerm, ParsedDocument doc)
Index(org.apache.lucene.util.BytesRef uid, ParsedDocument doc, long seqNo, long primaryTerm, long version, VersionType versionType, Engine.Operation.Origin origin, long startTime, long autoGeneratedIdTimestamp, boolean isRetry, long ifSeqNo, long ifPrimaryTerm)

Method Summary

Modifier and Type	Method	Description
List<LuceneDocument>	docs()
int	estimatedSizeInBytes()
long	getAutoGeneratedIdTimestamp()	Returns a positive timestamp if the ID of this document is auto-generated by elasticsearch.
long	getIfPrimaryTerm()
long	getIfSeqNo()
String	id()
boolean	isRetry()	Returns true if this index requests has been retried on the coordinating node and can therefor be delivered multiple times.
Engine.Operation.TYPE	operationType()
ParsedDocument	parsedDoc()
String	routing()
BytesReference	source()

Methods inherited from class org.elasticsearch.index.engine.Engine.Operation

origin, primaryTerm, seqNo, startTime, uid, version, versionType

Methods inherited from class java.lang.Object

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

Constructor Details

Index

public Index(org.apache.lucene.util.BytesRef uid,
 ParsedDocument doc,
 long seqNo,
 long primaryTerm,
 long version,
 VersionType versionType,
 Engine.Operation.Origin origin,
 long startTime,
 long autoGeneratedIdTimestamp,
 boolean isRetry,
 long ifSeqNo,
 long ifPrimaryTerm)

Index

public Index(org.apache.lucene.util.BytesRef uid,
 long primaryTerm,
 ParsedDocument doc)

Method Details

parsedDoc

public ParsedDocument parsedDoc()

id

public String id()

operationType

public Engine.Operation.TYPE operationType()

Specified by:

operationType in class Engine.Operation

routing

public String routing()

docs

public List<LuceneDocument> docs()

source

public BytesReference source()

estimatedSizeInBytes

public int estimatedSizeInBytes()

Specified by:

estimatedSizeInBytes in class Engine.Operation

getAutoGeneratedIdTimestamp

public long getAutoGeneratedIdTimestamp()

Returns a positive timestamp if the ID of this document is auto-generated by elasticsearch. if this property is non-negative indexing code might optimize the addition of this document due to it's append only nature.

isRetry

public boolean isRetry()

Returns true if this index requests has been retried on the coordinating node and can therefor be delivered multiple times. Note: this might also be set to true if an equivalent event occurred like the replay of the transaction log

getIfSeqNo

public long getIfSeqNo()

getIfPrimaryTerm

public long getIfPrimaryTerm()