AsyncBucketManager (Couchbase Java SDK)

All Known Implementing Classes:

DefaultAsyncBucketManager
```
@InterfaceStability.Committed
 @InterfaceAudience.Public
public interface AsyncBucketManager
```
Provides management capabilities for a AsyncBucket.
Operations provided on the BucketManager can be used to perform administrative tasks which require bucket-level credentials like managing DesignDocuments or flushing a Bucket.

Since:

2.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Observable<Boolean>`	`flush()` Flushes the bucket (removes all data).
`Observable<DesignDocument>`	`getDesignDocument(String name)` Loads a published `DesignDocument` by its name.
`Observable<DesignDocument>`	`getDesignDocument(String name, boolean development)` Loads a `DesignDocument` by its name from either development or production.
`Observable<DesignDocument>`	`getDesignDocuments()` Loads all published `DesignDocument`s.
`Observable<DesignDocument>`	`getDesignDocuments(boolean development)` Loads all `DesignDocument`s from development or production.
`Observable<BucketInfo>`	`info()` Returns information about the connected bucket.
`Observable<DesignDocument>`	`insertDesignDocument(DesignDocument designDocument)` Inserts a `DesignDocument` into production if it does not exist.
`Observable<DesignDocument>`	`insertDesignDocument(DesignDocument designDocument, boolean development)` Inserts a `DesignDocument` into development or production if it does not exist.
`Observable<DesignDocument>`	`publishDesignDocument(String name)` Publishes a `DesignDocument` from development into production.
`Observable<DesignDocument>`	`publishDesignDocument(String name, boolean overwrite)` Publishes a `DesignDocument` from development into production.
`Observable<Boolean>`	`removeDesignDocument(String name)` Removes a `DesignDocument` from production by its name.
`Observable<Boolean>`	`removeDesignDocument(String name, boolean development)` Removes a `DesignDocument` from production or development by its name.
`Observable<DesignDocument>`	`upsertDesignDocument(DesignDocument designDocument)` Upserts (inserts or replaces) a `DesignDocument` into production.
`Observable<DesignDocument>`	`upsertDesignDocument(DesignDocument designDocument, boolean development)` Upserts (inserts or replaces) a `DesignDocument` into production or development.

- Method Detail
  - info
```
Observable<BucketInfo> info()
```
    Returns information about the connected bucket.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Returns:
    
    bucket information wrapped in a BucketInfo.
  - flush
```
Observable<Boolean> flush()
```
    Flushes the bucket (removes all data).
    Note that flush needs to be enabled on the bucket, otherwise an exception will be raised.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.FlushDisabledException: If flush is disabled.
    - com.couchbase.client.core.CouchbaseException: If the server response could not be parsed.
    Returns:
    
    true if the bucket was flushed, an failed Observable otherwise.
  - getDesignDocuments
```
Observable<DesignDocument> getDesignDocuments()
```
    Loads all published DesignDocuments.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    Returns:
    
    zero to N invocations containing published DesignDocuments.
  - getDesignDocuments
```
Observable<DesignDocument> getDesignDocuments(boolean development)
```
    Loads all DesignDocuments from development or production.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    Parameters:
    
    development - if the DesignDocuments should be loaded from development or production.
    
    Returns:
    
    zero to N invocations containing published DesignDocuments.
  - getDesignDocument
```
Observable<DesignDocument> getDesignDocument(String name)
```
    Loads a published DesignDocument by its name.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    Parameters:
    
    name - the name of the DesignDocument.
    
    Returns:
    
    and empty observable if the document not found or a DesignDocument.
  - getDesignDocument
```
Observable<DesignDocument> getDesignDocument(String name,
                                             boolean development)
```
    Loads a DesignDocument by its name from either development or production.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    Parameters:
    
    name - the name of the DesignDocument.
    
    development - if it should be loaded from development or production.
    
    Returns:
    
    and empty observable if the document not found or a DesignDocument.
  - insertDesignDocument
```
Observable<DesignDocument> insertDesignDocument(DesignDocument designDocument)
```
    Inserts a DesignDocument into production if it does not exist.
    Note that inserting a DesignDocument is not an atomic operation, but instead internally performs a getDesignDocument(String) operation first. While expected to be very uncommon, a race condition may happen if two users at the same time perform this operation with the same DesignDocument.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    - com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument exists.
    Parameters:
    
    designDocument - the DesignDocument to insert.
    
    Returns:
    
    the inserted DesignDocument on success.
  - insertDesignDocument
```
Observable<DesignDocument> insertDesignDocument(DesignDocument designDocument,
                                                boolean development)
```
    Inserts a DesignDocument into development or production if it does not exist.
    Note that inserting a DesignDocument is not an atomic operation, but instead internally performs a getDesignDocument(String) operation first. While expected to be very uncommon, a race condition may happen if two users at the same time perform this operation with the same DesignDocument.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    - com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument exists.
    Parameters:
    
    designDocument - the DesignDocument to insert.
    
    development - if it should be inserted into development or production (published).
    
    Returns:
    
    the inserted DesignDocument on success.
  - upsertDesignDocument
```
Observable<DesignDocument> upsertDesignDocument(DesignDocument designDocument)
```
    Upserts (inserts or replaces) a DesignDocument into production.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    Parameters:
    
    designDocument - the DesignDocument to upsert.
    
    Returns:
    
    the upserted DesignDocument on success.
  - upsertDesignDocument
```
Observable<DesignDocument> upsertDesignDocument(DesignDocument designDocument,
                                                boolean development)
```
    Upserts (inserts or replaces) a DesignDocument into production or development.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    Parameters:
    
    designDocument - the DesignDocument to upsert.
    
    development - if the DesignDocument should be upserted into development or production.
    
    Returns:
    
    the upserted DesignDocument on success.
  - removeDesignDocument
```
Observable<Boolean> removeDesignDocument(String name)
```
    Removes a DesignDocument from production by its name.
    
    Parameters:
    
    name - the name of the DesignDocument.
    
    Returns:
    
    true if succeeded, false otherwise.
  - removeDesignDocument
```
Observable<Boolean> removeDesignDocument(String name,
                                         boolean development)
```
    Removes a DesignDocument from production or development by its name.
    
    Parameters:
    
    name - the name of the DesignDocument.
    
    development - if the DesignDocument should be removed from development or production.
    
    Returns:
    
    true if succeeded, false otherwise.
  - publishDesignDocument
```
Observable<DesignDocument> publishDesignDocument(String name)
```
    Publishes a DesignDocument from development into production.
    Note that this method does not override a already existing DesignDocument (see publishDesignDocument(String, boolean)) as an alternative.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument already exists.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    Parameters:
    
    name - the name of the DesignDocument to publish.
    
    Returns:
    
    the published DesignDocument on success.
  - publishDesignDocument
```
Observable<DesignDocument> publishDesignDocument(String name,
                                                 boolean overwrite)
```
    Publishes a DesignDocument from development into production.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument already exists and override is set to false.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    Parameters:
    
    name - the name of the DesignDocument to publish.
    
    overwrite - if an existing DesignDocument should be overridden.
    
    Returns:
    
    the published DesignDocument on success.

Interface AsyncBucketManager

Method Summary

Method Detail

info

flush

getDesignDocuments

getDesignDocuments

getDesignDocument

getDesignDocument

insertDesignDocument

insertDesignDocument

upsertDesignDocument

upsertDesignDocument

removeDesignDocument

removeDesignDocument

publishDesignDocument

publishDesignDocument