Package com.couchbase.client.core.service.kv

Enum Observe.ObservePersistTo

java.lang.Object
java.lang.Enum<Observe.ObservePersistTo>
com.couchbase.client.core.service.kv.Observe.ObservePersistTo
All Implemented Interfaces:
Serializable, Comparable<Observe.ObservePersistTo>, java.lang.constant.Constable
Enclosing class:
Observe
public static enum Observe.ObservePersistTo extends Enum<Observe.ObservePersistTo>
Defines the possible disk persistence constraints to observe.
Since:
1.0.1
Author:
Michael Nitschinger

  • 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
    ACTIVE
    Observe disk persistence to the active node of the document only.
    FOUR
    Observe disk persistence of four nodes (one active and three replicas).
    NONE
    Do not observe any disk persistence constraint.
    ONE
    Observe disk persistence of one node (active or replica).
    THREE
    Observe disk persistence of three nodes (active or replica).
    TWO
    Observe disk persistence of two nodes (active or replica).

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    touchesReplica()
    Identifies if this enum property will touch a replica or just the active.
    short
    value()
    Returns the actual internal persistence representation for the enum.
    static Observe.ObservePersistTo
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static Observe.ObservePersistTo[]
    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, 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

  • Method Details

    • values

      public static Observe.ObservePersistTo[] 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 Observe.ObservePersistTo 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

    • value

      public short value()
      Returns the actual internal persistence representation for the enum.
      Returns:
      the internal persistence representation.

    • touchesReplica

      public boolean touchesReplica()
      Identifies if this enum property will touch a replica or just the active.
      Returns:
      true if it includes a replica, false if not.