Package com.couchbase.client.java

Enum PersistTo

java.lang.Object
java.lang.Enum<PersistTo>
com.couchbase.client.java.PersistTo
All Implemented Interfaces:
Serializable, Comparable<PersistTo>, java.lang.constant.Constable
public enum PersistTo
extends Enum<PersistTo>
Defines the possible disk persistence constraints to observe.
Since:
2.0
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
    FOUR
    Observe disk persistence of four nodes (one master and three replicas).
    MASTER
    Observe disk persistence to the master node of the document only.
    NONE
    Do not observe any disk persistence constraint.
    ONE
    Observe disk persistence of one node (master or replica).
    THREE
    Observe disk persistence of three nodes (master or replica).
    TWO
    Observe disk persistence of two nodes (master or replica).

  • Method Summary

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

    • MASTER

      public static final PersistTo MASTER
      Observe disk persistence to the master node of the document only.

    • NONE

      public static final PersistTo NONE
      Do not observe any disk persistence constraint.

    • ONE

      public static final PersistTo ONE
      Observe disk persistence of one node (master or replica).

    • TWO

      public static final PersistTo TWO
      Observe disk persistence of two nodes (master or replica).

    • THREE

      public static final PersistTo THREE
      Observe disk persistence of three nodes (master or replica).

    • FOUR

      public static final PersistTo FOUR
      Observe disk persistence of four nodes (one master and three replicas).

  • Method Details

    • values

      public static PersistTo[] 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 PersistTo 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 Observe.PersistTo 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 master.
      Returns:
      true if it includes a replica, false if not.