AsyncClusterManager (Couchbase Java SDK)

All Known Implementing Classes:

DefaultAsyncClusterManager
```
@InterfaceStability.Committed
 @InterfaceAudience.Public
public interface AsyncClusterManager
```
Provides management capabilities for a Couchbase Server Cluster.

Since:

2.0

Author:

Michael Nitschinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Observable<AsyncClusterApiClient>`	`apiClient()`
`Observable<BucketSettings>`	`getBucket(String name)` Returns the `BucketSettings` for the `Bucket` identified by name.
`Observable<BucketSettings>`	`getBuckets()` Returns `BucketSettings` for all available `Bucket`s.
`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.

- Method Detail
  - info
```
Observable<ClusterInfo> info()
```
    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.
    Returns:
    
    cluster information wrapped into a ClusterInfo object.
  - getBuckets
```
Observable<BucketSettings> getBuckets()
```
    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.
    Returns:
    
    zero to N BucketSettings.
  - getBucket
```
Observable<BucketSettings> getBucket(String name)
```
    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.
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    the BucketSettings if found or an empty observable if not found.
  - hasBucket
```
Observable<Boolean> hasBucket(String name)
```
    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.
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    true if it was found, false otherwise.
  - insertBucket
```
Observable<BucketSettings> insertBucket(BucketSettings settings)
```
    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.
    Parameters:
    
    settings - the bucket settings that should be applied.
    
    Returns:
    
    the stored bucket settings if succeeded.
  - updateBucket
```
Observable<BucketSettings> updateBucket(BucketSettings settings)
```
    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.
    Parameters:
    
    settings - the bucket settings that should be applied.
    
    Returns:
    
    the updated bucket settings if succeeded.
  - removeBucket
```
Observable<Boolean> removeBucket(String name)
```
    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.
    Parameters:
    
    name - the name of the bucket.
    
    Returns:
    
    true if the removal was successful, false otherwise.
  - apiClient
```
@InterfaceStability.Experimental
Observable<AsyncClusterApiClient> apiClient()
```
    Returns:
    
    an Observable emitting a single new AsyncClusterApiClient to prepare and perform REST API asynchronous requests on this cluster.

Interface AsyncClusterManager

Method Summary

Method Detail

info

getBuckets

getBucket

hasBucket

insertBucket

updateBucket

removeBucket

apiClient