com.couchbase.client.core.diagnostics

Enum ClusterState

java.lang.Object

java.lang.Enum<ClusterState>

com.couchbase.client.core.diagnostics.ClusterState

All Implemented Interfaces:

Serializable, Comparable<ClusterState>

public enum ClusterState
extends Enum<ClusterState>

Describes the cluster state from the clients perspective in a simplified and aggregated state.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEGRADED At least one endpoint is connected.
OFFLINE No endpoint is connected.
ONLINE All endpoints are connected.

Method Summary

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

ONLINE

public static final ClusterState ONLINE

All endpoints are connected.

DEGRADED

public static final ClusterState DEGRADED

At least one endpoint is connected.

OFFLINE

public static final ClusterState OFFLINE

No endpoint is connected.

Method Detail

values

public static ClusterState[] 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 (ClusterState c : ClusterState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClusterState 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