Module org.elasticsearch.server

Package org.elasticsearch.action.bulk

Enum Class IndexDocFailureStoreStatus

java.lang.Object

java.lang.Enum<IndexDocFailureStoreStatus>

org.elasticsearch.action.bulk.IndexDocFailureStoreStatus

All Implemented Interfaces:

Serializable, Comparable<IndexDocFailureStoreStatus>, Constable, Writeable, ToXContent, ToXContentFragment

public enum IndexDocFailureStoreStatus
extends Enum<IndexDocFailureStoreStatus>
implements ToXContentFragment, Writeable

Captures the role of the failure store in this document response. For example, - USED, means that this document was stored in the failure store - NOT_ENABLED, means that this document was rejected by elasticsearch, but it could have been stored in the failure store has it been enabled. - FAILED, means that this failed document was eligible to be stored in the failure store and the failure store was enabled but something went wrong.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndexDocFailureStoreStatus.ExceptionWithFailureStoreStatus	Exception wrapper class that adds the failure store status in the XContent response.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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
FAILED	This status represents that this document was rejected from the failure store.
NOT_APPLICABLE_OR_UNKNOWN	This status represents that we have no information about this response or that the failure store is not applicable.
NOT_ENABLED	This status represents that this document was rejected, but it could have ended up in the failure store if it was enabled.
USED	This status represents that this document was stored in the failure store successfully.

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
static IndexDocFailureStoreStatus	fromId(byte id)
byte	getId()
String	getLabel()
static IndexDocFailureStoreStatus	read(StreamInput in)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
static IndexDocFailureStoreStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IndexDocFailureStoreStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Enum Constant Details

NOT_APPLICABLE_OR_UNKNOWN

public static final IndexDocFailureStoreStatus NOT_APPLICABLE_OR_UNKNOWN

This status represents that we have no information about this response or that the failure store is not applicable. For example: - when the doc was successfully indexed in a backing index of a data stream, - when we are running in a mixed version cluster and the information is not available, - when the doc was rejected by elasticsearch but failure store was not applicable (i.e. the target was an index).

USED

public static final IndexDocFailureStoreStatus USED

This status represents that this document was stored in the failure store successfully.

NOT_ENABLED

public static final IndexDocFailureStoreStatus NOT_ENABLED

This status represents that this document was rejected, but it could have ended up in the failure store if it was enabled.

FAILED

public static final IndexDocFailureStoreStatus FAILED

This status represents that this document was rejected from the failure store.

Method Details

values

public static IndexDocFailureStoreStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static IndexDocFailureStoreStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

read

public static IndexDocFailureStoreStatus read(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

getId

public byte getId()

Returns:

id of the status, mainly used for wire serialisation purposes

getLabel

public String getLabel()

Returns:

the label of this status for display, just lowercase of the enum

fromId

public static IndexDocFailureStoreStatus fromId(byte id)

Parameters:

id - a candidate id that (hopefully) can be converted to a FailureStoreStatus, used in wire serialisation

Returns:

the failure store status that corresponds to the id.

Throws:

IllegalArgumentException - when the id cannot produce a failure store status

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException