Package com.couchbase.client.core.io.netty.kv

Enum ErrorMap.ErrorAttribute

java.lang.Object
java.lang.Enum<ErrorMap.ErrorAttribute>
com.couchbase.client.core.io.netty.kv.ErrorMap.ErrorAttribute
All Implemented Interfaces:
Serializable, Comparable<ErrorMap.ErrorAttribute>
Enclosing class:
ErrorMap
public static enum ErrorMap.ErrorAttribute extends Enum<ErrorMap.ErrorAttribute>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AUTH
    The operation failed because the client failed to authenticate or is not authorized to perform this operation.
    AUTO_RETRY
    Use retry specifications from the server.
    CONN_STATE_INVALIDATED
    The current connection is no longer valid.
    DCP
    The error is related to the DCP subsystem.
    FETCH_CONFIG
    The client's cluster map may be outdated and requires updating.
    INTERNAL
    This is an internal error in the server.
    INVALID_INPUT
    This attribute means that a user's input was invalid because it violates the semantics of the operation, or exceeds some predefined limit.
    ITEM_DELETED
    This attribute means that the error is related to operating on a soft-deleted document.
    ITEM_LOCKED
    This attribute specifies that the requested item is currently locked.
    ITEM_ONLY
    This attribute means that the error is related to a constraint failure regarding the item itself, i.e.
    RETRY_LATER
    The operation may be retried after some time.
    RETRY_NOW
    The operation may be retried immediately.
    SPECIAL_HANDLING
    This error code must be handled specially.
    SUBDOC
    The error is related to the subdocument subsystem.
    SUCCESS
    The operation was successful for those situations where the error code is indicating successful (i.e.
    SUPPORT
    The operation is not supported, possibly because the of server version, bucket type, or current user.
    TEMP
    This error is transient.

  • Method Summary

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

    • SUCCESS

      public static final ErrorMap.ErrorAttribute SUCCESS
      The operation was successful for those situations where the error code is indicating successful (i.e. subdoc operations carried out on a deleted document)

    • ITEM_ONLY

      public static final ErrorMap.ErrorAttribute ITEM_ONLY
      This attribute means that the error is related to a constraint failure regarding the item itself, i.e. the item does not exist, already exists, or its current value makes the current operation impossible. Retrying the operation when the item's value or status has changed may succeed.

    • INVALID_INPUT

      public static final ErrorMap.ErrorAttribute INVALID_INPUT
      This attribute means that a user's input was invalid because it violates the semantics of the operation, or exceeds some predefined limit.

    • FETCH_CONFIG

      public static final ErrorMap.ErrorAttribute FETCH_CONFIG
      The client's cluster map may be outdated and requires updating. The client should obtain a newer configuration.

    • CONN_STATE_INVALIDATED

      public static final ErrorMap.ErrorAttribute CONN_STATE_INVALIDATED
      The current connection is no longer valid. The client must reconnect to the server. Note that the presence of other attributes may indicate an alternate remedy to fixing the connection without a disconnect, but without special remedial action a disconnect is needed.

    • AUTH

      public static final ErrorMap.ErrorAttribute AUTH
      The operation failed because the client failed to authenticate or is not authorized to perform this operation. Note that this error in itself does not mean the connection is invalid, unless conn-state-invalidated is also present.

    • SPECIAL_HANDLING

      public static final ErrorMap.ErrorAttribute SPECIAL_HANDLING
      This error code must be handled specially. If it is not handled, the connection must be dropped.

    • SUPPORT

      public static final ErrorMap.ErrorAttribute SUPPORT
      The operation is not supported, possibly because the of server version, bucket type, or current user.

    • TEMP

      public static final ErrorMap.ErrorAttribute TEMP
      This error is transient. Note that this does not mean the error is retriable.

    • INTERNAL

      public static final ErrorMap.ErrorAttribute INTERNAL
      This is an internal error in the server.

    • RETRY_NOW

      public static final ErrorMap.ErrorAttribute RETRY_NOW
      The operation may be retried immediately.

    • RETRY_LATER

      public static final ErrorMap.ErrorAttribute RETRY_LATER
      The operation may be retried after some time.

    • SUBDOC

      public static final ErrorMap.ErrorAttribute SUBDOC
      The error is related to the subdocument subsystem.

    • DCP

      public static final ErrorMap.ErrorAttribute DCP
      The error is related to the DCP subsystem.

    • AUTO_RETRY

      public static final ErrorMap.ErrorAttribute AUTO_RETRY
      Use retry specifications from the server.

    • ITEM_LOCKED

      public static final ErrorMap.ErrorAttribute ITEM_LOCKED
      This attribute specifies that the requested item is currently locked.

    • ITEM_DELETED

      public static final ErrorMap.ErrorAttribute ITEM_DELETED
      This attribute means that the error is related to operating on a soft-deleted document.

  • Method Details

    • values

      public static ErrorMap.ErrorAttribute[] 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

      public static ErrorMap.ErrorAttribute 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

    • raw

      public String raw()