Package org.elasticsearch.action

Enum DocWriteResponse.Result

java.lang.Object

java.lang.Enum<DocWriteResponse.Result>

org.elasticsearch.action.DocWriteResponse.Result

All Implemented Interfaces:

Serializable, Comparable<DocWriteResponse.Result>, Writeable

Enclosing class:

DocWriteResponse

public static enum DocWriteResponse.Result
extends Enum<DocWriteResponse.Result>
implements Writeable

An enum that represents the results of CRUD operations, primarily used to communicate the type of operation that occurred.

Nested Class Summary

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

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATED
DELETED
NOOP
NOT_FOUND
UPDATED

Method Summary

Modifier and Type	Method	Description
String	getLowercase()
byte	getOp()
static DocWriteResponse.Result	readFrom(StreamInput in)
static DocWriteResponse.Result	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DocWriteResponse.Result[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CREATED

public static final DocWriteResponse.Result CREATED

UPDATED

public static final DocWriteResponse.Result UPDATED

DELETED

public static final DocWriteResponse.Result DELETED

NOT_FOUND

public static final DocWriteResponse.Result NOT_FOUND

NOOP

public static final DocWriteResponse.Result NOOP

Method Detail

values

public static DocWriteResponse.Result[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DocWriteResponse.Result c : DocWriteResponse.Result.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DocWriteResponse.Result valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getOp

public byte getOp()

getLowercase

public String getLowercase()

readFrom

public static DocWriteResponse.Result readFrom(StreamInput in)
                                        throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException