org.elasticsearch.index.engine

Class Engine.Result

java.lang.Object

org.elasticsearch.index.engine.Engine.Result

Direct Known Subclasses:

Engine.DeleteResult, Engine.IndexResult

Enclosing class:

Engine

public abstract static class Engine.Result
extends java.lang.Object

Base class for index and delete operation results Holds result meta data (e.g. translog location, updated version) for an executed write Engine.Operation

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Result(Engine.Operation.TYPE operationType, java.lang.Exception failure, long version)
protected	Result(Engine.Operation.TYPE operationType, long version)

Method Summary

Modifier and Type	Method and Description
java.lang.Exception	getFailure() get document failure while executing the operation null in case of no failure
Engine.Operation.TYPE	getOperationType()
long	getTook() get total time in nanoseconds
Translog.Location	getTranslogLocation() get the translog location after executing the operation
long	getVersion() get the updated document version
boolean	hasFailure() whether the operation had failure

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

protected Result(Engine.Operation.TYPE operationType,
                 java.lang.Exception failure,
                 long version)

Result

protected Result(Engine.Operation.TYPE operationType,
                 long version)

Method Detail

hasFailure

public boolean hasFailure()

whether the operation had failure

getVersion

public long getVersion()

get the updated document version

getTranslogLocation

public Translog.Location getTranslogLocation()

get the translog location after executing the operation

getFailure

public java.lang.Exception getFailure()

get document failure while executing the operation null in case of no failure

getTook

public long getTook()

get total time in nanoseconds

getOperationType

public Engine.Operation.TYPE getOperationType()