CouchbaseAsyncCluster (Couchbase Java SDK)

java.lang.Object
- com.couchbase.client.java.CouchbaseAsyncCluster

All Implemented Interfaces:: AsyncCluster

public class CouchbaseAsyncCluster
extends Object
implements AsyncCluster

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_BUCKET

static String DEFAULT_HOST

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_BUCKET`
`static String`	`DEFAULT_HOST`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Observable<AsyncClusterManager>`	`clusterManager(String username, String password)` Provides access to the `AsyncClusterManager` to perform cluster-wide operations.
`Observable<com.couchbase.client.core.ClusterFacade>`	`core()` Returns the underlying “core-io” library through its `ClusterFacade`.
`static CouchbaseAsyncCluster`	`create()`
`static CouchbaseAsyncCluster`	`create(CouchbaseEnvironment environment)`
`static CouchbaseAsyncCluster`	`create(CouchbaseEnvironment environment, List<String> nodes)`
`static CouchbaseAsyncCluster`	`create(CouchbaseEnvironment environment, String... nodes)`
`static CouchbaseAsyncCluster`	`create(List<String> nodes)`
`static CouchbaseAsyncCluster`	`create(String... nodes)`
`Observable<Boolean>`	`disconnect()` Disconnects form all open buckets and shuts down the `CouchbaseEnvironment` if it is the exclusive owner.
`static CouchbaseAsyncCluster`	`fromConnectionString(CouchbaseEnvironment environment, String connectionString)`
`static CouchbaseAsyncCluster`	`fromConnectionString(String connectionString)`
`Observable<AsyncBucket>`	`openBucket()` Opens the default bucket with an empty password.
`Observable<AsyncBucket>`	`openBucket(String name)` Opens the bucket with the given name and an empty password.
`Observable<AsyncBucket>`	`openBucket(String name, String pass)` Opens the bucket with the given name and password.
`Observable<AsyncBucket>`	`openBucket(String name, String pass, List<Transcoder<? extends Document,?>> transcoders)` Opens the bucket with the given name, password and a custom list of `Transcoder`s.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_BUCKET
```
public static final String DEFAULT_BUCKET
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HOST
```
public static final String DEFAULT_HOST
```
    See Also:
    
    Constant Field Values
- Method Detail
  - create
```
public static CouchbaseAsyncCluster create()
```
  - create
```
public static CouchbaseAsyncCluster create(CouchbaseEnvironment environment)
```
  - create
```
public static CouchbaseAsyncCluster create(String... nodes)
```
  - create
```
public static CouchbaseAsyncCluster create(List<String> nodes)
```
  - create
```
public static CouchbaseAsyncCluster create(CouchbaseEnvironment environment,
                                           String... nodes)
```
  - create
```
public static CouchbaseAsyncCluster create(CouchbaseEnvironment environment,
                                           List<String> nodes)
```
  - fromConnectionString
```
public static CouchbaseAsyncCluster fromConnectionString(String connectionString)
```
  - fromConnectionString
```
public static CouchbaseAsyncCluster fromConnectionString(CouchbaseEnvironment environment,
                                                         String connectionString)
```
  - openBucket
```
public Observable<AsyncBucket> openBucket()
```
    Description copied from interface: AsyncCluster
    Opens the default bucket with an empty password.
    The Observable can error under the following conditions:
    - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed).
    - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
    Specified by:
    
    openBucket in interface AsyncCluster
    
    Returns:
    
    the opened bucket if successful.
  - openBucket
```
public Observable<AsyncBucket> openBucket(String name)
```
    Description copied from interface: AsyncCluster
    Opens the bucket with the given name and an empty password.
    The Observable can error under the following conditions:
    - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed).
    - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
    Specified by:
    
    openBucket in interface AsyncCluster
    
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    the opened bucket if successful.
  - openBucket
```
public Observable<AsyncBucket> openBucket(String name,
                                          String pass)
```
    Description copied from interface: AsyncCluster
    Opens the bucket with the given name and password.
    The Observable can error under the following conditions:
    - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed).
    - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
    Specified by:
    
    openBucket in interface AsyncCluster
    
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    the opened bucket if successful.
  - openBucket
```
public Observable<AsyncBucket> openBucket(String name,
                                          String pass,
                                          List<Transcoder<? extends Document,?>> transcoders)
```
    Description copied from interface: AsyncCluster
    Opens the bucket with the given name, password and a custom list of Transcoders.
    The Observable can error under the following conditions:
    - com.couchbase.client.core.CouchbaseException: If the bucket could not be opened (see logs and nested stack trace for more details why it failed).
    - com.couchbase.client.core.BackpressureException: If the incoming request rate is too high to be processed.
    Specified by:
    
    openBucket in interface AsyncCluster
    
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    the opened bucket if successful.
  - disconnect
```
public Observable<Boolean> disconnect()
```
    Description copied from interface: AsyncCluster
    
    Disconnects form all open buckets and shuts down the CouchbaseEnvironment if it is the exclusive owner.
    
    Specified by:
    
    disconnect in interface AsyncCluster
    
    Returns:
    
    true once done and everything succeeded, false otherwise.
  - clusterManager
```
public Observable<AsyncClusterManager> clusterManager(String username,
                                                      String password)
```
    Description copied from interface: AsyncCluster
    
    Provides access to the AsyncClusterManager to perform cluster-wide operations.
    Note that the credentials provided here are different from bucket-level credentials. As a rule of thumb, the “Administrator” credentials need to be passed in here or any credentials with enough permissions to perform the underlying operations. Bucket level credentials will not work.
    
    Specified by:
    
    clusterManager in interface AsyncCluster
    
    Parameters:
    
    username - the username to perform cluster-wide operations.
    
    password - the password associated with the username.
    
    Returns:
    
    the AsyncClusterManager if successful.
  - core
```
public Observable<com.couchbase.client.core.ClusterFacade> core()
```
    Description copied from interface: AsyncCluster
    
    Returns the underlying “core-io” library through its ClusterFacade.
    Handle with care, with great power comes great responsibility. All additional checks which are normally performed by this library are skipped.
    
    Specified by:
    
    core in interface AsyncCluster
    
    Returns:
    
    the underlying ClusterFacade from the “core-io” package.

Class CouchbaseAsyncCluster

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BUCKET

DEFAULT_HOST

Method Detail

create

create

create

create

create

create

fromConnectionString

fromConnectionString

openBucket

openBucket

openBucket

openBucket

disconnect

clusterManager

core