Package com.couchbase.client.dcp.core.service

Enum Class ServiceScope

java.lang.Object

java.lang.Enum<ServiceScope>

com.couchbase.client.dcp.core.service.ServiceScope

All Implemented Interfaces:

Serializable, Comparable<ServiceScope>, java.lang.constant.Constable

public enum ServiceScope
extends Enum<ServiceScope>

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
BUCKET	The service can only handle one bucket at a time.
CLUSTER	The service is able to handle all buckets at the same time.

Method Summary

Modifier and Type	Method	Description
static ServiceScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ServiceScope[]	values()	Returns an array containing the constants of this enum class, 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

CLUSTER

public static final ServiceScope CLUSTER

The service is able to handle all buckets at the same time.

This is true for all services where their authentication mechanism is not bound to the connection, but rather to the request object itself.

BUCKET

public static final ServiceScope BUCKET

The service can only handle one bucket at a time.

This is true for all services which have their authentication mechanism bound at connection time, allowing a service not to be reused across buckets.

Method Details

values

public static ServiceScope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ServiceScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null