Package org.opensearch.action
Enum DocWriteResponse.Result
java.lang.Object
java.lang.Enum<DocWriteResponse.Result>
org.opensearch.action.DocWriteResponse.Result
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<DocWriteResponse.Result>
,java.lang.constant.Constable
,Writeable
- Enclosing class:
- DocWriteResponse
public static enum DocWriteResponse.Result extends java.lang.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 class java.lang.Enum
java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Enum Constant Summary
-
Method Summary
Modifier and Type Method Description java.lang.String
getLowercase()
byte
getOp()
static DocWriteResponse.Result
readFrom(StreamInput in)
static DocWriteResponse.Result
valueOf(java.lang.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.
-
Enum Constant Details
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getOp
public byte getOp() -
getLowercase
public java.lang.String getLowercase() -
readFrom
- Throws:
java.io.IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.
-