Package com.couchbase.client.core.msg.kv

Enum SubDocumentOpResponseStatus

java.lang.Object

java.lang.Enum<SubDocumentOpResponseStatus>

com.couchbase.client.core.msg.kv.SubDocumentOpResponseStatus

All Implemented Interfaces:

Serializable, Comparable<SubDocumentOpResponseStatus>

public enum SubDocumentOpResponseStatus
extends Enum<SubDocumentOpResponseStatus>

The SubDocumentOpResponseStatus describes what kind of response came back for a specific subdoc operation request.

Since:

2.0.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
CAN_ONLY_REVIVE_DELETED_DOCUMENTS	The ReviveDocument flag can only be used on deleted documents (tombstones).
DELTA_RANGE	The operation would result in a number outside the valid range
DOC_NOT_JSON	The existing document is not valid JSON
DOC_TOO_DEEP	The document has too many levels to parse
INVALID_COMBO	An invalid combination of commands was specified
MULTI_PATH_FAILURE	Specified key was successfully found, but one or more path operations failed
NUM_RANGE	The existing number is out of the valid range for arithmetic operations
PATH_EXISTS	The requested operation requires the path to not already exist, but it exists
PATH_INVALID	The path's syntax was incorrect
PATH_MISMATCH	One of path components treats a non-dictionary as a dictionary, or a non-array as an array, or value the path points to is not a number
PATH_NOT_FOUND	The provided path does not exist in the document
PATH_TOO_BIG	The path provided is too large: either the string is too long, or it contains too many components
SUCCESS	Indicates a successful response in general.
SUCCESS_DELETED_DOCUMENT	The subdoc operation completed successfully on the deleted document
UNKNOWN	Unknown error.
VALUE_CANTINSERT	The value provided will invalidate the JSON if inserted
VALUE_TOO_DEEP	Inserting the value would cause the document to be too deep
XATTR_CANNOT_MODIFY_VATTR	Cannot modify this virtual attribute.
XATTR_INVALID_FLAG_COMBO	An invalid combination of operations, using macros when not using extended attributes
XATTR_INVALID_KEY_COMBO	Only single xattr key may be accessed at the same time
XATTR_INVALID_ORDER	Invalid XATTR order.
XATTR_NO_ACCESS	User does not have permission to access this attribute.
XATTR_UNKNOWN_MACRO	The server has no knowledge of the requested macro
XATTR_UNKNOWN_VATTR	Unknown virtual attribute.

Method Summary

Modifier and Type	Method	Description
boolean	success()
static SubDocumentOpResponseStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SubDocumentOpResponseStatus[]	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

SUCCESS

public static final SubDocumentOpResponseStatus SUCCESS

Indicates a successful response in general.

SUCCESS_DELETED_DOCUMENT

public static final SubDocumentOpResponseStatus SUCCESS_DELETED_DOCUMENT

The subdoc operation completed successfully on the deleted document

PATH_NOT_FOUND

public static final SubDocumentOpResponseStatus PATH_NOT_FOUND

The provided path does not exist in the document

PATH_MISMATCH

public static final SubDocumentOpResponseStatus PATH_MISMATCH

One of path components treats a non-dictionary as a dictionary, or a non-array as an array, or value the path points to is not a number

PATH_INVALID

public static final SubDocumentOpResponseStatus PATH_INVALID

The path's syntax was incorrect

PATH_TOO_BIG

public static final SubDocumentOpResponseStatus PATH_TOO_BIG

The path provided is too large: either the string is too long, or it contains too many components

DOC_TOO_DEEP

public static final SubDocumentOpResponseStatus DOC_TOO_DEEP

The document has too many levels to parse

VALUE_CANTINSERT

public static final SubDocumentOpResponseStatus VALUE_CANTINSERT

The value provided will invalidate the JSON if inserted

DOC_NOT_JSON

public static final SubDocumentOpResponseStatus DOC_NOT_JSON

The existing document is not valid JSON

NUM_RANGE

public static final SubDocumentOpResponseStatus NUM_RANGE

The existing number is out of the valid range for arithmetic operations

DELTA_RANGE

public static final SubDocumentOpResponseStatus DELTA_RANGE

The operation would result in a number outside the valid range

PATH_EXISTS

public static final SubDocumentOpResponseStatus PATH_EXISTS

The requested operation requires the path to not already exist, but it exists

VALUE_TOO_DEEP

public static final SubDocumentOpResponseStatus VALUE_TOO_DEEP

Inserting the value would cause the document to be too deep

INVALID_COMBO

public static final SubDocumentOpResponseStatus INVALID_COMBO

An invalid combination of commands was specified

MULTI_PATH_FAILURE

public static final SubDocumentOpResponseStatus MULTI_PATH_FAILURE

Specified key was successfully found, but one or more path operations failed

XATTR_INVALID_FLAG_COMBO

public static final SubDocumentOpResponseStatus XATTR_INVALID_FLAG_COMBO

An invalid combination of operations, using macros when not using extended attributes

XATTR_INVALID_KEY_COMBO

public static final SubDocumentOpResponseStatus XATTR_INVALID_KEY_COMBO

Only single xattr key may be accessed at the same time

XATTR_UNKNOWN_MACRO

public static final SubDocumentOpResponseStatus XATTR_UNKNOWN_MACRO

The server has no knowledge of the requested macro

XATTR_UNKNOWN_VATTR

public static final SubDocumentOpResponseStatus XATTR_UNKNOWN_VATTR

Unknown virtual attribute.

XATTR_CANNOT_MODIFY_VATTR

public static final SubDocumentOpResponseStatus XATTR_CANNOT_MODIFY_VATTR

Cannot modify this virtual attribute.

XATTR_INVALID_ORDER

public static final SubDocumentOpResponseStatus XATTR_INVALID_ORDER

Invalid XATTR order.

XATTR_NO_ACCESS

public static final SubDocumentOpResponseStatus XATTR_NO_ACCESS

User does not have permission to access this attribute.

CAN_ONLY_REVIVE_DELETED_DOCUMENTS

public static final SubDocumentOpResponseStatus CAN_ONLY_REVIVE_DELETED_DOCUMENTS

The ReviveDocument flag can only be used on deleted documents (tombstones).

UNKNOWN

public static final SubDocumentOpResponseStatus UNKNOWN

Unknown error.

Method Detail

values

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

Returns:

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

valueOf

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

success

public boolean success()