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>
,java.lang.constant.Constable
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
-
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 DELTA_RANGE
The operation would result in a number outside the valid rangeDOC_NOT_JSON
The existing document is not valid JSONDOC_TOO_DEEP
The document has too many levels to parseINVALID_COMBO
An invalid combination of commands was specifiedMULTI_PATH_FAILURE
Specified key was successfully found, but one or more path operations failedNUM_RANGE
The existing number is out of the valid range for arithmetic operationsPATH_EXISTS
The requested operation requires the path to not already exist, but it existsPATH_INVALID
The path's syntax was incorrectPATH_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 numberPATH_NOT_FOUND
The provided path does not exist in the documentPATH_TOO_BIG
The path provided is too large: either the string is too long, or it contains too many componentsSUCCESS
Indicates a successful response in general.SUCCESS_DELETED_DOCUMENT
The subdoc operation completed successfully on the deleted documentUNKNOWN
Unknown error.VALUE_CANTINSERT
The value provided will invalidate the JSON if insertedVALUE_TOO_DEEP
Inserting the value would cause the document to be too deepXATTR_CANNOT_MODIFY_VATTR
Cannot modify this virtual attribute.XATTR_INVALID_FLAG_COMBO
An invalid combination of operations, using macros when not using extended attributesXATTR_INVALID_KEY_COMBO
Only single xattr key may be accessed at the same timeXATTR_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 macroXATTR_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.
-
Enum Constant Details
-
SUCCESS
Indicates a successful response in general. -
SUCCESS_DELETED_DOCUMENT
The subdoc operation completed successfully on the deleted document -
PATH_NOT_FOUND
The provided path does not exist in the document -
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
The path's syntax was incorrect -
PATH_TOO_BIG
The path provided is too large: either the string is too long, or it contains too many components -
DOC_TOO_DEEP
The document has too many levels to parse -
VALUE_CANTINSERT
The value provided will invalidate the JSON if inserted -
DOC_NOT_JSON
The existing document is not valid JSON -
NUM_RANGE
The existing number is out of the valid range for arithmetic operations -
DELTA_RANGE
The operation would result in a number outside the valid range -
PATH_EXISTS
The requested operation requires the path to not already exist, but it exists -
VALUE_TOO_DEEP
Inserting the value would cause the document to be too deep -
INVALID_COMBO
An invalid combination of commands was specified -
MULTI_PATH_FAILURE
Specified key was successfully found, but one or more path operations failed -
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_UNKNOWN_MACRO
The server has no knowledge of the requested macro -
XATTR_UNKNOWN_VATTR
Unknown virtual attribute. -
XATTR_CANNOT_MODIFY_VATTR
Cannot modify this virtual attribute. -
XATTR_INVALID_ORDER
Invalid XATTR order. -
XATTR_NO_ACCESS
User does not have permission to access this attribute. -
UNKNOWN
Unknown error.
-
-
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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
success
public boolean success()
-