org.elasticsearch.action.updatebyquery

Enum BulkResponseOption

java.lang.Object

java.lang.Enum<BulkResponseOption>

org.elasticsearch.action.updatebyquery.BulkResponseOption

All Implemented Interfaces:

Serializable, Comparable<BulkResponseOption>

public enum BulkResponseOption
extends Enum<BulkResponseOption>

Specifies how bulk responses that have been created based on the documents that have matched with the update query are returned in the response.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL All bulk responses are included in the response.
FAILED Only failed bulk responses are included in the response.
NONE Bulk responses aren't included in the response.

Method Summary

Methods

Modifier and Type	Method and Description
static BulkResponseOption	fromId(byte id) Constructs the bulk response option from its internal representation.
static BulkResponseOption	fromString(String type) Parse the bulk response option from string.
byte	id() The internal representation of the operation type.
static BulkResponseOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static BulkResponseOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

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

NONE

public static final BulkResponseOption NONE

Bulk responses aren't included in the response.

FAILED

public static final BulkResponseOption FAILED

Only failed bulk responses are included in the response.

ALL

public static final BulkResponseOption ALL

All bulk responses are included in the response.

Method Detail

values

public static BulkResponseOption[] 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 (BulkResponseOption c : BulkResponseOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static BulkResponseOption 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

id

public byte id()

The internal representation of the operation type.

fromId

public static BulkResponseOption fromId(byte id)

Constructs the bulk response option from its internal representation.

fromString

public static BulkResponseOption fromString(String type)

Parse the bulk response option from string.