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>
- 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
-
-
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
All Methods Static Methods Instance Methods Concrete Methods 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.
-
-
-
Enum Constant Detail
-
ACTIVE
public static final Observe.ObservePersistTo ACTIVE
Observe disk persistence to the active node of the document only.
-
NONE
public static final Observe.ObservePersistTo NONE
Do not observe any disk persistence constraint.
-
ONE
public static final Observe.ObservePersistTo ONE
Observe disk persistence of one node (active or replica).
-
TWO
public static final Observe.ObservePersistTo TWO
Observe disk persistence of two nodes (active or replica).
-
THREE
public static final Observe.ObservePersistTo THREE
Observe disk persistence of three nodes (active or replica).
-
FOUR
public static final Observe.ObservePersistTo FOUR
Observe disk persistence of four nodes (one active and three replicas).
-
-
Method Detail
-
values
public static Observe.ObservePersistTo[] 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 (Observe.ObservePersistTo c : Observe.ObservePersistTo.values()) System.out.println(c);
- 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 nameNullPointerException
- 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.
-
-