com.couchbase.client.java

Class ClusterOptions

java.lang.Object

com.couchbase.client.java.ClusterOptions

public class ClusterOptions
extends Object

Allows specifying custom options when connecting to the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ClusterOptions.Built

Method Summary

Modifier and Type	Method and Description
ClusterOptions.Built	build()
static ClusterOptions	clusterOptions(com.couchbase.client.core.env.Authenticator authenticator)
static ClusterOptions	clusterOptions(String username, String password)
ClusterOptions	environment(ClusterEnvironment environment) Sets the ClusterEnvironment to use with this cluster.
ClusterOptions	environment(Consumer<ClusterEnvironment.Builder> environmentCustomizer) Sets a callback that configures the ClusterEnvironment owned by this cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

clusterOptions

public static ClusterOptions clusterOptions(com.couchbase.client.core.env.Authenticator authenticator)

clusterOptions

public static ClusterOptions clusterOptions(String username,
                                            String password)

environment

public ClusterOptions environment(ClusterEnvironment environment)

Sets the ClusterEnvironment to use with this cluster.

The caller is responsible for shutting down the environment after all clusters sharing it have disconnected.

Use this method when sharing an environment between multiple clusters. In all other cases, prefer environment(Consumer).

environment

@Stability.Uncommitted
public ClusterOptions environment(Consumer<ClusterEnvironment.Builder> environmentCustomizer)

Sets a callback that configures the ClusterEnvironment owned by this cluster.

The cluster will manage the lifecycle of the environment, and automatically shut it down when the cluster is disconnected.

This is the recommended way to configure the cluster environment unless you need to share an environment between multiple clusters.

build

@Stability.Internal
public ClusterOptions.Built build()