Package com.yahoo.documentapi.metrics

Enum Class DocumentOperationStatus

java.lang.Object

java.lang.Enum<DocumentOperationStatus>

com.yahoo.documentapi.metrics.DocumentOperationStatus

All Implemented Interfaces:

Serializable, Comparable<DocumentOperationStatus>, Constable

public enum DocumentOperationStatus
extends Enum<DocumentOperationStatus>

Enum with possible outcomes of a single document feeding operation:

• OK: Document was successfully added/updated/removed
• REQUEST_ERROR: User-made error, for example invalid document format
• SERVER_ERROR: Server-made error, for example insufficient disk space

Author:

freva

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONDITION_FAILED
NOT_FOUND
OK
REQUEST_ERROR
SERVER_ERROR
TOO_MANY_REQUESTS

Method Summary

Modifier and Type	Method	Description
static DocumentOperationStatus	fromMessageBusErrorCodes(Set<Integer> errorCodes)
static DocumentOperationStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocumentOperationStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

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

Enum Constant Details

OK

public static final DocumentOperationStatus OK

REQUEST_ERROR

public static final DocumentOperationStatus REQUEST_ERROR

SERVER_ERROR

public static final DocumentOperationStatus SERVER_ERROR

CONDITION_FAILED

public static final DocumentOperationStatus CONDITION_FAILED

NOT_FOUND

public static final DocumentOperationStatus NOT_FOUND

TOO_MANY_REQUESTS

public static final DocumentOperationStatus TOO_MANY_REQUESTS

Method Details

values

public static DocumentOperationStatus[] 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 DocumentOperationStatus 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

fromMessageBusErrorCodes

public static DocumentOperationStatus fromMessageBusErrorCodes(Set<Integer> errorCodes)