DefaultAsyncClusterManager (Couchbase Java SDK)

java.lang.Object
- com.couchbase.client.java.cluster.DefaultAsyncClusterManager

All Implemented Interfaces:: AsyncClusterManager

public class DefaultAsyncClusterManager
extends Object
implements AsyncClusterManager

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Observable<AsyncClusterApiClient>`	`apiClient()`
`static DefaultAsyncClusterManager`	`create(String username, String password, ConnectionString connectionString, CouchbaseEnvironment environment, ClusterFacade core)`
`Observable<BucketSettings>`	`getBucket(String name)` Returns the `BucketSettings` for the `Bucket` identified by name.
`Observable<BucketSettings>`	`getBuckets()` Returns `BucketSettings` for all available `Bucket`s.
`protected String`	`getConfigureBucketPayload(BucketSettings settings, boolean includeName)`
`Observable<Boolean>`	`hasBucket(String name)` Checks if the cluster has a `Bucket` identified by the given name.
`Observable<ClusterInfo>`	`info()` Provides information about the cluster.
`Observable<BucketSettings>`	`insertBucket(BucketSettings settings)` Inserts a `Bucket` with its `BucketSettings` if it does not already exist.
`Observable<Boolean>`	`removeBucket(String name)` Removes a `Bucket` identified by its name.
`Observable<BucketSettings>`	`updateBucket(BucketSettings settings)` Updates a `Bucket` with its `BucketSettings` if it does already exist.

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

- Method Detail
  - create
```
public static DefaultAsyncClusterManager create(String username,
                                                String password,
                                                ConnectionString connectionString,
                                                CouchbaseEnvironment environment,
                                                ClusterFacade core)
```
  - apiClient
```
@InterfaceStability.Experimental
public Observable<AsyncClusterApiClient> apiClient()
```
    Specified by:
    
    apiClient in interface AsyncClusterManager
    
    Returns:
    
    an Observable emitting a single new AsyncClusterApiClient to prepare and perform REST API asynchronous requests on this cluster.
  - info
```
public Observable<ClusterInfo> info()
```
    Description copied from interface: AsyncClusterManager
    Provides information about the cluster.
    The Observable can error under the following conditions:
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Specified by:
    
    info in interface AsyncClusterManager
    
    Returns:
    
    cluster information wrapped into a ClusterInfo object.
  - getBuckets
```
public Observable<BucketSettings> getBuckets()
```
    Description copied from interface: AsyncClusterManager
    Returns BucketSettings for all available Buckets.
    The Observable can error under the following conditions:
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Specified by:
    
    getBuckets in interface AsyncClusterManager
    
    Returns:
    
    zero to N BucketSettings.
  - getBucket
```
public Observable<BucketSettings> getBucket(String name)
```
    Description copied from interface: AsyncClusterManager
    Returns the BucketSettings for the Bucket identified by name.
    The Observable can error under the following conditions:
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Specified by:
    
    getBucket in interface AsyncClusterManager
    
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    the BucketSettings if found or an empty observable if not found.
  - hasBucket
```
public Observable<Boolean> hasBucket(String name)
```
    Description copied from interface: AsyncClusterManager
    Checks if the cluster has a Bucket identified by the given name.
    The Observable can error under the following conditions:
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Specified by:
    
    hasBucket in interface AsyncClusterManager
    
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    true if it was found, false otherwise.
  - removeBucket
```
public Observable<Boolean> removeBucket(String name)
```
    Description copied from interface: AsyncClusterManager
    Removes a Bucket identified by its name.
    The Observable can error under the following conditions:
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Note: Removing a Bucket is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
    Specified by:
    
    removeBucket in interface AsyncClusterManager
    
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - insertBucket
```
public Observable<BucketSettings> insertBucket(BucketSettings settings)
```
    Description copied from interface: AsyncClusterManager
    Inserts a Bucket with its BucketSettings if it does not already exist.
    The Observable can error under the following conditions:
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    - com.couchbase.client.java.error.BucketAlreadyExistsException: If the bucket already exists.
    Note: Inserting a Bucket is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
    Specified by:
    
    insertBucket in interface AsyncClusterManager
    
    Parameters:
    
    settings - the bucket settings that should be applied.
    
    Returns:
    
    the stored bucket settings if succeeded.
  - updateBucket
```
public Observable<BucketSettings> updateBucket(BucketSettings settings)
```
    Description copied from interface: AsyncClusterManager
    Updates a Bucket with its BucketSettings if it does already exist.
    The Observable can error under the following conditions:
    - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    - com.couchbase.client.java.error.BucketDoesNotExistException: If the bucket does not exist.
    Note: Updating a Bucket is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
    Specified by:
    
    updateBucket in interface AsyncClusterManager
    
    Parameters:
    
    settings - the bucket settings that should be applied.
    
    Returns:
    
    the updated bucket settings if succeeded.
  - getConfigureBucketPayload
```
protected String getConfigureBucketPayload(BucketSettings settings,
                                           boolean includeName)
```

Class DefaultAsyncClusterManager

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

apiClient

info

getBuckets

getBucket

hasBucket

removeBucket

insertBucket

updateBucket

getConfigureBucketPayload